feat: document case naming generate option #2886
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This is the third of a multi PR effort aiming at supporting custom name casing conventions, as detailed here.
@nestjs/schematics
to accept acaseType
option when generating a new file.caseNaming
field toGenerateOptions
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Currently
@nestjs/cli
useskebab-case
, as mentioned in this issue.Issue Number: 462
What is the new behavior?
The goal is to add a
caseNaming
option to theGenerateOptions
CLI config so that generated files will follow the desired name casing convention.Does this PR introduce a breaking change?
Other informations
How to run
@nestjs/schematics
Clone this branch, and do:
Install the updated
@nestjs/schematics
packageCopy the
dist
folder in@nestjs/nest-cli
deps:nest-cli/node_modules/@nestjs/schematics/dist/
Run it with one of those commands:
node bin/nest.js new test-nest -s --caseNaming=camel
to generate a customnest-cli.json
node bin/nest.js g co keb-pap
in a folder with the correctnest-cli.json