docs: sync api from nextui-cli v0.3.5

[winchesHe]

Sync api from nextui-cli.

Summary by CodeRabbit

• New Features

  • Added new components to documentation: Alert, Calendar, Date Input, Date Picker, Date Range Picker, Drawer, and Time Input.
  • Introduced a -d, --debug option in the NextUI CLI for running in debug mode.

• Updates

  • Revised documentation for existing components: Badge, Checkbox, Modal, Skeleton, Tabs, Tooltip, and CLI commands for clarity and consistency.
  • Enhanced navigation and structure of the documentation for better user experience.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
nextui-docs-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 29, 2024 7:48pm
nextui-storybook-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 29, 2024 7:48pm

[changeset-bot]

⚠️ No Changeset found

Latest commit: fc553f9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

The changes in this pull request involve modifications to the routes.json file, which outlines the routing for documentation and components in the NextUI framework. New routes have been added for components such as Alert, Calendar, and others, while existing routes for components like Badge and Checkbox have been updated. Additionally, the documentation for the NextUI CLI has been revised for clarity and consistency, with new command options introduced and descriptions improved.

Changes

File Path	Change Summary
apps/docs/config/routes.json	Added new routes for Alert, Calendar, Date Input, Date Picker, Date Range Picker, Drawer, and Time Input. Updated routes for Badge, Checkbox, Modal, Skeleton, Tabs, Tooltip, and CLI-related documentation.
apps/docs/content/docs/api-references/cli-api.mdx	Updated command descriptions for clarity, added -d, --debug option, standardized section headers, refined output examples, and improved overall documentation structure.

Possibly related PRs

• docs: sync nextui-cli api #3035: This PR updates the cli-api.mdx file, which is directly related to the changes in the routes.json file where the "NextUI CLI" route was marked as updated.
• fix(docs): yarn global command in installation page #4013: This PR modifies the installation instructions for the nextui-cli, which is relevant as the main PR includes updates to the routing structure that may affect how users access CLI documentation.
• chore(docs): update yarn installation command #4132: This PR corrects the Yarn installation command for nextui-cli, which aligns with the updates in the main PR regarding the routing of CLI-related documentation.

Suggested labels

📋 Scope : Docs

Suggested reviewers

• wingkwong
• jrgarciadev

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 2

🧹 Outside diff range and nitpick comments (5)

apps/docs/content/docs/api-references/cli-api.mdx (3)

56-58: Consider documenting default template

While the options are well documented, it would be helpful to specify which template is used by default when no template is specified.

---

389-391: Add purpose for environment information

Consider adding a brief explanation of why users might need to check their environment information and when this command is most useful (e.g., for troubleshooting or reporting issues).

---

Line range hint 1-431: Consider adding version compatibility information

The documentation would benefit from a section specifying:

1. Minimum required Node.js version
2. Compatible package manager versions
3. NextUI version requirements

This information would help users avoid potential compatibility issues.

🧰 Tools

🪛 LanguageTool

[duplication] ~260-~260: Possible typo: you repeated a word
Context: ...string] The path to the tailwind.config file file - --prettier [boolean] Add prettier f...

(ENGLISH_WORD_REPEAT_RULE)

---

[style] ~261-~261: 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) ##### Ex...

(NEEDS_FIXED)

apps/docs/config/routes.json (2)

Line range hint 164-171: Standardize new component flags and enhance keywords

There's an inconsistency in how new components are flagged - Alert uses isNew while others use newPost. Additionally, some keywords could be more comprehensive.

Consider these improvements:

-  "isNew": true
+  "newPost": true
   // For Alert component, also enhance keywords:
-  "keywords": "alert, notification, message"
+  "keywords": "alert, notification, message, warning, info, success, error"

   // For Date Input/Picker components, enhance keywords:
-  "keywords": "date-input, time, input, timezone"
+  "keywords": "date-input, calendar, datetime, input, form control, date selection"

Also applies to: 178-199, 220-227, 438-445

---

Line range hint 206-213: Enhance keywords for updated components

While the updated flag is consistently used, some components could benefit from more specific keywords to improve searchability.

Consider enhancing keywords for better discoverability:

   // For Modal
-  "keywords": "modal, dialog box, popup, overlay, content focus"
+  "keywords": "modal, dialog box, popup, overlay, content focus, lightbox, confirmation dialog"

   // For Tooltip
-  "keywords": "tooltip, hint, descriptive message, hover info"
+  "keywords": "tooltip, hint, descriptive message, hover info, popover, help text"

Also applies to: 234-241, 332-339, 403-410, 424-431, 438-445

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ad79545 and fc553f9.

📒 Files selected for processing (2)

• apps/docs/config/routes.json (1 hunks)
• apps/docs/content/docs/api-references/cli-api.mdx (10 hunks)

🧰 Additional context used

🪛 LanguageTool

apps/docs/content/docs/api-references/cli-api.mdx

[uncategorized] ~107-~107: 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 required dependencies to ...

(AUTO_HYPHEN)

---

[duplication] ~119-~119: Possible typo: you repeated a word
Context: ...string] The path to the tailwind.config file file - -app --appPath [string] The path to...

(ENGLISH_WORD_REPEAT_RULE)

---

