Skip to content

Disable Vale.Terms to stop false-positive casing errors#2432

Merged
kcmartin merged 1 commit into
mainfrom
vale-disable-terms
Jul 17, 2026
Merged

Disable Vale.Terms to stop false-positive casing errors#2432
kcmartin merged 1 commit into
mainfrom
vale-disable-terms

Conversation

@kcmartin

Copy link
Copy Markdown
Contributor

Vale.Terms auto-derives from our accept.txt vocab and enforces the canonical casing of every term. Vale 3.15.1 (the version CI installs via errata-ai/vale-action) runs it aggressively:

  • It flags terms inside code spans and code blocks (e.g. `fly scale vm`, [[vm]]), where the lowercase form is required and can't be changed.
  • For regex vocab entries like VM('s)?\b or configs?\b, it prints the raw regex as the suggested replacement ("Use 'VM('s)?\b' instead of 'vm'").

Across the docs this is 450 findings in 216 files, nearly all false positives. Because the Vale workflow lints whole changed files (filter_mode: file) and reviewdog exits non-zero on any finding, this turns the Vale check red on unrelated PRs the moment they touch an affected file (most recently #2192).

This disables Vale.Terms, consistent with Vale.Spelling and Vale.Repetition, which are already off. The vocab still does its main job of spelling acceptance through Fly.Spelling, so no terms become misspellings.

Vale 3.15.1 (used in CI) enforces the casing of every accept.txt vocab
term via Vale.Terms, including inside code spans and code blocks, and
prints regex vocab entries verbatim as the suggested fix. This produces
450 findings across 216 files, nearly all false positives, and turns the
Vale check red on unrelated PRs whenever they touch an affected file.

Vale.Spelling and Vale.Repetition are already disabled for similar
reasons; the vocab still serves spelling acceptance via Fly.Spelling.
@kcmartin
kcmartin merged commit 48bb382 into main Jul 17, 2026
2 checks passed
@kcmartin
kcmartin deleted the vale-disable-terms branch July 17, 2026 19:15
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.

1 participant