Skip to content

chore: spell-check all file types, not just md/mdx#533

Merged
eseidel merged 1 commit intomainfrom
chore/cspell-consolidate-file-scope
Apr 21, 2026
Merged

chore: spell-check all file types, not just md/mdx#533
eseidel merged 1 commit intomainfrom
chore/cspell-consolidate-file-scope

Conversation

@eseidel
Copy link
Copy Markdown
Contributor

@eseidel eseidel commented Apr 21, 2026

Summary

  • Drop the includes: narrowing from the spell-check workflow so cspell scans all recognized files (.astro, .tsx, .mjs, package.json, etc.), matching how other Shorebird repos run cspell.
  • Make the existing set of files pass cleanly:
    • Add lavamoat, llms, opengraph, paweł, pixelmator, tabler to words:.
    • Add **/*.svg to ignorePaths: — flagged words there are editor-signature metadata (Pixelmator, Paweł) that churns on every re-export, not authored prose.
    • cspell:disable-next-line the Unify analytics blob in Head.astro; its tracking-key fragments (Wuvn, qewe, Mpqiwu, unifytag) aren't dictionary-worthy words.

Why

The md/mdx-only scope lived in the workflow's includes: input, so anything invoking cspell without that input (local CLI, editor extensions, Shorebird CI) would scan every file type cspell recognizes and flag 23 pre-existing issues in 9 files. Rather than hide those issues behind a CI-only glob, fix them and let cspell catch typos in non-doc files too.

Verification

$ npx cspell --config .cspell.yaml "**/*" --no-progress
CSpell: Files checked: 82, Issues found: 0 in 0 files.

npm run format:check passes.

Test plan

  • CI build is green.
  • CI spell-check / build is green (now scanning everything).

Previously the `includes:` in the workflow narrowed cspell scope to
`**/*.md` and `**/*.mdx`, which meant typos in astro pages, tsx
components, and config files went unchecked — and diverged from how
other Shorebird repos run cspell.

Drop the narrowing and make the existing set of files (.astro,
.tsx, .mjs, package.json) pass cleanly:

- Add real product / package / tool names to the words list:
  lavamoat, llms, opengraph, paweł, pixelmator, tabler.
- Add `**/*.svg` to ignorePaths — the flagged words there come
  from editor-signature metadata (Pixelmator, Paweł) that churns
  whenever an icon is re-exported, not from authored prose.
- `cspell:disable-next-line` the Unify analytics blob in Head.astro;
  its tracking-key fragments (Wuvn, qewe, Mpqiwu, unifytag) aren't
  words worth dictionary-ing.
@eseidel eseidel force-pushed the chore/cspell-consolidate-file-scope branch from 89454e0 to bbb9388 Compare April 21, 2026 12:34
@eseidel eseidel changed the title chore: consolidate cspell file scope into .cspell.yaml chore: spell-check all file types, not just md/mdx Apr 21, 2026
@eseidel eseidel merged commit fca50f3 into main Apr 21, 2026
6 checks passed
@eseidel eseidel deleted the chore/cspell-consolidate-file-scope branch April 21, 2026 17:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants