Feat: Added Command guide under Cli #23
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThe changes implement comprehensive documentation for various CLI commands in the Stencil framework. This includes adding detailed descriptions and usage instructions for commands like Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- docs/cli/Commands.md (1 hunks)
- sidebars.js (1 hunks)
Additional context used
LanguageTool
docs/cli/Commands.md
[grammar] ~110-~110: The verb form doesn’t seem to match ‘New’. If it is an imperative, consider using a comma.
Context: ...e:**sh $ stencil docker## New command The Stencilnewcommand is used to cr...(NNP_VB_TO)
[uncategorized] ~111-~111: Do not mix variants of the same word (‘initialise’ and ‘initialize’) within a single text.
Context: ...cilnewcommand is used to create and initialise a new Stencil project. ``` $ stencil n...(EN_WORD_COHERENCY)
[uncategorized] ~121-~121: Possible missing comma found.
Context: ...s:** 1.prisma : This is a required option with yes/no as acceptable options. 2.*...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~123-~123: Possible missing comma found.
Context: ...2.user-service : This is a required option with yes/no as acceptable options. 3.*...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~125-~125: Possible missing comma found.
Context: ... 3.monitoring : This is a required option with yes/no as acceptable options. 4.*...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~127-~127: Possible missing comma found.
Context: ...s. 4.temporal : This is a required option with yes/no as acceptable options. 5.*...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~131-~131: Possible missing comma found.
Context: ... 6.file-upload : This is a required option with yes/no as acceptable options. 7.*...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~133-~133: Possible missing comma found.
Context: ...package-manager* : This is a required option with npm/yarn/pnpm/bun as acceptable op...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~136-~136: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ur application to have using the options or you can attachFlagsto your Stencil ...(COMMA_COMPOUND_SENTENCE)
[style] ~181-~181: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...service-file-upload|fu| If you want to have fileUpload setup in the project. ...(REP_WANT_TO_VB)
Markdownlint
docs/cli/Commands.md
32-32: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
57-57: Expected: 0 or 2; Actual: 5
Trailing spaces(MD009, no-trailing-spaces)
60-60: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
135-135: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
157-157: Column: 27
Hard tabs(MD010, no-hard-tabs)
170-170: Column: 24
Hard tabs(MD010, no-hard-tabs)
39-39: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
65-65: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
79-79: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
89-89: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
98-98: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
107-107: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
11-11: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
41-41: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
59-59: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
91-91: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
100-100: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
110-110: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
13-13: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
40-40: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
51-51: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
90-90: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
99-99: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
137-137: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
141-141: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
143-143: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
147-147: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
21-21: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
26-26: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
52-52: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
150-150: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
13-13: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
113-113: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
182-182: null
Files should end with a single newline character(MD047, single-trailing-newline)
57-57: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
Additional comments not posted (3)
sidebars.js (1)
78-78: Sidebar update approved.The addition of 'cli/Commands' to the sidebar items under the 'CLI' category is correctly implemented to reflect the new documentation.
docs/cli/Commands.md (2)
11-25: Documentation for 'Stencil New' command is comprehensive.The section provides clear instructions on how to create a new Stencil project, detailing the process and the structure of the created project.
Tools
Markdownlint
11-11: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
13-13: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
21-21: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
13-13: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
136-147: Grammar correction in the flags description.The description of how to use flags could be improved with a comma before 'or' to connect two independent clauses.
[REFACTOR_Suggestion]136c136 < You can even choose the services that you want your application to have using the options or you can attach `Flags` to your Stencil new command. --- > You can even choose the services that you want your application to have using the options, or you can attach `Flags` to your Stencil new command.Tools
LanguageTool
[uncategorized] ~136-~136: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ur application to have using the options or you can attachFlagsto your Stencil ...(COMMA_COMPOUND_SENTENCE)
Markdownlint
137-137: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
141-141: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
143-143: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
147-147: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
| | `monitoring` |`mf` | Generate monitor folder. | | ||
| | `service-temporal` |`te` | If you want to have temporal setup in the project. | | ||
| | `service-file-upload` |`fu` | If you want to have fileUpload setup in the project. | | ||
| </p> |
There was a problem hiding this comment.
Ensure file ends with a newline.
The Markdown file should end with a single newline character to comply with standards.
182a183
> Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| </p> | |
| </p> | |
Tools
Markdownlint
182-182: null
Files should end with a single newline character(MD047, single-trailing-newline)
| ### Stencl Build | ||
| Compiles an application or workspace into an output folder. | ||
|
|
||
| **Note:** Also, the `build` command is responsible for mapping paths. | ||
|
|
||
| ```sh | ||
| $ stencil build <name> | ||
| ``` |
There was a problem hiding this comment.
Clarify the 'Stencil Build' command description.
The description and note on the build command are informative, but the command usage should be surrounded by blank lines to comply with Markdown standards.
64a65,66
>
>Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### Stencl Build | |
| Compiles an application or workspace into an output folder. | |
| **Note:** Also, the `build` command is responsible for mapping paths. | |
| ```sh | |
| $ stencil build <name> | |
| ``` | |
| ### Stencl Build | |
| Compiles an application or workspace into an output folder. | |
| **Note:** Also, the `build` command is responsible for mapping paths. | |
| ```sh | |
| $ stencil build <name> | |
| ``` | |
Tools
Markdownlint
60-60: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
65-65: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
59-59: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
| ## New command | ||
| The Stencil `new` command is used to create and initialise a new Stencil project. | ||
|
|
||
| ``` | ||
| $ stencil new <name> [option] | ||
| # or | ||
| $ stencil n <name> [option] | ||
| ``` | ||
|
|
||
| **Available Options:** | ||
|
|
||
| 1.**prisma** : This is a required option with yes/no as acceptable options. | ||
|
|
||
| 2.**user-service** : This is a required option with yes/no as acceptable options. | ||
|
|
||
| 3.**monitoring** : This is a required option with yes/no as acceptable options. | ||
|
|
||
| 4.**temporal** : This is a required option with yes/no as acceptable options. | ||
|
|
||
| 5.**logging** : This is a required option with yes/no as acceptable options. | ||
|
|
||
| 6.**file-upload** : This is a required option with yes/no as acceptable options. | ||
|
|
||
| 7.**package-manager** : This is a required option with npm/yarn/pnpm/bun as acceptable options. | ||
|
|
||
| **Flags:** | ||
| You can even choose the services that you want your application to have using the options or you can attach `Flags` to your Stencil new command. | ||
| ```sh | ||
| $ stencil new <name> --flagname | ||
| # or | ||
| $ stencil new <name> -flagalias | ||
| ``` | ||
| **For Example:** | ||
| ```sh | ||
| $ stencil new my-app --monitoring | ||
| # or | ||
| $ stencil new my-app -mf | ||
| ``` | ||
| **Note:** The default value of a service when attached as a flag is considered to be as `yes`. | ||
|
|
||
| **List of Services** | ||
|
|
||
| | Name | Alias | Description | | ||
| |---|---|---| | ||
| | `app` | | Generate a new application within a monorepo (converting to monorepo if it's a standard structure). | | ||
| | `library` |`lib` | Generate a new library within a monorepo (converting to monorepo if it's a standard structure). | | ||
| | `class` |`cl` | Generate a new class.| | ||
| | `controller` |`co` | Generate a controller declaration.| | ||
| | `decorator` |`d` | Generate a custom decorator. | | ||
| | `filter` |`f` | Generate a filter declaration. | | ||
| | `gateway` |`ga` | Generate a gateway declaration. | | ||
| | `guard` |`gu` | Generate a guard declaration. | | ||
| | `interface` |`itf` | Generate an interface. | | ||
| | `interceptor` |`itc` | Generate an interceptor declaration. | | ||
| | `middleware` |`mi` | Generate a middleware declaration. | | ||
| | `module` |`mo` | Generate a module declaration. | | ||
| | `pipe` |`pi` | Generate a pipe declaration. | | ||
| | `provider` |`pr` | Generate a provider declaration. | | ||
| | `resolver` |`r` | Generate a resolver declaration. | | ||
| | `resource` |`res` | Generate a new CRUD resource. See the CRUD (resource) generator for more details. (TS only) | | ||
| | `service` |`s` | Generate a service declaration.| | ||
| | `sub-app` |`app` | Generate a new application within a monorepo | | ||
| | `service-prisma` |`sp` | Generate the Prisma service file | | ||
| | `service-user` |`su` | Add the User Service module from the package. | | ||
| | `fixtures` |`fs` | Generate Custom Fixtures Files. | | ||
| | `husky` |`hs` | Generate Custom husky Files. | | ||
| | `github` |`gh` | Generate Custom github Files. | | ||
| | `prisma` |`ps` | Add custom prisma models to the schema.prisma file. | | ||
| | `devcontainer` |`dc` | Generate files in a .devcontainer file | | ||
| | `monitoring` |`mf` | Generate monitor folder. | | ||
| | `service-temporal` |`te` | If you want to have temporal setup in the project. | | ||
| | `service-file-upload` |`fu` | If you want to have fileUpload setup in the project. | | ||
| </p> |
There was a problem hiding this comment.
Extensive documentation for 'Stencil new' command options and flags.
The detailed options and flags for the Stencil new command are well documented. However, consider adding commas after each option in the list for better readability.
121a122
> ,
123a125
> ,
125a128
> ,
127a131
> ,
131a136
> ,
133a139
> ,Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## New command | |
| The Stencil `new` command is used to create and initialise a new Stencil project. | |
| ``` | |
| $ stencil new <name> [option] | |
| # or | |
| $ stencil n <name> [option] | |
| ``` | |
| **Available Options:** | |
| 1.**prisma** : This is a required option with yes/no as acceptable options. | |
| 2.**user-service** : This is a required option with yes/no as acceptable options. | |
| 3.**monitoring** : This is a required option with yes/no as acceptable options. | |
| 4.**temporal** : This is a required option with yes/no as acceptable options. | |
| 5.**logging** : This is a required option with yes/no as acceptable options. | |
| 6.**file-upload** : This is a required option with yes/no as acceptable options. | |
| 7.**package-manager** : This is a required option with npm/yarn/pnpm/bun as acceptable options. | |
| **Flags:** | |
| You can even choose the services that you want your application to have using the options or you can attach `Flags` to your Stencil new command. | |
| ```sh | |
| $ stencil new <name> --flagname | |
| # or | |
| $ stencil new <name> -flagalias | |
| ``` | |
| **For Example:** | |
| ```sh | |
| $ stencil new my-app --monitoring | |
| # or | |
| $ stencil new my-app -mf | |
| ``` | |
| **Note:** The default value of a service when attached as a flag is considered to be as `yes`. | |
| **List of Services** | |
| | Name | Alias | Description | | |
| |---|---|---| | |
| | `app` | | Generate a new application within a monorepo (converting to monorepo if it's a standard structure). | | |
| | `library` |`lib` | Generate a new library within a monorepo (converting to monorepo if it's a standard structure). | | |
| | `class` |`cl` | Generate a new class.| | |
| | `controller` |`co` | Generate a controller declaration.| | |
| | `decorator` |`d` | Generate a custom decorator. | | |
| | `filter` |`f` | Generate a filter declaration. | | |
| | `gateway` |`ga` | Generate a gateway declaration. | | |
| | `guard` |`gu` | Generate a guard declaration. | | |
| | `interface` |`itf` | Generate an interface. | | |
| | `interceptor` |`itc` | Generate an interceptor declaration. | | |
| | `middleware` |`mi` | Generate a middleware declaration. | | |
| | `module` |`mo` | Generate a module declaration. | | |
| | `pipe` |`pi` | Generate a pipe declaration. | | |
| | `provider` |`pr` | Generate a provider declaration. | | |
| | `resolver` |`r` | Generate a resolver declaration. | | |
| | `resource` |`res` | Generate a new CRUD resource. See the CRUD (resource) generator for more details. (TS only) | | |
| | `service` |`s` | Generate a service declaration.| | |
| | `sub-app` |`app` | Generate a new application within a monorepo | | |
| | `service-prisma` |`sp` | Generate the Prisma service file | | |
| | `service-user` |`su` | Add the User Service module from the package. | | |
| | `fixtures` |`fs` | Generate Custom Fixtures Files. | | |
| | `husky` |`hs` | Generate Custom husky Files. | | |
| | `github` |`gh` | Generate Custom github Files. | | |
| | `prisma` |`ps` | Add custom prisma models to the schema.prisma file. | | |
| | `devcontainer` |`dc` | Generate files in a .devcontainer file | | |
| | `monitoring` |`mf` | Generate monitor folder. | | |
| | `service-temporal` |`te` | If you want to have temporal setup in the project. | | |
| | `service-file-upload` |`fu` | If you want to have fileUpload setup in the project. | | |
| </p> | |
| 1.**prisma** : This is a required option with yes/no as acceptable options. | |
| 2.**user-service** : This is a required option with yes/no as acceptable options. | |
| 3.**monitoring** : This is a required option with yes/no as acceptable options. | |
| 4.**temporal** : This is a required option with yes/no as acceptable options. | |
| 5.**logging** : This is a required option with yes/no as acceptable options. | |
| 6.**file-upload** : This is a required option with yes/no as acceptable options. | |
| 7.**package-manager** : This is a required option with npm/yarn/pnpm/bun as acceptable options. |
Tools
LanguageTool
[grammar] ~110-~110: The verb form doesn’t seem to match ‘New’. If it is an imperative, consider using a comma.
Context: ...e:**sh $ stencil docker## New command The Stencilnewcommand is used to cr...(NNP_VB_TO)
[uncategorized] ~111-~111: Do not mix variants of the same word (‘initialise’ and ‘initialize’) within a single text.
Context: ...cilnewcommand is used to create and initialise a new Stencil project. ``` $ stencil n...(EN_WORD_COHERENCY)
[uncategorized] ~121-~121: Possible missing comma found.
Context: ...s:** 1.prisma : This is a required option with yes/no as acceptable options. 2.*...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~123-~123: Possible missing comma found.
Context: ...2.user-service : This is a required option with yes/no as acceptable options. 3.*...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~125-~125: Possible missing comma found.
Context: ... 3.monitoring : This is a required option with yes/no as acceptable options. 4.*...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~127-~127: Possible missing comma found.
Context: ...s. 4.temporal : This is a required option with yes/no as acceptable options. 5.*...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~131-~131: Possible missing comma found.
Context: ... 6.file-upload : This is a required option with yes/no as acceptable options. 7.*...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~133-~133: Possible missing comma found.
Context: ...package-manager* : This is a required option with npm/yarn/pnpm/bun as acceptable op...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~136-~136: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ur application to have using the options or you can attachFlagsto your Stencil ...(COMMA_COMPOUND_SENTENCE)
[style] ~181-~181: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...service-file-upload|fu| If you want to have fileUpload setup in the project. ...(REP_WANT_TO_VB)
Markdownlint
135-135: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
157-157: Column: 27
Hard tabs(MD010, no-hard-tabs)
170-170: Column: 24
Hard tabs(MD010, no-hard-tabs)
110-110: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
137-137: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
141-141: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
143-143: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
147-147: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
150-150: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
113-113: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
182-182: null
Files should end with a single newline character(MD047, single-trailing-newline)
| ### Stencil `info` | ||
|
|
||
| The `info` command provides detailed information about your current stencil project, including dependencies, versions, and configuration settings. | ||
|
|
||
| **Usage:** | ||
|
|
||
| ```sh | ||
| $ stencil info | ||
| ``` |
There was a problem hiding this comment.
Improve documentation formatting for 'Stencil info'.
The description of the info command is clear, but the usage example should be surrounded by blank lines for better readability.
38a39,40
>
>Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### Stencil `info` | |
| The `info` command provides detailed information about your current stencil project, including dependencies, versions, and configuration settings. | |
| **Usage:** | |
| ```sh | |
| $ stencil info | |
| ``` | |
| ### Stencil `info` | |
| The `info` command provides detailed information about your current stencil project, including dependencies, versions, and configuration settings. | |
| **Usage:** | |
| ```sh | |
| $ stencil info | |
| ``` | |
Tools
Markdownlint
32-32: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
39-39: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
40-40: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
Summary by CodeRabbit
New Features
Commandsdocumentation for various CLI commands in the Stencil framework.Stencil newto create and initialize new Stencil projects.Stencil newcommand to enhance project customization.Documentation
cli/Commands, to the CLI section in the sidebar for easier navigation.