fix(generator): support explicit directory option and use in packagejson/README templates#8897
Conversation
…json/README templates
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a new directory option to allow specifying a custom monorepo directory for the generated TypeScript package, updating the generator logic, schema, and templates (CJS and ESM package.json and README files) to use this directory if provided. The reviewer suggests renaming this option and its associated properties to package-dir / packageDir across all files to avoid confusion with the output directory and to maintain consistency with existing options like package-name.
| .alias('directory', 'package_dir') | ||
| .describe('directory', 'Monorepo directory of the package (e.g. packages/google-cloud-workflows)') |
There was a problem hiding this comment.
Using --directory as a CLI option name is highly generic and can easily be confused with the output directory where the generated code is written. To avoid confusion and maintain consistency with --package-name, it is recommended to name this option --package-dir.
| .alias('directory', 'package_dir') | |
| .describe('directory', 'Monorepo directory of the package (e.g. packages/google-cloud-workflows)') | |
| .alias('package-dir', 'package_dir') | |
| .describe('package-dir', 'Monorepo directory of the package (e.g. packages/google-cloud-workflows)') |
| const bundleConfig = argv.bundleConfig as string | undefined; | ||
| const serviceYaml = argv.serviceYaml as string | undefined; | ||
| const packageName = argv.packageName as string | undefined; | ||
| const directory = argv.directory as string | undefined; |
There was a problem hiding this comment.
Retrieve the option as packageDir to match the renamed --package-dir CLI option.
| const directory = argv.directory as string | undefined; | |
| const packageDir = argv.packageDir as string | undefined; |
| if (directory) { | ||
| protocCommand.push(`--typescript_gapic_opt="directory=${directory}"`); | ||
| } |
There was a problem hiding this comment.
Pass the option as package-dir to the protoc plugin to match the renamed option.
| if (directory) { | |
| protocCommand.push(`--typescript_gapic_opt="directory=${directory}"`); | |
| } | |
| if (packageDir) { | |
| protocCommand.push(`--typescript_gapic_opt="package-dir=${packageDir}"`); | |
| } |
| paramMap: OptionsMap; | ||
| // This field is for users passing proper publish package name like @google-cloud/text-to-speech. | ||
| publishName?: string; | ||
| directory?: string; |
There was a problem hiding this comment.
Rename the property to packageDir to be more descriptive and consistent with the renamed option.
packageDir?: string;|
|
||
| private readPublishPackageName() { | ||
| this.publishName = this.paramMap['package-name']; | ||
| this.directory = this.paramMap['directory']; |
There was a problem hiding this comment.
Read the renamed package-dir option from paramMap.
this.packageDir = this.paramMap['package-dir'];| }, | ||
| "license": "Apache-2.0", | ||
| "homepage": "https://github.com/googleapis/google-cloud-node/tree/main/packages/{{ api.naming.namePath }}", | ||
| "homepage": "https://github.com/googleapis/google-cloud-node/tree/main/{{ api.directory or ('packages/' + api.naming.namePath) }}", |
There was a problem hiding this comment.
Use api.packageDir instead of api.directory to match the renamed property.
| "homepage": "https://github.com/googleapis/google-cloud-node/tree/main/{{ api.directory or ('packages/' + api.naming.namePath) }}", | |
| "homepage": "https://github.com/googleapis/google-cloud-node/tree/main/{{ api.packageDir or ('packages/' + api.naming.namePath) }}", |
| "repository": { | ||
| "type": "git", | ||
| "directory": "packages/{{ api.naming.namePath }}", | ||
| "directory": "{{ api.directory or ('packages/' + api.naming.namePath) }}", |
There was a problem hiding this comment.
Use api.packageDir instead of api.directory to match the renamed property.
| "directory": "{{ api.directory or ('packages/' + api.naming.namePath) }}", | |
| "directory": "{{ api.packageDir or ('packages/' + api.naming.namePath) }}", |
| }, | ||
| "license": "Apache-2.0", | ||
| "homepage": "https://github.com/googleapis/google-cloud-node/tree/main/packages/{{ api.naming.namePath }}", | ||
| "homepage": "https://github.com/googleapis/google-cloud-node/tree/main/{{ api.directory or ('packages/' + api.naming.namePath) }}", |
There was a problem hiding this comment.
Use api.packageDir instead of api.directory to match the renamed property.
| "homepage": "https://github.com/googleapis/google-cloud-node/tree/main/{{ api.directory or ('packages/' + api.naming.namePath) }}", | |
| "homepage": "https://github.com/googleapis/google-cloud-node/tree/main/{{ api.packageDir or ('packages/' + api.naming.namePath) }}", |
| [homepage_samples]: https://github.com/googleapis/google-cloud-node/blob/main/{{ api.directory or ('packages/' + api.naming.namePath) }}/samples | ||
| [homepage_changelog]: https://github.com/googleapis/google-cloud-node/blob/main/{{ api.directory or ('packages/' + api.naming.namePath) }}/CHANGELOG.md | ||
| [homepage]: https://github.com/googleapis/google-cloud-node/blob/main/{{ api.directory or ('packages/' + api.naming.namePath) }} |
There was a problem hiding this comment.
Use api.packageDir instead of api.directory to match the renamed property.
[homepage_samples]: https://github.com/googleapis/google-cloud-node/blob/main/{{ api.packageDir or ('packages/' + api.naming.namePath) }}/samples
[homepage_changelog]: https://github.com/googleapis/google-cloud-node/blob/main/{{ api.packageDir or ('packages/' + api.naming.namePath) }}/CHANGELOG.md
[homepage]: https://github.com/googleapis/google-cloud-node/blob/main/{{ api.packageDir or ('packages/' + api.naming.namePath) }}
| [homepage_samples]: https://github.com/googleapis/google-cloud-node/blob/main/{{ api.directory or ('packages/' + api.naming.namePath) }}/samples | ||
| [homepage_changelog]: https://github.com/googleapis/google-cloud-node/blob/main/{{ api.directory or ('packages/' + api.naming.namePath) }}/CHANGELOG.md | ||
| [homepage]: https://github.com/googleapis/google-cloud-node/blob/main/{{ api.directory or ('packages/' + api.naming.namePath) }} |
There was a problem hiding this comment.
Use api.packageDir instead of api.directory to match the renamed property.
[homepage_samples]: https://github.com/googleapis/google-cloud-node/blob/main/{{ api.packageDir or ('packages/' + api.naming.namePath) }}/samples
[homepage_changelog]: https://github.com/googleapis/google-cloud-node/blob/main/{{ api.packageDir or ('packages/' + api.naming.namePath) }}/CHANGELOG.md
[homepage]: https://github.com/googleapis/google-cloud-node/blob/main/{{ api.packageDir or ('packages/' + api.naming.namePath) }}
1 participant
No description provided.