Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThe pull request updates two documentation files. In the configuration file, the "cli-api" route now includes an Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant CLI as HeroUI CLI
participant P as Project System
U->>CLI: Execute command: heroui add [targets] [options]
CLI->>CLI: Parse [targets] and options
alt Target includes Hero Chat
CLI->>P: Add Hero Chat codebase (use --directory if provided)
else
CLI->>P: Add HeroUI components
end
CLI-->>U: Return confirmation message
Tip ⚡🧪 Multi-step agentic review comment chat (experimental)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 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 using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
apps/docs/config/routes.json (1)
52-57: Refined Figma Route FormattingThe "figma" route block has been reformatted for consistency. Although no functional changes were made here, please ensure that the formatting is in line with the project's style guidelines.
apps/docs/content/docs/api-references/cli-api.mdx (4)
37-38: Update Add Command Signature and DescriptionThe
addcommand now uses[targets...]instead of[components...]and clearly describes the two main actions:
- Adding HeroUI components
- Adding the Hero Chat codebase
This update improves clarity. As a minor nitpick, both bullet items begin with "Add" – consider varying the verb in one of the items for improved readability.
104-105: Refine Add Command Step DescriptionsThe steps for the
addcommand are now:
- Add HeroUI components to your project.
- Add Hero Chat codebase to your project.
To improve stylistic clarity, consider varying the initial verbs (for example: "Include HeroUI components" and "Integrate Hero Chat codebase").
🧰 Tools
🪛 LanguageTool
[style] ~105-~105: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...d HeroUI components to your project. 2. Add Hero Chat codebase to your project. ##...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
112-112: Feature List Consistency CheckThe "Features" section now includes an additional step (number 4) explicitly stating "Add Hero Chat codebase to your project." Ensure that this additional information is consistent with the command description and does not lead to redundancy.
120-127: Refine Option Descriptions in Add OptionsIn the Add Options section, please address the following:
- Duplicate Word: The description for
-tw --tailwindPathreads "the path to the tailwind.config file file". Please remove the duplicated "file".- Prettier Option Wording: The description for
--prettiercurrently reads "Add prettier format in the add content which required installed prettier". Consider rewording it to: "Add prettier formatting to the added content (requires prettier to be installed, default:false)."These refinements will improve clarity and professionalism.
🧰 Tools
🪛 LanguageTool
[duplication] ~122-~122: 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] ~124-~124: 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)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
apps/docs/config/routes.json(2 hunks)apps/docs/content/docs/api-references/cli-api.mdx(2 hunks)
🧰 Additional context used
🪛 LanguageTool
apps/docs/content/docs/api-references/cli-api.mdx
[style] ~105-~105: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...d HeroUI components to your project. 2. Add Hero Chat codebase to your project. ##...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~109-~109: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...e to your project. #### Features > 1. Auto add the missing required dependencies to ...
(AUTO_HYPHEN)
[duplication] ~122-~122: 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] ~124-~124: 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)
⏰ Context from checks skipped due to timeout of 90000ms (6)
- GitHub Check: Tests
- GitHub Check: TypeScript
- GitHub Check: Prettier
- GitHub Check: ESLint
- GitHub Check: Build
- GitHub Check: Continuous Release
🔇 Additional comments (3)
apps/docs/config/routes.json (1)
471-476: Add "updated": true to HeroUI CLI RouteThe "cli-api" route now includes the
"updated": trueproperty, which clearly flags that this documentation route has been modified. Verify that any consumers or processes referencing this route are prepared to handle the new property.apps/docs/content/docs/api-references/cli-api.mdx (2)
115-115: Parameter Name ClarificationThe command usage now shows
heroui add [targets...] [options], which replaces the previous[components...]. This renaming reflects that the command can handle a broader range of targets—not just components—which is a welcome clarification.
127-128: New Directory Option ImplementationThe newly added option
--directoryis clear and provides a way to specify a custom directory for adding the Hero Chat codebase. Confirm that the underlying implementation correctly handles this new parameter.
@heroui/accordion
@heroui/alert
@heroui/autocomplete
@heroui/avatar
@heroui/badge
@heroui/breadcrumbs
@heroui/button
@heroui/calendar
@heroui/card
@heroui/checkbox
@heroui/chip
@heroui/code
@heroui/date-input
@heroui/date-picker
@heroui/divider
@heroui/drawer
@heroui/dropdown
@heroui/form
@heroui/image
@heroui/input
@heroui/input-otp
@heroui/kbd
@heroui/link
@heroui/listbox
@heroui/menu
@heroui/modal
@heroui/navbar
@heroui/number-input
@heroui/pagination
@heroui/popover
@heroui/progress
@heroui/radio
@heroui/ripple
@heroui/scroll-shadow
@heroui/select
@heroui/skeleton
@heroui/slider
@heroui/snippet
@heroui/spacer
@heroui/spinner
@heroui/switch
@heroui/table
@heroui/tabs
@heroui/toast
@heroui/tooltip
@heroui/user
@heroui/react
@heroui/system
@heroui/system-rsc
@heroui/theme
@heroui/use-aria-accordion
@heroui/use-aria-accordion-item
@heroui/use-aria-button
@heroui/use-aria-link
@heroui/use-aria-modal-overlay
@heroui/use-aria-multiselect
@heroui/use-callback-ref
@heroui/use-clipboard
@heroui/use-data-scroll-overflow
@heroui/use-disclosure
@heroui/use-draggable
@heroui/use-image
@heroui/use-infinite-scroll
@heroui/use-intersection-observer
@heroui/use-is-mobile
@heroui/use-is-mounted
@heroui/use-measure
@heroui/use-pagination
@heroui/use-real-shape
@heroui/use-ref-state
@heroui/use-resize
@heroui/use-safe-layout-effect
@heroui/use-scroll-position
@heroui/use-ssr
@heroui/use-theme
@heroui/use-update-effect
@heroui/aria-utils
@heroui/dom-animation
@heroui/framer-utils
@heroui/react-rsc-utils
@heroui/react-utils
@heroui/shared-icons
@heroui/shared-utils
@heroui/stories-utils
@heroui/test-utils
commit: |
| > 1. Auto add the missing required `dependencies` to your project | ||
| > 2. Auto add the required `tailwindcss.config.js` configuration to your project | ||
| > 3. Detect whether using pnpm, if so, add the required configuration to your `.npmrc` file | ||
| > 4. Add Hero Chat codebase to your project |
| init [options] [projectName] Initializes a new project | ||
| add [options] [components...] Adds components to your project | ||
| add [options] [targets...] 1. Adds components to your project | ||
| 2. Adds hero chat codebase to your project |
| - `--prettier` [boolean] Add prettier format in the add content which required installed prettier - (default: `false`) | ||
| - `--addApp` [boolean] Add App.tsx file content which required provider (default: `false`) | ||
| - `-b --beta` [boolean] Add beta components (default: `false`) | ||
| - `--directory` [string] Add hero chat codebase to a specific directory |
There was a problem hiding this comment.
- any short flag like
-d? hero chat->HeroUI Chat
|
|
||
| Add HeroUI components to your project. | ||
| 1. Add HeroUI components to your project. | ||
| 2. Add Hero Chat codebase to your project. |
|
Closing bc of #5111 |
3 participants
Sync api from heroui-cli.
Summary by CodeRabbit