-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
13 changed files
with
404 additions
and
208 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,162 +1,6 @@ | ||
| import {Options, generate} from './index' | ||
| import * as cli from '@rushstack/ts-command-line' | ||
| import * as lodash from 'lodash' | ||
| import * as path from 'path' | ||
| import {createCli} from 'trpc-cli' | ||
| import {router} from './router' | ||
|
|
||
| import * as defaults from './defaults' | ||
| import {tryOrDefault} from './util' | ||
| const cli = createCli({router}) | ||
|
|
||
| export class TypegenCLI extends cli.CommandLineParser { | ||
| constructor() { | ||
| super({ | ||
| toolFilename: 'pg-typegen', | ||
| toolDescription: `CLI for https://npmjs.com/package/@pgkit/typegen.`, | ||
| }) | ||
|
|
||
| this.addAction(new GenerateAction()) | ||
| } | ||
|
|
||
| onDefineParameters() {} | ||
| } | ||
|
|
||
| export class GenerateAction extends cli.CommandLineAction { | ||
| private _params!: ReturnType<typeof GenerateAction._defineParameters> | ||
|
|
||
| constructor() { | ||
| super({ | ||
| actionName: 'generate', | ||
| summary: `Scans source files for SQL queries and generates TypeScript interfaces for them.`, | ||
| documentation: ` | ||
| Generates a directory containing with a 'sql' tag wrapper based on found queries found in source files. | ||
| By default, searches 'src' for source files. | ||
| `, | ||
| }) | ||
| } | ||
|
|
||
| private static _defineParameters(action: cli.CommandLineAction) { | ||
| return { | ||
| config: action.defineStringParameter({ | ||
| parameterLongName: '--config', | ||
| argumentName: 'PATH', | ||
| description: ` | ||
| Path to a module containing parameters to be passed to 'generate'. If specified, it will be required | ||
| and the export will be used as parameters. If not specified, defaults will be used. | ||
| Note: other CLI arguments will override values set in this module | ||
| `, | ||
| }), | ||
| rootDir: action.defineStringParameter({ | ||
| parameterLongName: '--root-dir', | ||
| argumentName: 'PATH', | ||
| description: `Path to the source directory containing SQL queries. Defaults to "src" if no value is provided`, | ||
| }), | ||
| connectionString: action.defineStringParameter({ | ||
| parameterLongName: '--connection-string', | ||
| argumentName: 'URL', | ||
| description: `URL for connecting to postgres. Defaults to 'postgresql://postgres:postgres@localhost:5432/postgres'`, | ||
| }), | ||
| psql: action.defineStringParameter({ | ||
| parameterLongName: '--psql', | ||
| argumentName: 'COMMAND', | ||
| description: ` | ||
| psql command used to query postgres via CLI client. e.g. | ||
| 'psql -h localhost -U postgres postgres' if running postgres locally, or | ||
| 'docker-compose exec -T postgres psql -h localhost -U postgres postgres' if running with docker-compose. | ||
| You can test this by running "<<your_psql_command>> -c 'select 1 as a, 2 as b'". Note that this command will | ||
| be executed dynamically, so avoid using any escape characters in here. | ||
| `, | ||
| }), | ||
| defaultType: action.defineStringParameter({ | ||
| parameterLongName: '--default-type', | ||
| argumentName: 'TYPESCRIPT', | ||
| description: ` | ||
| TypeScript fallback type for when no type is found. Most simple types (text, int etc.) | ||
| are mapped to their TypeScript equivalent automatically. This should usually be 'unknown', | ||
| or 'any' if you like to live dangerously. | ||
| `, | ||
| }), | ||
| include: action.defineStringListParameter({ | ||
| parameterLongName: '--include', | ||
| argumentName: 'PATTERN', | ||
| description: ` | ||
| Glob pattern of files to search for SQL queries in. | ||
| By default searches for all .ts and .sql files: '**/*.{ts,sql}' | ||
| This option is repeatable to include multiple patterns. | ||
| `, | ||
| }), | ||
| exclude: action.defineStringListParameter({ | ||
| parameterLongName: '--exclude', | ||
| argumentName: 'PATTERN', | ||
| description: ` | ||
| Glob pattern for files to be excluded from processing. | ||
| By default excludes '**/node_modules/**'. | ||
| This option is repeatable to exlude multiple patterns. | ||
| `, | ||
| }), | ||
| since: action.defineStringParameter({ | ||
| parameterLongName: '--since', | ||
| argumentName: 'REF', | ||
| description: ` | ||
| Limit affected files to those which have been changed since the given git ref. | ||
| Use "--since HEAD" for files changed since the last commit, "--since main for files changed in a branch, etc. | ||
| This option has no effect in watch mode. | ||
| `, | ||
| }), | ||
| migrate: action.defineChoiceParameter({ | ||
| parameterLongName: '--migrate', | ||
| alternatives: ['<=0.8.0'], | ||
| description: `Before generating types, attempt to migrate a codebase which has used a prior version of this tool`, | ||
| }), | ||
| skipCheckClean: action.defineFlagParameter({ | ||
| parameterLongName: '--skip-check-clean', | ||
| description: `If enabled, the tool will not check the git status to ensure changes are checked in.`, | ||
| }), | ||
| watch: action.defineFlagParameter({ | ||
| parameterLongName: '--watch', | ||
| description: `Run the type checker in watch mode. Files will be run through the code generator when changed or added.`, | ||
| }), | ||
| lazy: action.defineFlagParameter({ | ||
| parameterLongName: '--lazy', | ||
| description: `Skip initial processing of input files. Only useful with '--watch'.`, | ||
| }), | ||
| } | ||
| } | ||
|
|
||
| onDefineParameters(): void { | ||
| this._params = GenerateAction._defineParameters(this) | ||
| } | ||
|
|
||
| async onExecute() { | ||
| // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment | ||
| const optionsModule = this._params.config.value | ||
| ? await import(path.resolve(process.cwd(), this._params.config.value)) | ||
| : tryOrDefault(async () => import(path.resolve(process.cwd(), defaults.typegenConfigFile)), null) | ||
|
|
||
| // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment | ||
| const options: {} = optionsModule?.default || optionsModule | ||
|
|
||
| const run = await generate( | ||
| lodash.merge({}, options, { | ||
| rootDir: this._params.rootDir.value, | ||
| connectionString: this._params.connectionString.value, | ||
| psqlCommand: this._params.psql.value, | ||
| defaultType: this._params.defaultType.value, | ||
| include: this._params.include.values.length > 0 ? this._params.include.values : undefined, | ||
| exclude: this._params.exclude.values.length > 0 ? this._params.exclude.values : undefined, | ||
| since: this._params.since.value, | ||
| migrate: this._params.migrate.value as Options['migrate'], | ||
| checkClean: this._params.skipCheckClean.value ? ['none'] : undefined, | ||
| lazy: this._params.lazy.value, | ||
| } as Partial<Options>), | ||
| ) | ||
|
|
||
| if (this._params.watch.value) { | ||
| run.watch() | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /* istanbul ignore if */ | ||
| if (require.main === module) { | ||
| const program = new TypegenCLI() | ||
| void program.execute() | ||
| } | ||
| void cli.run() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| export * from './generate' | ||
| export * from './router' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.