@@ -15,11 +15,15 @@ This document summarizes how to work on rslint effectively and consistently.
15
15
16
16
## Build, Test, and Development Commands
17
17
18
+ - Setup submodule and patch: ` git submodule update --init --recursive && ./scripts/apply-tsgo-patch.sh `
19
+ - Install Deps: ` pnpm install `
18
20
- Build JS/TS: ` pnpm build `
19
21
- Run Go tests: ` pnpm run test:go `
20
22
- Run JS tests: ` pnpm run test `
21
23
- Run Check Spell: ` pnpm run check-spell `
22
- - Lint Go: ` pnpm run lint:go ` | Format JS/TS/MD: ` pnpm run format `
24
+ - Lint Go: ` pnpm run lint:go `
25
+ - Lint JS: ` pnpm run lint `
26
+ - Format JS/TS/MD: ` pnpm run format `
23
27
- CLI: ` go run ./cmd/rslint --help `
24
28
- Examples: ` go run ./cmd/rslint --config rslint.jsonc ` , ` --fix ` , ` --format default|jsonline|github ` , ` --quiet ` , ` --max-warnings 0 `
25
29
- LSP: ` go run ./cmd/rslint --lsp ` | IPC API: ` go run ./cmd/rslint --api `
@@ -49,14 +53,3 @@ This document summarizes how to work on rslint effectively and consistently.
49
53
- rslint loads ` rslint.json ` /` rslint.jsonc ` ; rules accept ESLint-style levels/options.
50
54
- The linter walks each file once and dispatches to registered listeners; ` --singleThreaded ` disables parallelism.
51
55
- Use ` --format github ` in CI to emit GitHub workflow annotations.
52
-
53
- ## Fix CI
54
-
55
- - Sync deps: ` pnpm install ` in repo root.
56
- - Lint/spell: ` pnpm run lint:go ` , ` pnpm run check-spell ` .
57
- - Tests: ` pnpm run test:go ` and ` pnpm run test ` (JS/TS).
58
- - Build types: ` pnpm build ` to surface TS type errors.
59
- - Format: ` pnpm run format `
60
- - If Go formatting/lint fails, apply gofmt/goimports in your editor or run your usual formatter, then re-run the checks above.
61
- - If cspell reports legit words, add them to ` cspell.config.cjs ` dictionary.
62
- - Re-run the full sequence locally until all commands pass before pushing.
0 commit comments