Skip to content

docs: add formatting and setup command examples #222

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.

Sign up for GitHub

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

Merged
chenjiahan merged 1 commit into from
Aug 6, 2026
Merged

docs: add formatting and setup command examples #222

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,9 @@ bun add -d rstack
"test": "rs test",
"lint": "rs lint",
"lib": "rs lib",
"doc": "rs doc"
"doc": "rs doc",
"format": "rs fmt",
"prepare": "rs setup"

@chatgpt-codex-connector chatgpt-codex-connector Bot Aug 6, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Avoid enabling setup unconditionally for existing-hook projects

When a project already uses Husky or another hook manager, copying this generic scripts block makes each dependency install run rs setup; if the configured path differs, the command replaces core.hooksPath with Rstack's directory (packages/rstack/src/setup/install.ts:160-161), so the project's existing hooks stop running. The dedicated setup guide requires users to migrate those hooks first (website/docs/en/guide/cli/setup.mdx:44), but this quick-start example gives no such caveat. Either omit prepare from the generic block or include the migration warning/link here.

Useful? React with 👍 / 👎.

}
}
```
Expand All @@ -74,6 +76,7 @@ pnpm test
pnpm lint
pnpm lib
pnpm doc
pnpm format
```

## Credits
Expand Down