Skip to content

Spell check CI misses typos in docs and code #832

Description

@ananos

The repo carries a fair number of typos and grammar errors in the docs and in Go comments/strings, even though CI runs a cspell job and golangci-lint has misspell enabled. Three gaps let them through:

  1. Ignore-regex bug in .github/linters/.cspell.json: the inline-code pattern `[^`]+` matches across newlines, so it pairs the closing backtick of one code span with the opening backtick of the next one and swallows the prose between them. In backtick-heavy pages most of the text is never spell checked (e.g. lastest in docs/installation.md sits inside a 222-character "inline code" match).
  2. Typos whitelisted in urunc-dict.txt: several real misspellings were added to the project dictionary instead of being fixed (e.g. burdain, levarage, secomp, triger, isues, vlaid), so cspell treats them as correct words.
  3. Inherent limits: golangci-lint runs misspell with only-new-issues: true, so pre-existing typos in Go files are never reported, and grammar-level errors ("the followings", "instructions fo using") are made of valid dictionary words and invisible to any spell checker.

A PR with the fixes (typo sweep + config fix + dictionary cleanup) follows.

Disclosure per the LLM policy: this issue and the accompanying PR were prepared with the assistance of an LLM (Claude Fable 5, via Claude Code) and reviewed by the contributor.

Metadata

Metadata

Assignees

Labels

CIRelated to testingbugSomething isn't working

Type

Projects

Status
No status

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions