Skip to content

Commit e9c9aa0

Browse files
joyenjoyerclaude
andcommitted
docs: document oxlint usage in contributing getting-started guide
Update the Linters and Code Formatting section to reflect the ESLint to oxlint migration: list the lint/lint:fix/lint:changes commands and swap the ESLint/Stylelint VSCode plugin recommendation for the Oxc extension. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent e6ccfd1 commit e9c9aa0

1 file changed

Lines changed: 13 additions & 3 deletions

File tree

docs/contributing/contributing-getting-started.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,20 @@ See the [testing documentation](testing-overview) for details.
4545

4646
### Linters and Code Formatting
4747

48-
Linters are run as part of the build. If you use VSCode, you can set up the following plugins to catch lint and formatting errors earlier.
48+
Linting is run as part of the build via [oxlint](https://oxc.rs/docs/guide/usage/linter).
4949

50-
1. Install the _Eslint_ plugin [VSCode](https://github.com/Microsoft/vscode-eslint)
51-
1. Install the _Stylelint_ plugin [VSCode](https://github.com/stylelint/vscode-stylelint)
50+
Useful commands:
51+
52+
- `pnpm run lint` — lint the whole workspace.
53+
- `pnpm run lint:fix` — lint the whole workspace and auto-fix what it can.
54+
- `pnpm run lint:changes` — lint only files changed since the last commit.
55+
- `pnpm --filter <package name> lint` / `lint:fix` — lint a single package.
56+
57+
Lint errors are also fixed automatically on commit for staged files via `lint-staged` (see the `pre-commit` git hook).
58+
59+
If you use VSCode, you can set up the following plugin to catch lint errors earlier.
60+
61+
1. Install the _Oxc_ plugin [VSCode](https://marketplace.visualstudio.com/items?itemName=oxc.oxc-vscode)
5262
1. Run `pnpm install` to install the dependencies
5363
1. Restart your editor
5464

0 commit comments

Comments
 (0)