Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -112,3 +112,6 @@ src/*/_setuptools_scm_version.py

# Nix
result

# Vale styles downloaded by ``vale sync``
styles/
30 changes: 30 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -309,6 +309,36 @@ repos:
- *uv_version
stages: [pre-commit]

# Vale enforces prose style rules, such as banning em dashes, in
# reStructuredText files.
# The rules come from the ``ClearProse`` package pinned in ``.vale.ini``,
# which ``vale sync`` downloads into the (gitignored) ``styles``
# directory.
# Vale needs ``rst2html`` from Docutils on the ``PATH`` to parse
# reStructuredText.
# ``vale sync`` also runs when ``.vale.ini`` changes, so a package
# bump takes effect without waiting for the next reStructuredText
# change.
- id: vale-sync
name: vale sync
entry: uv run --extra=dev vale sync
language: python
pass_filenames: false
files: (\.rst$|^\.vale\.ini$)
additional_dependencies:
- *uv_version
stages: [pre-commit]

- id: vale
name: vale
entry: uv run --extra=dev vale
language: python
types_or: [rst]
require_serial: true
additional_dependencies:
- *uv_version
stages: [pre-commit]

- id: doc8
name: doc8
entry: uv run --extra=dev -m doc8
Expand Down
7 changes: 7 additions & 0 deletions .vale.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
StylesPath = styles
MinAlertLevel = error

Packages = https://github.com/adamtheturtle/vale-style-clear-prose/releases/download/v1.1.0/ClearProse.zip

[*.rst]
BasedOnStyles = ClearProse
2 changes: 2 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ optional-dependencies.dev = [
"towncrier==25.8.0",
"ty==0.0.65",
"types-pyyaml==6.0.12.20260724",
"vale==3.13.0.0",
"vulture==2.16",
"vws-python-mock==2026.2.22.3",
"vws-test-fixtures==2023.3.5",
Expand Down Expand Up @@ -297,6 +298,7 @@ ignore = [
".git_archival.txt",
".pre-commit-config.yaml",
".prettierrc",
".vale.ini",
".yamlfmt",
"bin",
"bin/*",
Expand Down
11 changes: 11 additions & 0 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading