Repository navigation
feat: enable Coder.USSpelling Vale rule - #30790
Merged
nickvigilante merged 2 commits intoOct 24, 2026
Merged
Conversation
Contributor
Docs previewCheck off each page once it's been reviewed. If a page changes in a later push, its checkbox clears automatically so it gets a fresh look. Pages not yet wired into the docs navigation aren't listed here.
|
nickvigilante
force-pushed
the
vigilante/docs-1280-add-coderusspelling-vale-rule
branch
from
October 14, 2026 21:00
6dd43f9 to
dda8e6d
Compare
Base automatically changed from
vigilante/docs-1282-style-guide-add-missing-rules-from-the-docs-style-guide
to
main
October 16, 2026 13:53
nickvigilante
marked this pull request as ready for review
October 23, 2026 05:14
nickvigilante
force-pushed
the
vigilante/docs-1280-add-coderusspelling-vale-rule
branch
from
October 24, 2026 03:02
869b82f to
91ca7af
Compare
Collaborator
Author
|
The Generated by Coder Agents on behalf of @nickvigilante. |
nickvigilante
force-pushed
the
vigilante/docs-1280-add-coderusspelling-vale-rule
branch
from
October 24, 2026 04:19
91ca7af to
0a9266a
Compare
nickvigilante
deleted the
vigilante/docs-1280-add-coderusspelling-vale-rule
branch
October 24, 2026 05:18
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Depends on #30782.
Adds
Coder.USSpellingatwarningseverity.The rule flags an
-isefamily (organise,initialise,authorisation) and a list of British spellings (behaviour,labelled,cancelled,analogue,whilst, and others) and suggests the US form.It covers
docs/**exceptdocs/.style/style-guide/**and the generateddocs/reference/{api,cli}/*.mdpages.Baseline: 13 findings before cleanup, 0 after.
The first commit fixes 11 of them: 10 in hand-written pages and 1 in the Prometheus metrics table, which comes from metric help text.
Two findings sit in generated reference pages, which
.vale.iniexcludes for this rule: the CLI aliasfavouriteandamongstin a Go comment from a vendored dependency (the DERP map schema).The metric help text comes from
querymetrics.go, so the fix lands there and ingenerated_metricsandprometheus.md.Known false positive: Vale doesn't skip bold text, so a UI label in bold that keeps British spelling is flagged.
The rule comment and the guide footer say to use a code span for such a label.
Linear: DOCS-1280
Decision log
substitution, so each message names the US form.The
-isefamily can't name a specific replacement, so it suggests "the -ize form".cancelled: the guide's "Use US spelling" section listscanceledandcanceling.The rule flags the double-l verb forms and leaves
cancellationalone, which Merriam-Webster spells with onel.^and$and case-insensitive.The list covers
-wisewords and stems foradvise,advertise,exercise,promise,premise,compromise,surprise,comprise,concise,precise,revise,supervise,televise,devise,improvise,franchise,merchandise,disguise,despise,paradise,cruise,noise,raise,rise,wise, and others, each with the endingse,es,ed,ing,er, anders.The
misetool is excepted by name.lverbs (signalled,levelled),metre,litre,fibre,theatre,calibre,offence,pretence,analyse,judgement,acknowledgement,ageing,artefact,sceptic,aluminium,practise,enrol,fulfil,instil,skilful.None appears in the corpus today.
docs/reference/{api,cli}/*.md, asCoder.UnitSpacingdoes.Changing the
favouritealias would change CLI behavior, and theamongstcomment isn't ours to edit.go run ./scripts/metricsdocgenalready rewrites the whole table on the base branch, independent of this change.Test cases, run with
vale --configagainst fixtures that are not committed, in LF and CRLF:organise,initialise,authorise,customisation,authorisation,organisations,Organised,initialising,recogniser,customisable, every explicit list entry, and capitalized forms.advise,exercise,otherwise,Enterprise,premise,compromise,promise,surprise,precise,concise,expertise,revising,supervising,improvising,raise,noise,cruise,franchise,merchandise,disguise,despise,paradise,appraise,sunrise,arise,liaise,clockwise,cancellation,canceled,mise.cancelled.Checks:
vale --output=line docs/reports 0Coder.USSpellingfindings,make lint/style-claimspasses, and the pre-commit hooks pass on both commits.Generated by Coder Agents on behalf of @nickvigilante.