Skip to content

Commit afac388

Browse files
chore: remove cspell, add USA English rule (#152)
Replace the cspell library, config, and CI job with a short always-on "USA English" rule under conventions. The custom word list had grown into hundreds of brand names; a single human-readable rule captures the intent more cheaply. https://claude.ai/code/session_0199PDuVe8AzYH4Pgt6Guk9z Co-authored-by: Claude <noreply@anthropic.com>
1 parent 52b392f commit afac388

8 files changed

Lines changed: 9 additions & 795 deletions

File tree

.github/workflows/pr.yml

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -115,33 +115,6 @@ jobs:
115115
NODE_OPTIONS: '--max_old_space_size=4096'
116116
run: pnpm run lint
117117

118-
spellcheck:
119-
name: Spell Check
120-
timeout-minutes: 15
121-
runs-on: ubuntu-latest
122-
permissions:
123-
contents: read
124-
if: github.actor != 'github-actions[bot]'
125-
steps:
126-
- name: Check out code
127-
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
128-
with:
129-
fetch-depth: 0
130-
persist-credentials: false
131-
132-
- name: Setup Tools
133-
uses: ./.github/setup
134-
with:
135-
node-version: '22'
136-
137-
- name: Spell Check
138-
uses: streetsidesoftware/cspell-action@9c7145a5e625e30cb68f6932b379e17eb024d974 # v8
139-
with:
140-
files: |
141-
**/*.{ts,md}
142-
suggestions: 'true'
143-
config: 'cspell.json'
144-
145118
prerelease:
146119
name: Prerelease
147120
timeout-minutes: 15

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ that loads `SKILL.md` folders also picks them up on demand.
9999
- [markdown](.agents/skills/conventions/rules/markdown.md) - Markdown structure. The `documentation` and `humanizer` skills cover voice and SEO.
100100
- [security](.agents/skills/conventions/rules/security.md) - Secrets, input validation at trust boundaries, safe shell use.
101101
- [testing](.agents/skills/conventions/rules/testing.md) - Vitest patterns and what to test.
102+
- [usa-english](.agents/skills/conventions/rules/usa-english.md) - Write code, comments, and docs in USA English spellings.
102103

103104
<skills>
104105

CONTRIBUTING.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@ Publishable code lives in `packages/`, internal helpers that never ship live in
5353
| [Vitest](https://vitest.dev/) | Testing |
5454
| [oxlint](https://oxc.rs/docs/guide/usage/linter.html) | Linter |
5555
| [oxfmt](https://github.com/oxc-project/oxfmt) | Formatter |
56-
| [CSpell](https://cspell.org/) | Spell checker |
5756
| [Changesets](https://github.com/changesets/changesets) | Versioning and changelogs |
5857
| [GitHub Actions](https://github.com/features/actions) | CI/CD |
5958

@@ -69,7 +68,6 @@ pnpm typecheck # Type-check all packages
6968
pnpm lint # Lint with oxlint
7069
pnpm lint:fix # Lint and auto-fix
7170
pnpm format # Format with oxfmt
72-
pnpm lint:spell # Spell-check .ts and .md files
7371
pnpm changeset # Create a changeset
7472
pnpm upgrade # Bump dependencies with taze
7573
```
@@ -111,5 +109,3 @@ pnpm changeset
111109
```
112110

113111
Pick the packages you changed, choose the bump (patch for fixes, minor for features, major for breaking changes), and write a short summary aimed at users. Commit the generated file under `.changeset/`. Docs-only or internal changes that touch no published package do not need one.
114-
115-
Spell-check false positives: fix typos in code, or add technical terms and proper nouns to the `words` array in `cspell.json`.

cspell.json

Lines changed: 0 additions & 54 deletions
This file was deleted.

package.json

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
"graph": "npx nx graph ",
2525
"lint": "oxlint -c oxlint.config.ts ./packages",
2626
"lint:fix": "oxlint -c oxlint.config.ts --fix ./packages",
27-
"lint:spell": "cspell \"**/*.{ts,md}\" --config ./cspell.json --no-progress",
2827
"release": "changeset publish",
2928
"start": "turbo run start --filter=./packages/* --filter=./internals/*",
3029
"test": "vitest run --config ./configs/vitest.config.ts",
@@ -41,7 +40,6 @@
4140
"@vitest/coverage-v8": "catalog:",
4241
"@vitest/ui": "catalog:",
4342
"bun-types": "^1.3.14",
44-
"cspell": "^10.0.0",
4543
"oxfmt": "catalog:",
4644
"oxlint": "catalog:",
4745
"size-limit": "catalog:",

0 commit comments

Comments
 (0)