Skip to content

docs: update lint-staged migration guidance #24

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
Jul 11, 2026
Merged

docs: update lint-staged migration guidance #24

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
6 changes: 4 additions & 2 deletions .agents/skills/migrate-to-rstack-cli/references/lint-staged.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ define.staged({
});
```

## Unsupported Cases
Function configs are supported.

Do not carry lint-staged CLI flags to `rs staged`; they are not forwarded. Keep standalone lint-staged when the workflow requires function-based configs, CLI options, or behavior outside a plain task map.
## CLI Options

Run `rs staged -h` for supported options.

@chatgpt-codex-connector chatgpt-codex-connector Bot Jul 11, 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 Clarify that only listed lint-staged flags migrate

When an existing hook uses a lint-staged-only flag such as --diff for CI/branch diffs, this migration reference now points to help but no longer says to keep standalone lint-staged for unsupported flags. I checked packages/rstack/src/staged.ts: parseArgs is strict: true and the rs staged help only lists --allow-empty, --concurrent, --cwd, --debug, --no-stash, --quiet, --relative, and --verbose, while lint-staged's own help includes additional flags like --diff [string] to override the default git diff --staged behavior and --fail-on-changes; migrating those scripts to rs staged will fail on the unknown option, so this section should explicitly say only the listed options can be carried over.

Useful? React with 👍 / 👎.