[style] ~121-~121: 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) - `--addA...

(NEEDS_FIXED)

---

[duplication] ~260-~260: Possible typo: you repeated a word
Context: ...string] The path to the tailwind.config file file - --prettier [boolean] Add prettier f...

(ENGLISH_WORD_REPEAT_RULE)

---

[style] ~261-~261: 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) ##### Ex...

(NEEDS_FIXED)

---

[grammar] ~346-~346: It seems that a pronoun is missing.
Context: ...[options] ``` ### Features > 1. Check whether have redundant dependencies in the pr...

(IF_VB)

🔇 Additional comments (4)

apps/docs/content/docs/api-references/cli-api.mdx (2)

30-33: Important: New debug mode option added

The new -d, --debug option allows running the CLI without installing dependencies. This is a significant addition that users should be aware of when troubleshooting or testing.

---

36-43: Command descriptions are now more action-oriented

The command descriptions have been improved to start with verbs, making them clearer and more consistent.

apps/docs/config/routes.json (2)

Line range hint 1-497: Well-organized route structure

The routes configuration maintains a clean and logical structure:

• Components are properly alphabetized
• Sections are logically grouped
• Mobile routes provide a streamlined navigation experience

---

Line range hint 1-497: Verify existence of MDX files for new and updated components

Let's ensure all referenced MDX files exist in the repository.

✅ Verification successful

All MDX documentation files are present and properly mapped

The verification process has confirmed that all MDX files referenced in the routes configuration exist in their expected locations, including:

• All new components (10 files) including CLI, Alert, Calendar, Date components, etc.
• All updated components (11 files) including Layout, Dark Mode, Badge, etc.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if all referenced MDX files exist

# Extract all MDX paths and verify their existence
jq -r '.routes[] | select(.routes != null) | .routes[] | select(.path != null) | .path' apps/docs/config/routes.json | while read -r path; do
  # Remove leading /docs/ and check if file exists
  file_path="apps/docs/content${path}"
  if [ ! -f "$file_path" ]; then
    echo "Missing file: $file_path"
  fi
done

Length of output: 9395

---

Script:

#!/bin/bash
# Let's check for the existence of MDX files for new and updated components specifically
# This will help us focus on the critical paths that need verification

# Check new components (marked with isNew or newPost)
echo "Checking new components:"
jq -r '.routes[] | select(.routes != null) | .routes[] | select((.isNew == true or .newPost == true) and .path != null) | .path' apps/docs/config/routes.json | while read -r path; do
  file_path="apps/docs/content${path}"
  if [ ! -f "$file_path" ]; then
    echo "Missing new component file: $file_path"
  else
    echo "Found new component file: $file_path"
  fi
done

echo -e "\nChecking updated components:"
# Check updated components (marked with updated)
jq -r '.routes[] | select(.routes != null) | .routes[] | select(.updated == true and .path != null) | .path' apps/docs/config/routes.json | while read -r path; do
  file_path="apps/docs/content${path}"
  if [ ! -f "$file_path" ]; then
    echo "Missing updated component file: $file_path"
  else
    echo "Found updated component file: $file_path"
  fi
done

Length of output: 6168

[coderabbitai]

🛠️ Refactor suggestion

Improve grammar in feature descriptions

The feature list needs grammatical improvements:

- Check whether have `redundant dependencies` in the project
+ Check whether the project has `redundant dependencies`
- Check whether the NextUI components `required dependencies are installed`
+ Check whether the required dependencies for NextUI components are installed

📝 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.

Suggested change

	### Features
	> 1. Check whether have `redundant dependencies` in the project
	> 2. Check whether the NextUI components `required dependencies are installed` in the project
	> 3. Check the required `tailwind.config.js` file and the content is correct
	> 4. Check `.npmrc` is correct when using `pnpm`
	### Features
	> 1. Check whether the project has `redundant dependencies`
	> 2. Check whether the required dependencies for NextUI components are installed
	> 3. Check the required `tailwind.config.js` file and the content is correct
	> 4. Check `.npmrc` is correct when using `pnpm`

🧰 Tools

🪛 LanguageTool

[grammar] ~346-~346: It seems that a pronoun is missing.
Context: ...[options] ``` ### Features > 1. Check whether have redundant dependencies in the pr...

(IF_VB)

[coderabbitai]

🛠️ Refactor suggestion

Fix grammatical issues and improve clarity

Several improvements needed:

1. Remove duplicate word "file" in tailwindPath description
2. Rephrase "required installed prettier" to "requires prettier to be installed"
3. Consider adding examples of valid file paths for the path options

- `-tw --tailwindPath` [string] The path to the tailwind.config file file
+ `-tw --tailwindPath` [string] The path to the tailwind.config.js file
- `--prettier` [boolean] Add prettier format in the add content which required installed prettier
+ `--prettier` [boolean] Add prettier formatting (requires prettier to be installed)

Committable suggestion skipped: line range outside the PR's diff.

🧰 Tools

🪛 LanguageTool

[duplication] ~119-~119: Possible typo: you repeated a word
Context: ...string] The path to the tailwind.config file file - -app --appPath [string] The path to...

(ENGLISH_WORD_REPEAT_RULE)

---

[style] ~121-~121: 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) - `--addA...

(NEEDS_FIXED)