New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document nest new --strict
and propose its usage in docs
#2368
Comments
We could add info blockquotes informing about the Would you like to create a PR for this? |
I've grepped a bit and found these usages of info blockquotes:
(notice how there's a bit of inconsistency because some of those usages mix casing, those could maybe be cleaned up) Which kind do you think would be more appropriate for this? On the other hand, I've searched actual usages of And optionally, maybe not so much needed at this point, but still definitively an usage of My feeling is that docs could probably benefit from a small restructuring, where there is a single point explaining how to make a new project, and all the other places just refer back to it. To that extent, "Introduction" and "First steps" are kinda overlapping, and feels like if the introduction should just stop after the "Philosophy" section and then send users to the "First steps", where the appropriate creation flags could be pointed out. |
If we add this hint there: we should be fine.
"> info Hint" sounds reasonable.
We currently have no plans to make any changes to the structure of the Overview & First steps & Introduction pages. |
Ok thanks for the guidance. Note that I'll be out for the following days, so I will be able to make a PR on Wednesday next week. Cheers. |
I'm submitting a...
Current behavior
Several issues:
--strict
flag onnest new --strict
was added in nestjs/nest-cli#1344 but this wasn't accompanied with a corresponding update of the docs.nest new project-name
, without mentioning the possibility of using--strict
, which is actually a very desirable thing to do for most new projects for devs that care about proper type safety. As a consequence, the possibility of--strict
is lost even for seasoned TypeScript programmers who are new to NestJS.Expected behavior
--strict
flag on the command reference page: CLI / Usage / nest new.nest new --strict project-name
in introductory pages: Introduction / Installation and Overview / First steps / Setup. Possibly adding a note, stating that for devs who are new to TypeScript, they might want to ease their learning curve by skipping the--strict
flag, but that doing so is not recommended for stronger type safety.Minimal reproduction of the problem with instructions
N/A
What is the motivation / use case for changing the behavior?
--strict
flag.Environment
For Tooling issues:
N/A
Others:
N/A
The text was updated successfully, but these errors were encountered: