blockwatch-cli 0.11.2__tar.gz → 0.12.0__tar.gz

{blockwatch_cli-0.11.2 → blockwatch_cli-0.12.0}/AGENTS.md

@@ -125,8 +125,9 @@ Source files here contain real `<block ...>` tags. Two runs check them:
   the code here.
 
 The hook and CI read `blockwatch.toml`. It skips `tests/testdata/`, where the fixtures break rules on purpose. It also
-turns off `check-lua`, because the `check-lua` block here needs the network. `.github/workflows/trusted-checks.yml`
-runs that block on a schedule.
+skips the `latest-model` block, because its `check-lua` script needs the network. `.github/workflows/trusted-checks.yml`
+runs that block on a schedule. The `[[block]]` entries in `blockwatch.toml` hold rules too, with no tag in the file
+they check, such as the version and the dependencies in `Cargo.toml`.
 
 No test checks these blocks, so `cargo test` can pass while the hook fails. `tests/general.rs` also runs the linter on
 the whole tree, but with an empty config, so the fixtures fail that run on purpose. To check the blocks before you

{blockwatch_cli-0.11.2 → blockwatch_cli-0.12.0}/CHANGELOG.md

@@ -12,6 +12,46 @@ Releases up to and including v0.3.11 predate this file. Their notes live on the
 
 ## [Unreleased] - ReleaseDate
 
