Skip to content

fix(docs): make Vale style check blocking#180

Merged
jeremi merged 1 commit into
mainfrom
docs/vale-blocking
Jul 2, 2026
Merged

fix(docs): make Vale style check blocking#180
jeremi merged 1 commit into
mainfrom
docs/vale-blocking

Conversation

@jeremi

@jeremi jeremi commented Jul 2, 2026

Copy link
Copy Markdown
Member

What

Drop --no-exit from the docs-site check:style script so Vale failures fail the check.

Why

scripts/run-vale.mjs --no-exit reports style errors but always exits 0, so the error-level style rules (em dashes, banned words) have been advisory in CI. Recent doc PRs shipped banned punctuation with green checks; making the gate real prevents the next occurrence.

Evidence

  • Current main is clean: npm run check:style reports 0 errors, 0 warnings, 0 suggestions in 42 files, exit 0.
  • With this change, injecting an em dash into README.md makes the same command exit 1 (verified locally, then reverted).

No content changes; one line in docs/site/package.json.

check:style ran run-vale.mjs with --no-exit, so style errors (including
the error-level EmDash rule) never failed CI; banned punctuation shipped
in past PRs with green checks. Vale is clean on main (0 errors in 42
files), and with this change an injected violation exits 1.

Signed-off-by: Jeremi Joslin <jeremi@joslin.fr>
@jeremi jeremi merged commit 61fd334 into main Jul 2, 2026
10 checks passed
@jeremi jeremi deleted the docs/vale-blocking branch July 2, 2026 05:52
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