From 9aa93b2a33bbb5afd1dd72069efa3edd4159de09 Mon Sep 17 00:00:00 2001 From: Adam Dangoor Date: Tue, 8 Sep 2026 20:25:39 +0100 Subject: [PATCH 1/8] Enforce semantic line breaks with Snapper --- .github/workflows/semantic-line-breaks.yml | 29 ++++++++++++++++++++++ .snapperrc.toml | 5 ++++ CHANGELOG.rst | 3 +-- docs/source/unreleased.rst | 4 +-- 4 files changed, 37 insertions(+), 4 deletions(-) create mode 100644 .github/workflows/semantic-line-breaks.yml create mode 100644 .snapperrc.toml diff --git a/.github/workflows/semantic-line-breaks.yml b/.github/workflows/semantic-line-breaks.yml new file mode 100644 index 00000000..16647cd2 --- /dev/null +++ b/.github/workflows/semantic-line-breaks.yml @@ -0,0 +1,29 @@ +name: Semantic line breaks + +on: + pull_request: + push: + branches: + - main + +permissions: {} + +jobs: + semantic-line-breaks: + name: Snapper + runs-on: ubuntu-latest + steps: + - name: Check out repository + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 + with: + persist-credentials: false + - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1 + - name: Check semantic line breaks + run: >- + git ls-files -z -- '*.md' '*.rst' ':(exclude)vendored/**' + | xargs -0 --no-run-if-empty + uvx + --from + 'git+https://github.com/TurtleTech-ehf/snapper.git@bcd3458e27e4156ce4e0a0b55a227400328fb3b1' + snapper --max-width 0 --check + diff --git a/.snapperrc.toml b/.snapperrc.toml new file mode 100644 index 00000000..10a770bd --- /dev/null +++ b/.snapperrc.toml @@ -0,0 +1,5 @@ +# These files contain markup constructs that Snapper main does not yet preserve. +ignore = [ + "docs/source/commands.rst", +] + diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 34c97e8a..2ef819fb 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -6,8 +6,7 @@ Changelog 2026.09.08 ---------- -- Check that Gatekeeper accepts the signed and notarized macOS binaries during - the release, and remove the quarantine workaround from the install docs. +- Check that Gatekeeper accepts the signed and notarized macOS binaries during the release, and remove the quarantine workaround from the install docs. 2026.08.30.5 ------------ diff --git a/docs/source/unreleased.rst b/docs/source/unreleased.rst index 22ac7472..d297d197 100644 --- a/docs/source/unreleased.rst +++ b/docs/source/unreleased.rst @@ -1,8 +1,8 @@ Unreleased changes ================== -Changes that have landed on the main branch but are not yet part of a -tagged release. These entries are assembled into the +Changes that have landed on the main branch but are not yet part of a tagged release. +These entries are assembled into the :doc:`changelog` when the next release is published. .. towncrier-draft-entries:: From 2c66df9abec556d477ce8660de34eedfa396646e Mon Sep 17 00:00:00 2001 From: Adam Dangoor Date: Tue, 8 Sep 2026 20:53:55 +0100 Subject: [PATCH 2/8] Run Snapper through Prek --- .github/workflows/semantic-line-breaks.yml | 29 ---------------------- prek.toml | 13 ++++++++++ pyproject.toml | 1 + uv.lock | 7 ++++++ 4 files changed, 21 insertions(+), 29 deletions(-) delete mode 100644 .github/workflows/semantic-line-breaks.yml diff --git a/.github/workflows/semantic-line-breaks.yml b/.github/workflows/semantic-line-breaks.yml deleted file mode 100644 index 16647cd2..00000000 --- a/.github/workflows/semantic-line-breaks.yml +++ /dev/null @@ -1,29 +0,0 @@ -name: Semantic line breaks - -on: - pull_request: - push: - branches: - - main - -permissions: {} - -jobs: - semantic-line-breaks: - name: Snapper - runs-on: ubuntu-latest - steps: - - name: Check out repository - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 - with: - persist-credentials: false - - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1 - - name: Check semantic line breaks - run: >- - git ls-files -z -- '*.md' '*.rst' ':(exclude)vendored/**' - | xargs -0 --no-run-if-empty - uvx - --from - 'git+https://github.com/TurtleTech-ehf/snapper.git@bcd3458e27e4156ce4e0a0b55a227400328fb3b1' - snapper --max-width 0 --check - diff --git a/prek.toml b/prek.toml index 3939de66..d5be3bb9 100644 --- a/prek.toml +++ b/prek.toml @@ -393,6 +393,19 @@ hooks = [ additional_dependencies = ["uv==0.11.7"], stages = ["pre-commit"] }, + { + id = "snapper", + name = "snapper", + entry = "uv run --group=dev snapper --max-width 0 --in-place", + language = "python", + types_or = [ + "rst", + "markdown" + ], + require_serial = true, + additional_dependencies = ["uv==0.11.7"], + stages = ["pre-commit"] + }, { id = "vale", name = "vale", diff --git a/pyproject.toml b/pyproject.toml index d0c1e5df..697fcbc1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -74,6 +74,7 @@ dev = [ # use it to lint shell commands in GitHub workflow files. "shellcheck-py==0.11.0.1", "shfmt-py==4.1.0", + "snapper-fmt @ git+https://github.com/TurtleTech-ehf/snapper.git@bcd3458e27e4156ce4e0a0b55a227400328fb3b1", "sphinx==9.1.0", "sphinx-click==6.2.0", "sphinx-copybutton==0.5.2", diff --git a/uv.lock b/uv.lock index 70639a94..2d16c7ec 100644 --- a/uv.lock +++ b/uv.lock @@ -1648,6 +1648,11 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/b7/ce/149a00dd41f10bc29e5921b496af8b574d8413afcd5e30dfa0ed46c2cc5e/six-1.17.0-py2.py3-none-any.whl", hash = "sha256:4721f391ed90541fddacab5acf947aa0d3dc7d27b2e1e8eda2be8970586c3274", size = 11050, upload-time = "2024-12-04T17:35:26.475Z" }, ] +[[package]] +name = "snapper-fmt" +version = "0.11.0" +source = { git = "https://github.com/TurtleTech-ehf/snapper.git?rev=bcd3458e27e4156ce4e0a0b55a227400328fb3b1#bcd3458e27e4156ce4e0a0b55a227400328fb3b1" } + [[package]] name = "snowballstemmer" version = "3.0.1" @@ -2159,6 +2164,7 @@ dev = [ { name = "setuptools-scm" }, { name = "shellcheck-py" }, { name = "shfmt-py" }, + { name = "snapper-fmt" }, { name = "sphinx" }, { name = "sphinx-click" }, { name = "sphinx-copybutton" }, @@ -2223,6 +2229,7 @@ dev = [ { name = "setuptools-scm", specifier = "==10.2.3" }, { name = "shellcheck-py", specifier = "==0.11.0.1" }, { name = "shfmt-py", specifier = "==4.1.0" }, + { name = "snapper-fmt", git = "https://github.com/TurtleTech-ehf/snapper.git?rev=bcd3458e27e4156ce4e0a0b55a227400328fb3b1" }, { name = "sphinx", specifier = "==9.1.0" }, { name = "sphinx-click", specifier = "==6.2.0" }, { name = "sphinx-copybutton", specifier = "==0.5.2" }, From 598c604406201a7652f4364bdf6691e7b352523d Mon Sep 17 00:00:00 2001 From: Adam Dangoor Date: Tue, 8 Sep 2026 21:05:47 +0100 Subject: [PATCH 3/8] Normalize Snapper configuration --- .snapperrc.toml | 1 - 1 file changed, 1 deletion(-) diff --git a/.snapperrc.toml b/.snapperrc.toml index 10a770bd..5c146068 100644 --- a/.snapperrc.toml +++ b/.snapperrc.toml @@ -2,4 +2,3 @@ ignore = [ "docs/source/commands.rst", ] - From ecd05d0a4186c3a6522e28d2c1546a1c1f6f9315 Mon Sep 17 00:00:00 2001 From: Adam Dangoor Date: Tue, 8 Sep 2026 21:15:47 +0100 Subject: [PATCH 4/8] Isolate the Snapper dependency group --- prek.toml | 2 +- pyproject.toml | 4 +++- uv.lock | 6 ++++-- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/prek.toml b/prek.toml index d5be3bb9..91321668 100644 --- a/prek.toml +++ b/prek.toml @@ -396,7 +396,7 @@ hooks = [ { id = "snapper", name = "snapper", - entry = "uv run --group=dev snapper --max-width 0 --in-place", + entry = "uv run --group=snapper snapper --max-width 0 --in-place", language = "python", types_or = [ "rst", diff --git a/pyproject.toml b/pyproject.toml index 697fcbc1..ca1fbe80 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -74,7 +74,6 @@ dev = [ # use it to lint shell commands in GitHub workflow files. "shellcheck-py==0.11.0.1", "shfmt-py==4.1.0", - "snapper-fmt @ git+https://github.com/TurtleTech-ehf/snapper.git@bcd3458e27e4156ce4e0a0b55a227400328fb3b1", "sphinx==9.1.0", "sphinx-click==6.2.0", "sphinx-copybutton==0.5.2", @@ -103,6 +102,9 @@ release = [ "homebrew-pypi-poet==0.10.0", "towncrier==26.9.0", ] +snapper = [ + "snapper-fmt @ git+https://github.com/TurtleTech-ehf/snapper.git@bcd3458e27e4156ce4e0a0b55a227400328fb3b1", +] [tool.setuptools] packages.find.where = [ diff --git a/uv.lock b/uv.lock index 2d16c7ec..83673582 100644 --- a/uv.lock +++ b/uv.lock @@ -2164,7 +2164,6 @@ dev = [ { name = "setuptools-scm" }, { name = "shellcheck-py" }, { name = "shfmt-py" }, - { name = "snapper-fmt" }, { name = "sphinx" }, { name = "sphinx-click" }, { name = "sphinx-copybutton" }, @@ -2191,6 +2190,9 @@ release = [ { name = "homebrew-pypi-poet" }, { name = "towncrier" }, ] +snapper = [ + { name = "snapper-fmt" }, +] [package.metadata] requires-dist = [ @@ -2229,7 +2231,6 @@ dev = [ { name = "setuptools-scm", specifier = "==10.2.3" }, { name = "shellcheck-py", specifier = "==0.11.0.1" }, { name = "shfmt-py", specifier = "==4.1.0" }, - { name = "snapper-fmt", git = "https://github.com/TurtleTech-ehf/snapper.git?rev=bcd3458e27e4156ce4e0a0b55a227400328fb3b1" }, { name = "sphinx", specifier = "==9.1.0" }, { name = "sphinx-click", specifier = "==6.2.0" }, { name = "sphinx-copybutton", specifier = "==0.5.2" }, @@ -2256,6 +2257,7 @@ release = [ { name = "homebrew-pypi-poet", specifier = "==0.10.0" }, { name = "towncrier", specifier = "==26.9.0" }, ] +snapper = [{ name = "snapper-fmt", git = "https://github.com/TurtleTech-ehf/snapper.git?rev=bcd3458e27e4156ce4e0a0b55a227400328fb3b1" }] [[package]] name = "vws-python" From 786e6339b095150faff1cf1fccea254a870370ed Mon Sep 17 00:00:00 2001 From: Adam Dangoor Date: Tue, 8 Sep 2026 21:33:43 +0100 Subject: [PATCH 5/8] Enable Snapper Vale rules --- .vale.ini | 3 ++- styles/snapper/LongProseLine.yml | 11 +++++++++++ styles/snapper/SemanticLineBreaks.yml | 11 +++++++++++ 3 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 styles/snapper/LongProseLine.yml create mode 100644 styles/snapper/SemanticLineBreaks.yml diff --git a/.vale.ini b/.vale.ini index 729a5e88..c60c5e1f 100644 --- a/.vale.ini +++ b/.vale.ini @@ -4,7 +4,8 @@ MinAlertLevel = error Packages = https://github.com/tbhb/vale-ai-tells/releases/download/v1.29.0/ai-tells.zip [*.{rst,md}] -BasedOnStyles = ai-tells +BasedOnStyles = ai-tells, snapper +snapper.SemanticLineBreaks = error # These rules misclassify established technical, example, or release-note prose # in this repository. All other ai-tells rules remain enforced. diff --git a/styles/snapper/LongProseLine.yml b/styles/snapper/LongProseLine.yml new file mode 100644 index 00000000..1f5029f7 --- /dev/null +++ b/styles/snapper/LongProseLine.yml @@ -0,0 +1,11 @@ +--- +# Vale style rule: flag prose lines that are suspiciously long. +# Likely indicates wrapped text that should use semantic line breaks. +extends: existence +message: Prose line exceeds 120 characters. Consider running 'snapper' to break at + sentence boundaries. +level: suggestion +scope: paragraph +# This catches lines > 120 chars that contain a period followed by a space. +# Pure code or URLs are less likely to match. +tokens: ['.{120,}'] diff --git a/styles/snapper/SemanticLineBreaks.yml b/styles/snapper/SemanticLineBreaks.yml new file mode 100644 index 00000000..3f4edaf5 --- /dev/null +++ b/styles/snapper/SemanticLineBreaks.yml @@ -0,0 +1,11 @@ +--- +# Vale style rule: flag lines containing multiple sentences. +# These should be broken at sentence boundaries. +extends: existence +message: Line contains multiple sentences. Run 'snapper --check' or reformat with + 'snapper --in-place'. +level: warning +scope: paragraph +# Match a sentence-ending punctuation followed by a space and a capital letter +# on the same line (indicating two sentences on one line). +tokens: ['[.!?]\\s+[A-Z]'] From 5e4815b84c7eff2e98115e732a599af8d73fd35d Mon Sep 17 00:00:00 2001 From: Adam Dangoor Date: Tue, 8 Sep 2026 21:57:20 +0100 Subject: [PATCH 6/8] Use the Snapper 0.11.0 release --- pyproject.toml | 2 +- uv.lock | 12 ++++++++++-- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index ca1fbe80..ff13afe1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -103,7 +103,7 @@ release = [ "towncrier==26.9.0", ] snapper = [ - "snapper-fmt @ git+https://github.com/TurtleTech-ehf/snapper.git@bcd3458e27e4156ce4e0a0b55a227400328fb3b1", + "snapper-fmt==0.11.0", ] [tool.setuptools] diff --git a/uv.lock b/uv.lock index 83673582..71d156dd 100644 --- a/uv.lock +++ b/uv.lock @@ -1651,7 +1651,15 @@ wheels = [ [[package]] name = "snapper-fmt" version = "0.11.0" -source = { git = "https://github.com/TurtleTech-ehf/snapper.git?rev=bcd3458e27e4156ce4e0a0b55a227400328fb3b1#bcd3458e27e4156ce4e0a0b55a227400328fb3b1" } +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/72/b7/22229f6fe3fd821fac544093acec7a56e4a31f194d174d266f4b74e03b75/snapper_fmt-0.11.0.tar.gz", hash = "sha256:43dd09debff923670e599422d100a5303db31ea12c96e2842832c37e54926ae1", size = 211613, upload-time = "2026-09-08T18:15:48.981Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/28/75/53d978f7ffc63e40a01d431dfb077ae6c457e1adebb37c3d32dbed42eb6e/snapper_fmt-0.11.0-py3-none-macosx_10_12_x86_64.whl", hash = "sha256:aa760101012b9786b30bcd7ac5ffda2783beda0cfde7f98df725526130292f31", size = 16287991, upload-time = "2026-09-08T18:15:37.424Z" }, + { url = "https://files.pythonhosted.org/packages/5e/d1/7450839bd35e192f06a75079f6099095cc6118c09106e1fc71eb2661e91b/snapper_fmt-0.11.0-py3-none-macosx_11_0_arm64.whl", hash = "sha256:54f0c231258c69c5464f7dd4247c279f6df53b1e7bb1074d90466eb69d36bbc9", size = 15218993, upload-time = "2026-09-08T18:15:40.164Z" }, + { url = "https://files.pythonhosted.org/packages/82/f9/f495c45653e33047c9a6ade91b9145df1322db91129c7eee764ec645d373/snapper_fmt-0.11.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:802efad11aad7636e0abd16ae0fb84a75e5ecd2c3e8955b2fd22d25ef7574efd", size = 16945383, upload-time = "2026-09-08T18:15:42.158Z" }, + { url = "https://files.pythonhosted.org/packages/bb/59/74d0b2cfd7c93e219bfb03f40b312f32155503cbbfb82f87316ba78d018a/snapper_fmt-0.11.0-py3-none-manylinux_2_28_aarch64.whl", hash = "sha256:d7c55fe52dc33d88060586323bb49dee2b47c810f7f659da4e483553fe625678", size = 15558319, upload-time = "2026-09-08T18:15:44.404Z" }, + { url = "https://files.pythonhosted.org/packages/0e/72/ac99137b907c37d47e282e0a0e96f9d7f26bf7e4880cd2b66094bb011457/snapper_fmt-0.11.0-py3-none-win_amd64.whl", hash = "sha256:5e2ef4b5c6ecbff9449ba44c6b3057a2e54d290be1a0a180b1b0c7bf0a1ba3f5", size = 17704912, upload-time = "2026-09-08T18:15:46.981Z" }, +] [[package]] name = "snowballstemmer" @@ -2257,7 +2265,7 @@ release = [ { name = "homebrew-pypi-poet", specifier = "==0.10.0" }, { name = "towncrier", specifier = "==26.9.0" }, ] -snapper = [{ name = "snapper-fmt", git = "https://github.com/TurtleTech-ehf/snapper.git?rev=bcd3458e27e4156ce4e0a0b55a227400328fb3b1" }] +snapper = [{ name = "snapper-fmt", specifier = "==0.11.0" }] [[package]] name = "vws-python" From 86560238cb6d1ad30688d1acc5efe5070e23fb99 Mon Sep 17 00:00:00 2001 From: Adam Dangoor Date: Tue, 8 Sep 2026 22:05:01 +0100 Subject: [PATCH 7/8] Use the development dependency group for Snapper --- prek.toml | 2 +- pyproject.toml | 4 +--- uv.lock | 6 ++---- 3 files changed, 4 insertions(+), 8 deletions(-) diff --git a/prek.toml b/prek.toml index 91321668..d5be3bb9 100644 --- a/prek.toml +++ b/prek.toml @@ -396,7 +396,7 @@ hooks = [ { id = "snapper", name = "snapper", - entry = "uv run --group=snapper snapper --max-width 0 --in-place", + entry = "uv run --group=dev snapper --max-width 0 --in-place", language = "python", types_or = [ "rst", diff --git a/pyproject.toml b/pyproject.toml index ff13afe1..800cbaa5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -74,6 +74,7 @@ dev = [ # use it to lint shell commands in GitHub workflow files. "shellcheck-py==0.11.0.1", "shfmt-py==4.1.0", + "snapper-fmt==0.11.0", "sphinx==9.1.0", "sphinx-click==6.2.0", "sphinx-copybutton==0.5.2", @@ -102,9 +103,6 @@ release = [ "homebrew-pypi-poet==0.10.0", "towncrier==26.9.0", ] -snapper = [ - "snapper-fmt==0.11.0", -] [tool.setuptools] packages.find.where = [ diff --git a/uv.lock b/uv.lock index 71d156dd..ef7edbb2 100644 --- a/uv.lock +++ b/uv.lock @@ -2172,6 +2172,7 @@ dev = [ { name = "setuptools-scm" }, { name = "shellcheck-py" }, { name = "shfmt-py" }, + { name = "snapper-fmt" }, { name = "sphinx" }, { name = "sphinx-click" }, { name = "sphinx-copybutton" }, @@ -2198,9 +2199,6 @@ release = [ { name = "homebrew-pypi-poet" }, { name = "towncrier" }, ] -snapper = [ - { name = "snapper-fmt" }, -] [package.metadata] requires-dist = [ @@ -2239,6 +2237,7 @@ dev = [ { name = "setuptools-scm", specifier = "==10.2.3" }, { name = "shellcheck-py", specifier = "==0.11.0.1" }, { name = "shfmt-py", specifier = "==4.1.0" }, + { name = "snapper-fmt", specifier = "==0.11.0" }, { name = "sphinx", specifier = "==9.1.0" }, { name = "sphinx-click", specifier = "==6.2.0" }, { name = "sphinx-copybutton", specifier = "==0.5.2" }, @@ -2265,7 +2264,6 @@ release = [ { name = "homebrew-pypi-poet", specifier = "==0.10.0" }, { name = "towncrier", specifier = "==26.9.0" }, ] -snapper = [{ name = "snapper-fmt", specifier = "==0.11.0" }] [[package]] name = "vws-python" From dfaff33c79d955d61d31fd6c9a7376a515a350d5 Mon Sep 17 00:00:00 2001 From: Adam Dangoor Date: Tue, 8 Sep 2026 22:37:32 +0100 Subject: [PATCH 8/8] Use conventional RST directive indentation --- .snapperrc.toml | 4 ---- docs/source/commands.rst | 10 +++++----- 2 files changed, 5 insertions(+), 9 deletions(-) delete mode 100644 .snapperrc.toml diff --git a/.snapperrc.toml b/.snapperrc.toml deleted file mode 100644 index 5c146068..00000000 --- a/.snapperrc.toml +++ /dev/null @@ -1,4 +0,0 @@ -# These files contain markup constructs that Snapper main does not yet preserve. -ignore = [ - "docs/source/commands.rst", -] diff --git a/docs/source/commands.rst b/docs/source/commands.rst index 27cc816d..541407ee 100644 --- a/docs/source/commands.rst +++ b/docs/source/commands.rst @@ -2,12 +2,12 @@ Commands ======== .. click:: vws_cli:vws_group - :prog: vws - :show-nested: + :prog: vws + :show-nested: .. click:: vws_cli.query:vuforia_cloud_reco - :prog: vuforia-cloud-reco - :show-nested: + :prog: vuforia-cloud-reco + :show-nested: .. click:: vws_cli.vumark:generate_vumark - :prog: vumark + :prog: vumark