+## [0.12.0] - 2026-10-15
+
+### Changed
+
+- A `blockwatch-suppress:` line with no address now fails the run with `invalid suppression address`. Before,
+  blockwatch ignored it.
+- Messages now show a non-ASCII key in a symbol path as written, such as `data.toml#/täble/key`. Before, they showed
+  `data.toml#/t%C3%A4ble/key`. An `affects` or `same-as` violation on such a key gets a new hash, so update any
+  `--suppress` address with four parts that points at it.
+
+### Fixed
+
+- `--suppress-from` no longer crashes on a line with a non-ASCII character, such as `❌` or `—`, near its start.
+  Before, such a line could make blockwatch exit with code 101, even when the code had no violations
+  ([#172](https://github.com/mennanov/blockwatch/issues/172)).
+- blockwatch no longer crashes on a file that holds a tag and one of these:
+  - in Scala, a `/*` comment that is never closed;
+  - in Markdown, a `[//]:` line with no title, such as `[//]: #`, or with a quote in its destination, such as
+    `[//]: it's (text)`.
+- In Markdown, a tag in a `[//]:` title that starts on the next line is now reported on that line. Before, it was
+  reported on the `[//]:` line.
+- A Lua error in a `check-lua` script now shows the script and the line, such as `check.lua:3:`. Before, it showed a
+  file of blockwatch's own source code: `src/validators/check_lua.rs:309:3:`.
+- `blockwatch list`, the JSON violations and the SARIF log now come out in the same order on every run. Files are
+  sorted by path, and the violations in a file by line, column and validator. Before, the order changed from run to
+  run.
+- A pattern with its `value` group in one branch, such as `^(?:none|(?P<value>\w+))$`, now skips a match of the other
+  branch, such as `none`. This applies to `keep-sorted-pattern`, `keep-unique`, `same-as-pattern`, `check-ai-pattern`
+  and `check-lua-pattern`. Before, such a match gave its whole text as a value, so `keep-unique` could report a false
+  duplicate ([#173](https://github.com/mennanov/blockwatch/issues/173)). A `target-pattern` match like that now stops
+  the run. Before, the block's content was the whole match.
+
+## [0.11.3] - 2026-10-15
+
+### Fixed
+
+- A block with `keep-unique-pattern` now fails the run with ``unrecognized attribute `keep-unique-pattern` ``. Before,
+  blockwatch accepted the attribute and ignored it, so `keep-unique` compared whole lines. Put the regex in
+  `keep-unique` itself: `keep-unique="(?P<value>\w+)"`.
+
 ## [0.11.2] - 2026-10-15
 
 ### Added

{blockwatch_cli-0.11.2 → blockwatch_cli-0.12.0}/CLAUDE.md

@@ -125,8 +125,9 @@ Source files here contain real `<block ...>` tags. Two runs check them:
   the code here.
 
 The hook and CI read `blockwatch.toml`. It skips `tests/testdata/`, where the fixtures break rules on purpose. It also
-turns off `check-lua`, because the `check-lua` block here needs the network. `.github/workflows/trusted-checks.yml`
-runs that block on a schedule.
+skips the `latest-model` block, because its `check-lua` script needs the network. `.github/workflows/trusted-checks.yml`
+runs that block on a schedule. The `[[block]]` entries in `blockwatch.toml` hold rules too, with no tag in the file
+they check, such as the version and the dependencies in `Cargo.toml`.
 
 No test checks these blocks, so `cargo test` can pass while the hook fails. `tests/general.rs` also runs the linter on
 the whole tree, but with an empty config, so the fixtures fail that run on purpose. To check the blocks before you

{blockwatch_cli-0.11.2 → blockwatch_cli-0.12.0}/Cargo.lock

@@ -274,7 +274,7 @@ checksum = "3ded4057c258ba199e2d26386d3af3780957ecaee6c4ef4041c6b4b8b97c0b06"
 
 [[package]]
 name = "blockwatch"
-version = "0.11.2"
+version = "0.12.0"
 dependencies = [
  "anyhow",
  "assert-json-diff",

{blockwatch_cli-0.11.2 → blockwatch_cli-0.12.0}/Cargo.toml

@@ -1,8 +1,6 @@
 [package]
 name = "blockwatch"
-# <block name="crate-version" same-as="docs/cli.md:sarif-example" same-as-mode="subset" same-as-pattern='version = "(?P<value>\d+\.\d+\.\d+)"'>
-version = "0.11.2"
-# </block>
+version = "0.12.0"
 edition = "2024"
 repository = "https://github.com/mennanov/blockwatch"
 description = "Language agnostic linter that keeps your code and documentation in sync and valid"
@@ -43,7 +41,6 @@ strum_macros = "0.28"
 tokio = { version = "1.52", features = ["full"] }
 toml_edit = { version = "0.25", default-features = false, features = ["parse", "serde"] }
 # The grammar crates the language parsers are built from.
-# <block keep-sorted keep-unique>
 tree-sitter = "0.27.0"
 tree-sitter-bash = "0.25"
 tree-sitter-c = "0.24"
@@ -81,7 +78,6 @@ tree-sitter-toml-ng = "0.7"
 tree-sitter-typescript = "0.23"
 tree-sitter-xml = "0.7"
 tree-sitter-yaml = "0.7"
-# </block>
 unidiff = "0.4.1"
 winnow = "1.0"
 

{blockwatch_cli-0.11.2 → blockwatch_cli-0.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blockwatch-cli
-Version: 0.11.2
+Version: 0.12.0
 Summary: Language agnostic linter that keeps your code and documentation in sync and valid
 Keywords: linter,sync,drift,comments,agents
 Home-Page: https://github.com/mennanov/blockwatch

{blockwatch_cli-0.11.2 → blockwatch_cli-0.12.0}/README.md

@@ -96,16 +96,16 @@ have to nitpick in code review.
      same-as="src/validators/mod.rs:validator-registry, docs/validators/README.md:validators-index"
      same-as-pattern='^\|\s*\[`(?P<value>[a-z-]+)`\]'> -->
 
-| Validator                                         | Description                                                                                  | Attributes                                                     |
-|---------------------------------------------------|----------------------------------------------------------------------------------------------|----------------------------------------------------------------|
-| [`affects`](docs/validators/affects.md)           | Forces linked blocks to be edited together (e.g. code and its docs); needs a diff            | `affects`                                                      |
-| [`same-as`](docs/validators/same-as.md)           | Asserts two or more blocks hold the same value, across languages and formats; no diff needed | `same-as`, `same-as-pattern`, `same-as-mode`, `same-as-format` |
-| [`keep-sorted`](docs/validators/keep-sorted.md)   | Enforces alphabetical or numerical ordering on list items                                    | `keep-sorted`, `keep-sorted-pattern`, `keep-sorted-format`     |
-| [`keep-unique`](docs/validators/keep-unique.md)   | Prevents duplicate lines within a block                                                      | `keep-unique`                                                  |
-| [`line-pattern`](docs/validators/line-pattern.md) | Enforces that every line matches a regex, or that no line matches a forbidden one            | `line-pattern`, `line-pattern-forbidden`                       |
-| [`line-count`](docs/validators/line-count.md)     | Enforces lower or upper bounds on the number of lines in a block                             | `line-count`                                                   |
-| [`check-ai`](docs/validators/check-ai.md)         | Validates content against natural language rules using an LLM                                | `check-ai`, `check-ai-pattern`                                 |
-| [`check-lua`](docs/validators/check-lua.md)       | Runs custom validation logic written in Lua                                                  | `check-lua`, `check-lua-pattern`, `check-lua-timeout`          |
+| Validator                                         | Description                                                                                  | Attributes                                                                      |
+|---------------------------------------------------|----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|
+| [`affects`](docs/validators/affects.md)           | Forces linked blocks to be edited together (e.g. code and its docs); needs a diff            | `affects`                                                                       |
+| [`same-as`](docs/validators/same-as.md)           | Asserts two or more blocks hold the same value, across languages and formats; no diff needed | `same-as`, `same-as-paths`, `same-as-pattern`, `same-as-mode`, `same-as-format` |
+| [`keep-sorted`](docs/validators/keep-sorted.md)   | Enforces alphabetical or numerical ordering on list items                                    | `keep-sorted`, `keep-sorted-pattern`, `keep-sorted-format`                      |
+| [`keep-unique`](docs/validators/keep-unique.md)   | Prevents duplicate lines within a block                                                      | `keep-unique`                                                                   |
+| [`line-pattern`](docs/validators/line-pattern.md) | Enforces that every line matches a regex, or that no line matches a forbidden one            | `line-pattern`, `line-pattern-forbidden`                                        |
+| [`line-count`](docs/validators/line-count.md)     | Enforces lower or upper bounds on the number of lines in a block                             | `line-count`                                                                    |
+| [`check-ai`](docs/validators/check-ai.md)         | Validates content against natural language rules using an LLM                                | `check-ai`, `check-ai-pattern`                                                  |
+| [`check-lua`](docs/validators/check-lua.md)       | Runs custom validation logic written in Lua                                                  | `check-lua`, `check-lua-pattern`, `check-lua-timeout`                           |
 
 <!-- </block> -->
 
@@ -210,12 +210,11 @@ exclusions, and custom extension mappings.
 
 **pre-commit** (`.pre-commit-config.yaml`):
 
-<!-- <block name="pre-commit-rev" same-as="Cargo.toml:crate-version" same-as-mode="subset"
-     same-as-pattern='rev: v(?P<value>\d+\.\d+\.\d+)'> -->
+<!-- <block name="pre-commit-rev" same-as-pattern='rev: v(?P<value>\d+\.\d+\.\d+)'> -->
 
 ```yaml
 - repo: https://github.com/mennanov/blockwatch
-  rev: v0.11.2  # Use latest release
+  rev: v0.12.0  # Use latest release
   hooks:
     - id: blockwatch
 ```
@@ -240,7 +239,8 @@ For plain git hooks, local pre-commit setups, and sandboxing untrusted Lua scrip
 
 ## Supported Languages
 
-<!-- <block name="supported-grammar" keep-sorted="asc" keep-sorted-pattern="^- (?P<value>.+)" affects=":pitch"> -->
+<!-- <block name="supported-grammar" keep-sorted="asc" keep-sorted-pattern="^- (?P<value>.+)" affects=":pitch"
+     check-lua="scripts/check_language_count.lua" check-lua-pattern="(?m)^- (?P<value>.+)"> -->
 
 - Bash (with `.zsh`, `.bashrc`, `.bash_profile`, `.zshrc` and `.envrc` support)
 - C#

blockwatch_cli-0.12.0/blockwatch.toml

@@ -0,0 +1,40 @@
+# The test fixtures break the rules on purpose.
+ignore = ['tests/testdata/**']
+
+# This block runs on a schedule in .github/workflows/trusted-checks.yml as it needs network access and ideally should
+# be avoided in a precommit hook.
+skip-blocks = ['src/validators/check_ai.rs:latest-model']
+
+# A block listed in `skip-blocks` is checked only by the scheduled run, so that run must list it too.
+[[block]]
+target = 'blockwatch.toml#/skip-blocks'
+same-as = '.github/workflows/trusted-checks.yml#/jobs/blockwatch/steps/0/with/only_blocks'
+same-as-pattern = '(?P<value>[\w./-]+\.\w+:[\w-]+)'
+
+# Users copy the version from the docs, and the pre-commit hooks install the PyPI package that setup.py pins. So each
+# copy must be the version being released. `cargo release` rewrites them with the replacements in release.toml.
+# The SARIF example also holds the version of the SARIF format, so the version only has to be one of its values.
+[[block]]
+target = 'Cargo.toml#/package/version'
+same-as = '''README.md:pre-commit-rev,
+    docs/ci.md:pre-commit-rev,
+    docs/ci.md:commit-msg-rev,
+    docs/cli.md:sarif-example,
+    setup.py:blockwatch-cli-version'''
+same-as-mode = 'subset'
+
+# The pattern skips the lines that are not a dependency, such as a comment or the items of a `features` list.
+[[block]]
+target = 'Cargo.toml#/dependencies'
+keep-sorted = true
+keep-sorted-pattern = '^(?P<value>[\w-]+) = '
+
+# Dependabot updates actions/checkout in the workflows, but not this pin, which dist copies into release.yml.
+# The pattern reads both the pin, `v7`, and each `actions/checkout@v7` in the workflows.
+[[block]]
+target = 'dist-workspace.toml#/dist/github-action-commits/actions~1checkout'
+same-as = '''.github/workflows/codeql.yml,
+    .github/workflows/markdownlint.yml,
+    .github/workflows/pypi.yml,
+    .github/workflows/rust.yml'''
+same-as-pattern = '(?:actions/checkout@|^)(?P<value>v\d+)$'

{blockwatch_cli-0.11.2 → blockwatch_cli-0.12.0}/docs/ci.md

@@ -15,12 +15,11 @@ It stays fast, because a file without a block tag is not parsed. To check only t
 To use [pre-commit](https://pre-commit.com), add the hook to `.pre-commit-config.yaml`. pre-commit installs a prebuilt
 `blockwatch` from PyPI, so you don't need Rust:
 
-<!-- <block name="pre-commit-rev" same-as="Cargo.toml:crate-version" same-as-mode="subset"
-     same-as-pattern='rev: v(?P<value>\d+\.\d+\.\d+)'> -->
+<!-- <block name="pre-commit-rev" same-as-pattern='rev: v(?P<value>\d+\.\d+\.\d+)'> -->
 
 ```yaml
 - repo: https://github.com/mennanov/blockwatch
-  rev: v0.11.2  # Use latest release
+  rev: v0.12.0  # Use latest release
   hooks:
     - id: blockwatch
 ```
@@ -56,12 +55,11 @@ The `blockwatch` hook runs before the commit message exists, so it cannot see a
 `blockwatch-commit-msg` hook runs one stage later, at `commit-msg`, and hands the message Git is about to use to
 [`--suppress-from`](cli.md#suppressing-from-a-file):
 
-<!-- <block name="commit-msg-rev" same-as="Cargo.toml:crate-version" same-as-mode="subset"
-     same-as-pattern='rev: v(?P<value>\d+\.\d+\.\d+)'> -->
+<!-- <block name="commit-msg-rev" same-as-pattern='rev: v(?P<value>\d+\.\d+\.\d+)'> -->
 
 ```yaml
 - repo: https://github.com/mennanov/blockwatch
-  rev: v0.11.2  # Use latest release
+  rev: v0.12.0  # Use latest release
   hooks:
     - id: blockwatch-commit-msg
 ```

{blockwatch_cli-0.11.2 → blockwatch_cli-0.12.0}/docs/cli.md

@@ -140,7 +140,7 @@ much — see [Checking Only Changed Blocks](ci.md#checking-only-changed-blocks).
 
 ### Supported Diff Input
 
-[//]: # (<block name="diff-input" affects="src/repo_path.rs:diff-target-resolution">)
+<!-- <block name="diff-input" same-as-pattern="`(?P<value>[a-z]/)`"> -->
 
 Each diff header points at a file, and `blockwatch` resolves that path against the repository:
 
@@ -165,7 +165,7 @@ A diff with a file that does not exist in the repository is an error too — but
 Entries whose extension maps to no language, such as binary assets or lockfiles, contribute no blocks and are passed
 over, so a diff carrying them alongside source changes still validates normally.
 
-[//]: # (</block>)
+<!-- </block> -->
 
 In each case `blockwatch` stops rather than check the wrong file, reporting the diff target at fault. The messages
 describe the input rather than the command that produced it, since a diff need not come from Git:
@@ -275,6 +275,8 @@ Write globs in single quotes. TOML then takes them as written, backslashes inclu
 
 Each key matches a flag:
 
+<!-- <block name="config-keys" same-as-pattern="^\|\s*`(?P<value>[a-z-]+)`"> -->
+
 | Key           | Flag           | When the flag is given too                        |
 |---------------|----------------|---------------------------------------------------|
 | `ignore`      | `--ignore`     | Both lists apply.                                 |
@@ -284,6 +286,8 @@ Each key matches a flag:
 | `only-blocks` | `--only-block` | The flags' selection replaces the config's.       |
 | `skip-blocks` | `--skip-block` | The flags' selection replaces the config's.       |
 
+<!-- </block> -->
+
 So `blockwatch -e keep-sorted` runs only `keep-sorted`, whatever the config enables or disables. An extra `--ignore`
 still skips the files the config skips.
 
@@ -293,6 +297,8 @@ unsupported language, a block address that is not `FILE:BLOCK_NAME`, or both `en
 cannot turn a setting off without anyone noticing. The error quotes the bad key or value. For an unknown key or a value
 of the wrong type, it also shows the line and column:
 
+<!-- <block name="config-key-error" same-as-pattern="`(?P<value>[a-z-]+)`"> -->
+
 ```text
 Error: invalid config file "blockwatch.toml"
 
@@ -301,9 +307,11 @@ Caused by:
       |
     1 | ignor = ['x']
       | ^^^^^
-    unknown field `ignor`, expected one of `ignore`, `extensions`, `enable`, `disable`, `block`
+    unknown field `ignor`, expected one of `ignore`, `extensions`, `enable`, `disable`, `only-blocks`, `skip-blocks`, `block`
 ```
 
+<!-- </block> -->
+
 Everything else stays out of the file:
 
 - **The paths and globs, `--diff`, `--only-changed`, `--suppress` and `--suppress-from`** describe one run, not the
@@ -386,6 +394,7 @@ same-as-pattern = 'os\.environ\["(?P<value>[A-Z_]+)"\]'
 - **A match can span lines with `(?s)`.** `(?s)^CREATE TABLE users \(.*?^\);` matches the whole statement. Write
   `.*?`, not `.*`. A `.*` runs to the last `);` in the file, and that still counts as one match.
 - **A `value` group picks the content**, as in the `*-pattern` attributes. Without one, the content is the whole match.
+  A match of a branch without the group stops the run, such as `MODEL = none` for `^MODEL = (?:none|"(?P<value>.+)")`.
 
 A virtual block is a block of the file it wraps:
 
@@ -546,15 +555,15 @@ Nothing else about the run changes: the same violations are found, and the exit
       "tool": {
         "driver": {
           "name": "blockwatch",
-          "version": "0.11.2",
-          "semanticVersion": "0.11.2",
+          "version": "0.12.0",
+          "semanticVersion": "0.12.0",
           "informationUri": "https://github.com/mennanov/blockwatch",
           "rules": [
             {
               "id": "keep-sorted",
               "name": "keep-sorted",
               "shortDescription": { "text": "Requires the lines of a block to stay in order." },
-              "helpUri": "https://github.com/mennanov/blockwatch/blob/v0.11.2/docs/validators/keep-sorted.md"
+              "helpUri": "https://github.com/mennanov/blockwatch/blob/v0.12.0/docs/validators/keep-sorted.md"
             }
           ]
         }

{blockwatch_cli-0.11.2 → blockwatch_cli-0.12.0}/docs/validators/README.md

@@ -72,7 +72,7 @@ along with the rest of their file.
 Controls how a violation is reported. Mirrors
 [LSP diagnostic severities](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#diagnostic).
 
-<!-- <block name="severity-levels" affects="src/blocks.rs:block-severity"> -->
+<!-- <block name="severity-levels" same-as-pattern="^\|\s*`(?P<value>[a-z]+)`"> -->
 
 | Value             | Reported | Exit code |
 |-------------------|----------|-----------|

{blockwatch_cli-0.11.2 → blockwatch_cli-0.12.0}/docs/validators/keep-sorted.md

@@ -93,7 +93,8 @@ A separator must sit between two digits — `_1`, `1_`, `1__0` and `1_.0` are ty
 ## Notes
 
 - Blank lines and lines the pattern does not match are ignored, not treated as out of order. A line whose match is empty
-  is ignored as well.
+  is ignored as well. So is a line that matches a branch without the `value` group: `^(?:none|(?P<value>\w+))$`
+  ignores the line `none`.
 - Comparison is on the trimmed line, so indentation does not affect ordering. A pattern is applied to the trimmed line
   too, so `^` and `$` anchor to the entry rather than to the indentation.
 - An unrecognized `keep-sorted` or `keep-sorted-format` value is a hard error, not a violation.

{blockwatch_cli-0.11.2 → blockwatch_cli-0.12.0}/docs/validators/keep-unique.md

@@ -36,7 +36,8 @@ ids = [
 ```
 
 Without a `value` group the whole match is compared. Lines that do not match are skipped, as are
-lines whose match is empty.
+lines whose match is empty. So is a line that matches a branch without the `value` group: `^(?:none|(?P<value>\w+))$`
+skips the line `none`.
 
 ## Notes
 

{blockwatch_cli-0.11.2 → blockwatch_cli-0.12.0}/docs/validators/same-as.md

@@ -56,8 +56,9 @@ Usually, though, the two places don't hold the same text. Then each block says *
 ## Pick values with `same-as-pattern`
 
 Each block has its own regex. Every match is a value: the `(?P<value>…)` group if there is one, otherwise the whole
-match. A line can hold several values. Lines without a match are skipped, and so are empty matches. This lets you
-compare blocks written in different formats:
+match. A line can hold several values. Lines without a match are skipped, and so are empty matches. So is a match of a
+branch without the `value` group: `^(?:none|(?P<value>\w+))$` skips the line `none`. This lets you compare blocks
+written in different formats:
 
 ```rust
 // <block same-as="README.md:supported-env-vars" same-as-pattern="BLOCKWATCH_AI_[A-Z_]+">

{blockwatch_cli-0.11.2 → blockwatch_cli-0.12.0}/release.toml

@@ -36,9 +36,9 @@ exactly = 1
 
 # The version is spelled out in the docs as well: the `rev:` of the pre-commit
 # snippets, and the `blockwatch` version and `helpUri` of the SARIF sample
-# output. The `crate-version` block in Cargo.toml lists them all and fails
-# a run once any of them goes stale, so they are rewritten here to keep that
-# check green. `exactly` aborts the release before publishing to crates.io if a
+# output. The `[[block]]` entry for `Cargo.toml#/package/version` in
+# blockwatch.toml lists them all and fails a run once any of them goes stale,
+# so they are rewritten here to keep that check green. `exactly` aborts the release before publishing to crates.io if a
 # snippet is ever reworded past these patterns.
 [[pre-release-replacements]]
 file = "README.md"

blockwatch_cli-0.12.0/scripts/check_language_count.lua

@@ -0,0 +1,19 @@
+-- Checks that the number of languages the README's pitch claims is the number of items in its list of supported
+-- languages. The list's block points at the pitch with `affects`, so the pitch arrives in `ctx.affects`, and the script
+-- needs no file access. `check-lua-pattern` passes one value for each item, so an item that wraps over two lines
+-- counts once.
+
+function validate(ctx, content)
+    local pitch = ctx.affects and ctx.affects[1]
+    if not pitch then
+        return "the block must point at the pitch with affects"
+    end
+    local claimed = pitch.content:match("(%d+) languages")
+    if not claimed then
+        return "the pitch does not say how many languages are supported"
+    end
+    if tonumber(claimed) ~= #content then
+        return string.format("the pitch claims %s languages, but the list has %d", claimed, #content)
+    end
+    return nil
+end

{blockwatch_cli-0.11.2 → blockwatch_cli-0.12.0}/setup.py

@@ -5,8 +5,8 @@ from setuptools import setup
 setup(
     name='blockwatch-pre-commit-placeholder',
     version='0.0.0',
-    # <block same-as="Cargo.toml:crate-version" same-as-pattern="blockwatch-cli==(?P<value>\d+\.\d+\.\d+)">
-    install_requires=['blockwatch-cli==0.11.2'],
+    # <block name="blockwatch-cli-version" same-as-pattern="blockwatch-cli==(?P<value>\d+\.\d+\.\d+)">
+    install_requires=['blockwatch-cli==0.12.0'],
     # </block>
     # Without it, setuptools takes the directories under src/ for Python packages.
     packages=[],

{blockwatch_cli-0.11.2 → blockwatch_cli-0.12.0}/src/block_parser.rs

@@ -206,6 +206,10 @@ impl<'source, I: Iterator<Item = Comment>> PartialBlocksIterator<'source, I> {
     fn take_adjacent_comment(&mut self, comment: &Comment) -> Option<Comment> {
         let contents = self.contents;
         self.comments.next_if(|next| {
+            #[expect(
+                clippy::string_slice,
+                reason = "parsers give comment ranges of whole characters"
+            )]
             contents[comment.source_range.end..next.source_range.start]
                 .trim()
                 .is_empty()
@@ -217,6 +221,10 @@ impl<'source, I: Iterator<Item = Comment>> PartialBlocksIterator<'source, I> {
 fn join_comments(comment: Comment, next: Comment, contents: &str) -> Comment {
     // The text between the comments is copied from the source, so an offset into the joined text
     // maps onto the source as it does for a single comment.
+    #[expect(
+        clippy::string_slice,
+        reason = "parsers give comment ranges of whole characters"
+    )]
     let between = &contents[comment.source_range.end..next.source_range.start];
     Comment {
         position_range: comment.position_range.start..next.position_range.end,
@@ -315,9 +323,14 @@ impl BlockStart {
     /// Columns count characters, so the offset is converted by counting the characters it skips
     /// rather than the bytes: the two differ on any line holding a multi-byte character.
     fn source_position_at(position_in_comment: usize, comment: &Comment) -> Position {
+        #[expect(
+            clippy::string_slice,
+            reason = "a tag starts at a `<` and ends after a `>`"
+        )]
         let text_before = &comment.comment_text[..position_in_comment];
         match text_before.rfind('\n') {
             // Past the comment's first line, so the column is measured from that line's start.
+            #[expect(clippy::string_slice, reason = "`line_break` is the index of a `\\n`")]
             Some(line_break) => Position::new(
                 comment.position_range.start.line + text_before.matches('\n').count(),
                 text_before[line_break + 1..].chars().count() + 1,

{blockwatch_cli-0.11.2 → blockwatch_cli-0.12.0}/src/blocks.rs

@@ -166,6 +166,10 @@ impl Content {
     /// Returns the content's text. `source` must be the text of the block's file.
     pub(crate) fn text<'a>(&'a self, source: &'a str) -> &'a str {
         match &self.text {
+            #[expect(
+                clippy::string_slice,
+                reason = "a comment, a symbol or a match sets `range`"
+            )]
             ContentText::Source(range) => &source[range.clone()],
             ContentText::Decoded(text) => text,
         }
@@ -294,7 +298,8 @@ impl Block {
 #[derive(Clone, Copy, Serialize_repr, EnumString, Debug, PartialEq)]
 #[strum(ascii_case_insensitive)]
 #[repr(u8)]
-// <block name="block-severity" affects="docs/validators/README.md:severity-levels">
+/* <block name="block-severity" same-as="docs/validators/README.md:severity-levels"
+same-as-format="identifier" same-as-pattern="^(?P<value>[A-Z][a-z]+) = \d"> */
 pub(crate) enum BlockSeverity {
     /// The default. A violation at this level makes the run exit non-zero, failing a hook or CI.
     Error = 1,
@@ -898,7 +903,8 @@ fn virtual_blocks_in_file(
 }
 
 const RECOGNIZED_ATTRIBUTES: &[&str] = &[
-    // <block keep-sorted>
+    /* <block keep-sorted same-as="src/skill.md:validator-reference"
+    same-as-pattern='"(?P<value>[a-z-]+)"'> */
     "affects",
     "check-ai",
     "check-ai-pattern",
@@ -909,7 +915,6 @@ const RECOGNIZED_ATTRIBUTES: &[&str] = &[
     "keep-sorted-format",
     "keep-sorted-pattern",
     "keep-unique",
-    "keep-unique-pattern",
     "line-count",
     "line-pattern",
     "line-pattern-forbidden",
@@ -1001,6 +1006,7 @@ pub(crate) fn parser_for_file_path<'p>(
     let file_name = file_path.file_name()?.to_str()?;
 
     for (i, _) in file_name.match_indices('.').rev() {
+        #[expect(clippy::string_slice, reason = "`i` is the index of a `.`")]
         let extension = &file_name[i + 1..];
         let ext_os = OsString::from(extension);
 
@@ -2815,7 +2821,7 @@ mod supported_languages_tests {
                 "/* <block> */\nint main() { return 0; }\n/* </block> */".to_string(),
             ),
             (
-                "cc.cpp".to_string(),
+                "cc.cc".to_string(),
                 "// <block>\nint main() { return 0; }\n// </block>".to_string(),
             ),
             (

{blockwatch_cli-0.11.2 → blockwatch_cli-0.12.0}/src/cli.rs

@@ -16,7 +16,7 @@ use crate::violation_address::ViolationAddress;
 use crate::virtual_blocks::VirtualBlock;
 use anyhow::Context;
 use clap::Parser;
-use std::collections::HashMap;
+use std::collections::{BTreeMap, HashMap};
 use std::io::{IsTerminal, Read, Write};
 use std::path::PathBuf;
 use std::process::ExitCode;
@@ -147,7 +147,7 @@ fn run_validators(args: &flags::Args) -> anyhow::Result<ExitCode> {
 /// both leave one behind, and neither says anything about the code being checked.
 fn apply_suppressions(
     suppressed_addresses: &[ViolationAddress],
-    violations: &mut HashMap<RepoPath, Vec<Violation>>,
+    violations: &mut BTreeMap<RepoPath, Vec<Violation>>,
 ) {
     if suppressed_addresses.is_empty() {
         return;
@@ -329,7 +329,7 @@ fn read_diff_from_stdin(
 /// Writes the violations to stderr in the requested format. Returns true if any violation has error
 /// severity.
 fn process_violations(
-    violations: &HashMap<RepoPath, Vec<Violation>>,
+    violations: &BTreeMap<RepoPath, Vec<Violation>>,
     format: flags::OutputFormat,
 ) -> anyhow::Result<bool> {
     let has_error_severity = violations.values().flatten().any(|violation| {
@@ -348,9 +348,10 @@ fn process_violations(
     Ok(has_error_severity)
 }
 
-/// Writes the violations to stderr as one JSON object of diagnostics grouped by file.
-fn write_json_violations(violations: &HashMap<RepoPath, Vec<Violation>>) -> anyhow::Result<()> {
-    let diagnostics: HashMap<&RepoPath, Vec<_>> = violations
+/// Writes the violations to stderr as one JSON object of diagnostics grouped by file, with the
+/// files sorted by path.
+fn write_json_violations(violations: &BTreeMap<RepoPath, Vec<Violation>>) -> anyhow::Result<()> {
+    let diagnostics: BTreeMap<&RepoPath, Vec<_>> = violations
         .iter()
         .map(|(file_path, file_violations)| {
             let file_diagnostics = file_violations
@@ -364,7 +365,7 @@ fn write_json_violations(violations: &HashMap<RepoPath, Vec<Violation>>) -> anyh
 }
 
 /// Writes the violations to stderr as a SARIF log.
-fn write_sarif_violations(violations: &HashMap<RepoPath, Vec<Violation>>) -> anyhow::Result<()> {
+fn write_sarif_violations(violations: &BTreeMap<RepoPath, Vec<Violation>>) -> anyhow::Result<()> {
     write_json(std::io::stderr(), &sarif::SarifLog::new(violations))
 }
 
@@ -376,7 +377,8 @@ fn write_sarif_violations(violations: &HashMap<RepoPath, Vec<Violation>>) -> any
 fn repository_root_path(current_path: PathBuf) -> anyhow::Result<PathBuf> {
     current_path
         .ancestors()
-        // <block affects="src/fs.rs:vcs-metadata-directories">
+        /* <block same-as="src/fs.rs:vcs-metadata-directories" same-as-mode="subset"
+        same-as-pattern='"(?P<value>\.[a-z]+)"'> */
         .find(|path| path.join(".git").exists() || path.join(".hg").exists())
         // </block>
         .map(|path| path.to_path_buf())

{blockwatch_cli-0.11.2 → blockwatch_cli-0.12.0}/src/config.rs

@@ -37,6 +37,10 @@ pub(crate) struct Config {
 #[derive(Deserialize)]
 #[serde(deny_unknown_fields)]
 struct ConfigFile {
+    // The error example in the docs also shows `block` and a misspelled key, so the docs only have
+    // to hold each of these keys.
+    /* <block name="config-keys" same-as="docs/cli.md:config-keys, docs/cli.md:config-key-error"
+    same-as-mode="subset" same-as-format="identifier" same-as-pattern="^(?P<value>[a-z_]+):"> */
     #[serde(default)]
     ignore: Vec<String>,
     #[serde(default)]
@@ -49,6 +53,7 @@ struct ConfigFile {
     only_blocks: Vec<String>,
     #[serde(default, rename = "skip-blocks")]
     skip_blocks: Vec<String>,
+    // </block>
     /// The `[[block]]` entries, each with the byte range of its header.
     #[serde(default)]
     block: Vec<Spanned<BlockEntry>>,