docs: sync api from nextui-cli v0.2.1 #3079
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
WalkthroughThe recent updates primarily involve minor textual adjustments and clarifications in the documentation for the CLI API, enhancing the descriptions for various commands to provide more precise guidance. Additionally, there is an insignificant change in the Changes
Tip New Features and ImprovementsReview SettingsIntroduced new personality profiles for code reviews. Users can now select between "Chill" and "Assertive" review tones to tailor feedback styles according to their preferences. The "Assertive" profile posts more comments and nitpicks the code more aggressively, while the "Chill" profile is more relaxed and posts fewer comments. AST-based InstructionsCodeRabbit offers customizing reviews based on the Abstract Syntax Tree (AST) pattern matching. Read more about AST-based instructions in the documentation. Community-driven AST-based RulesWe are kicking off a community-driven initiative to create and share AST-based rules. Users can now contribute their AST-based rules to detect security vulnerabilities, code smells, and anti-patterns. Please see the ast-grep-essentials repository for more information. New Static Analysis ToolsWe are continually expanding our support for static analysis tools. We have added support for Tone SettingsUsers can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:
Revamped Settings PageWe have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long overdue; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to Miscellaneous
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
Outside diff range and nitpick comments (1)
apps/docs/content/docs/api-references/cli-api.mdx (1)
Line range hint
116-116: There are typos where the word "file" is repeated. Consider removing the duplicate word for clarity.- The path to the tailwind.config file file + The path to the tailwind.config fileAlso applies to: 254-254, 349-349
Review Details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (2)
- apps/docs/config/routes.json (1 hunks)
- apps/docs/content/docs/api-references/cli-api.mdx (12 hunks)
Files skipped from review due to trivial changes (1)
- apps/docs/config/routes.json
Additional Context Used
LanguageTool (8)
apps/docs/content/docs/api-references/cli-api.mdx (8)
Near line 104: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...s to your project. #### Features > 1. Auto add the missing requireddependenciesto ...
Rule ID: AUTO_HYPHEN
Near line 116: Possible typo: you repeated a word
Context: ...string] The path to the tailwind.config file file --app --appPath[string] The path to...
Rule ID: ENGLISH_WORD_REPEAT_RULE
Near line 118: The double modal “required installed” is nonstandard (only accepted in certain dialects). Consider “to be installed”.
Context: ...ormat in the add content which required installed prettier - (default: false) - `--addApp...
Rule ID: NEEDS_FIXED
Near line 254: Possible typo: you repeated a word
Context: ...string] The path to the tailwind.config file file ---prettier[boolean] Add prettier f...
Rule ID: ENGLISH_WORD_REPEAT_RULE
Near line 255: The double modal “required installed” is nonstandard (only accepted in certain dialects). Consider “to be installed”.
Context: ...ormat in the add content which required installed prettier - (default: false) ##### Exam...
Rule ID: NEEDS_FIXED
Near line 305: Possible missing preposition found.
Context: ...o the package.json file --r --remoteList all components available remotely ####...
Rule ID: AI_HYDRA_LEO_MISSING_TO
Near line 340: It seems that a pronoun is missing.
Context: ...[options] ``` ### Features > 1. Check whether haveredundant dependenciesin the pr...
Rule ID: IF_VB
Near line 349: Possible typo: you repeated a word
Context: ...string] The path to the tailwind.config file file --app--appPath[string] The path ...
Rule ID: ENGLISH_WORD_REPEAT_RULE
Additional comments not posted (2)
apps/docs/content/docs/api-references/cli-api.mdx (2)
30-31: Updated descriptions for-v, --versionand-h, --helpoptions are clear and provide better information to the user.
34-41: The command descriptions have been updated to use more active and precise language, which improves clarity and consistency across the documentation.
|
|
||
| Diagnose problems in your project. | ||
| ### Features | ||
|
|
||
| > 1. Check whether have `redundant dependencies` in the project |
There was a problem hiding this comment.
The phrase "Check whether have redundant dependencies" is missing a pronoun. Consider revising for grammatical correctness.
- Check whether have `redundant dependencies`
+ Check whether you have `redundant dependencies`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.
| > 1. Check whether have `redundant dependencies` in the project | |
| > 1. Check whether you have `redundant dependencies` in the project |
|
|
||
| ```codeBlock bash | ||
| nextui list [options] | ||
| ``` | ||
|
|
||
| ### Options | ||
| #### List Options | ||
|
|
||
| - `-p --packagePath` [string] The path to the package.json file | ||
| - `-r --remote` List all components available remotely |
There was a problem hiding this comment.
It seems there might be a missing preposition in the phrase "List all components available remotely." Consider adding "that are" for better readability.
- List all components available remotely
+ List all components that are available remotelyCommittable 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.
| - `-r --remote` List all components available remotely | |
| - `-r --remote` List all components that are available remotely |
|
|
||
| Add NextUI components to your project. | ||
|
|
||
| #### Features | ||
|
|
||
| > 1. Auto add the missing required `dependencies` to your project |
There was a problem hiding this comment.
The phrase "Auto add" might be missing a hyphen. Consider changing it to "Auto-add" if it refers to an automatic process.
- Auto add the missing required `dependencies`
+ Auto-add the missing required `dependencies`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.
| > 1. Auto add the missing required `dependencies` to your project | |
| > 1. Auto-add the missing required `dependencies` to your project |
| @@ -112,7 +118,7 @@ | |||
| - `--prettier` [boolean] Add prettier format in the add content which required installed prettier - (default: false) | |||
There was a problem hiding this comment.
The phrase "required installed" is nonstandard. Consider revising to "to be installed" for grammatical correctness.
- which required installed prettier
+ which requires prettier to be installedAlso applies to: 255-255
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.
| - `--prettier` [boolean] Add prettier format in the add content which required installed prettier - (default: false) | |
| - `--prettier` [boolean] Add prettier format in the add content which requires prettier to be installed - (default: false) |
Sync api from nextui-cli.
Summary by CodeRabbit
-v, --version: Output the current version.-h, --help: Display help information for commands.init: Initializes a new project.add: Adds components to your project.upgrade: Upgrades project components to the latest versions.remove: Removes components from the project.list: Lists all components, showing status, descriptions, and versions.env: Displays debugging information for the local environment.doctor: Checks for issues in the project.help [command]: Display help for command.