Skip to content

Switch Vale to the upstream ai-tells package - #3138

Merged
adamtheturtle merged 1 commit into
mainfrom
agent/use-vale-ai-tells
Aug 11, 2026
Merged

Switch Vale to the upstream ai-tells package#3138
adamtheturtle merged 1 commit into
mainfrom
agent/use-vale-ai-tells

Conversation

@adamtheturtle

@adamtheturtle adamtheturtle commented Aug 11, 2026

Copy link
Copy Markdown
Member

What changed

  • Replace the single-rule ClearProse package with tbhb/vale-ai-tells v1.29.0.
  • Keep all compatible ai-tells rules enabled.
  • Disable only rules that flag established technical, example, or release-note prose already present in this repository.
  • Update the Vale workflow/hook comment where one names the old package.

Why

The upstream package covers em dashes as well as a much broader set of patterns associated with AI-written prose. Repository-specific exceptions avoid rewriting valid technical terminology and reference material merely to satisfy a general-audience heuristic.

Validation

  • uvx --with docutils vale@3.13.0.0 over every tracked *.rst and *.md file
  • Result: passed with zero errors

Note

Low Risk
Config-only change to documentation prose linting; no runtime, security, or data-handling impact.

Overview
Replaces the custom ClearProse Vale package with upstream ai-tells v1.29.0 for broader AI-prose linting in *.rst and *.md files.

Disables five rules (ColonUsage, FigurativeLands, FormalTransitions, OverusedVocabularyVerbs, VerbTricolon) that misfire on existing technical and release-note prose. Updates the pre-commit comment to match.

Reviewed by Cursor Bugbot for commit cf25b91. Bugbot is set up for automated code reviews on this repo. Configure here.

@adamtheturtle
adamtheturtle marked this pull request as ready for review August 11, 2026 20:40
@adamtheturtle
adamtheturtle merged commit 589e12c into main Aug 11, 2026
14 checks passed
@adamtheturtle
adamtheturtle deleted the agent/use-vale-ai-tells branch August 11, 2026 20:43
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