blockwatch-cli 0.16.5__tar.gz → 0.16.6__tar.gz

{blockwatch_cli-0.16.5 → blockwatch_cli-0.16.6}/AGENTS.md

@@ -235,7 +235,7 @@ The main modules:
   Some languages also have symbols. Such a language has a `SymbolsParser`, which its `parser()` passes to
   `.with_symbols(...)`:
 
-  - JSON and YAML walk their syntax trees themselves, and refuse a file with a syntax error.
+  - JSON, YAML and XML walk their syntax trees themselves, and refuse a file with a syntax error.
   - TOML finds its symbols with `toml_edit`. What a TOML key means depends on the order of the headers, not on how the
     syntax tree is nested.
   - Markdown finds its sections with the `markdown` crate, the same parser that finds its comments.

{blockwatch_cli-0.16.5 → blockwatch_cli-0.16.6}/CHANGELOG.md

@@ -12,6 +12,24 @@ Releases up to and including v0.3.11 predate this file. Their notes live on the
 
 ## [Unreleased] - ReleaseDate
 
+## [0.16.6] - 2026-11-04
+
+### Added
+
+- Symbols in XML files: `.xml`, the MSBuild files (`.csproj`, `.fsproj`, `.vbproj`, `.vcxproj`, `.props`,
+  `.targets`), `.xaml`, `.xsd`, `.xsl` and `.xslt`. `pom.xml#/project/version` points at the text of an element, and
+  `#/Project/@Sdk` at the value of an attribute. A filter picks one of several elements with one name:
+  `#/project/dependencies/~[artifactId=guava]/version`. See [XML](docs/symbols.md#xml).
+- A filter picks one of several items that share a path, such as two `ingress` blocks in HCL:
+  `#/resource/aws_security_group/web/~[from_port=443]/to_port`. Before, the path was ambiguous. See
+  [Picking an item by a key's value](docs/symbols.md#picking-an-item-by-a-keys-value).
+
+### Fixed
+
+- A filter over several items that share a path could read a key of another item, when only that item had the key.
+- A filter could pick the wrong item when an item had a syntax error or a string that blockwatch can't decode. Now
+  such a path stops the run, as a path to that item does.
+
 ## [0.16.5] - 2026-11-03
 
 ### Added

{blockwatch_cli-0.16.5 → blockwatch_cli-0.16.6}/CLAUDE.md

@@ -235,7 +235,7 @@ The main modules:
   Some languages also have symbols. Such a language has a `SymbolsParser`, which its `parser()` passes to
   `.with_symbols(...)`:
 
-  - JSON and YAML walk their syntax trees themselves, and refuse a file with a syntax error.
+  - JSON, YAML and XML walk their syntax trees themselves, and refuse a file with a syntax error.
   - TOML finds its symbols with `toml_edit`. What a TOML key means depends on the order of the headers, not on how the
     syntax tree is nested.
   - Markdown finds its sections with the `markdown` crate, the same parser that finds its comments.

{blockwatch_cli-0.16.5 → blockwatch_cli-0.16.6}/Cargo.lock

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

{blockwatch_cli-0.16.5 → blockwatch_cli-0.16.6}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "blockwatch"
-version = "0.16.5"
+version = "0.16.6"
 edition = "2024"
 repository = "https://github.com/mennanov/blockwatch"
 description = "Language agnostic linter that keeps your code and documentation in sync and valid"

{blockwatch_cli-0.16.5 → blockwatch_cli-0.16.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blockwatch-cli
-Version: 0.16.5
+Version: 0.16.6
 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.16.5 → blockwatch_cli-0.16.6}/README.md

@@ -89,9 +89,10 @@ Two validators work across files:
 - `same-as` fails when a block and its target hold different values. It needs no diff.
 
 Both can point to a block, a whole file, a specific value in a file like `package.json#/version`, a section of a
-Markdown file, a constant in a Go, C, C++, Python, Rust, TypeScript, JavaScript, Java, C#, Kotlin or Swift file, a
-field in a Protocol Buffers file, or a value in a Terraform or other HCL file (see [Symbols](docs/symbols.md)). The
-other validators check a single block on their own: the things you'd otherwise have to nitpick in code review.
+Markdown file, an element or attribute in an XML file such as `pom.xml` or a `.csproj`, a constant in a Go, C, C++,
+Python, Rust, TypeScript, JavaScript, Java, C#, Kotlin or Swift file, a field in a Protocol Buffers file, or a value in
+a Terraform or other HCL file (see [Symbols](docs/symbols.md)). The other validators check a single block on their
+own: the things you'd otherwise have to nitpick in code review.
 
 <!-- <block name="available-validators"
      same-as="src/validators/mod.rs:validator-registry, docs/validators/README.md:validators-index"
@@ -219,7 +220,7 @@ exclusions, and custom extension mappings.
 
 ```yaml
 - repo: https://github.com/mennanov/blockwatch
-  rev: v0.16.5  # Use latest release
+  rev: v0.16.6  # Use latest release
   hooks:
     - id: blockwatch
 ```

{blockwatch_cli-0.16.5 → blockwatch_cli-0.16.6}/docs/ci.md

@@ -19,7 +19,7 @@ To use [pre-commit](https://pre-commit.com), add the hook to `.pre-commit-config
 
 ```yaml
 - repo: https://github.com/mennanov/blockwatch
-  rev: v0.16.5  # Use latest release
+  rev: v0.16.6  # Use latest release
   hooks:
     - id: blockwatch
 ```
@@ -59,7 +59,7 @@ The `blockwatch` hook runs before the commit message exists, so it cannot see a
 
 ```yaml
 - repo: https://github.com/mennanov/blockwatch
-  rev: v0.16.5  # Use latest release
+  rev: v0.16.6  # Use latest release
   hooks:
     - id: blockwatch-commit-msg
 ```

{blockwatch_cli-0.16.5 → blockwatch_cli-0.16.6}/docs/cli.md

@@ -557,15 +557,15 @@ Nothing else about the run changes: the same violations are found, and the exit
       "tool": {
         "driver": {
           "name": "blockwatch",
-          "version": "0.16.5",
-          "semanticVersion": "0.16.5",
+          "version": "0.16.6",
+          "semanticVersion": "0.16.6",
           "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.16.5/docs/validators/keep-sorted.md"
+              "helpUri": "https://github.com/mennanov/blockwatch/blob/v0.16.6/docs/validators/keep-sorted.md"
             }
           ]
         }

{blockwatch_cli-0.16.5 → blockwatch_cli-0.16.6}/docs/symbols.md

@@ -24,25 +24,26 @@ declares, instead of tags in a comment.
 <!-- <block name="extensions-with-symbols" same-as="src/language_parsers/mod.rs:extensions-with-symbols"
      same-as-pattern="`\.?(?P<value>[A-Za-z.]+)`"> -->
 
-| Language         | Files                                                                          | Paths                                                   |
-|------------------|--------------------------------------------------------------------------------|---------------------------------------------------------|
-| JSON             | `.json`, `.jsonc`, `.webmanifest`                                              | [JSON](#json)                                           |
-| TOML             | `.toml`, `Pipfile`                                                             | [TOML](#toml)                                           |
-| YAML             | `.yaml`, `.yml`, `.cff`                                                        | [YAML](#yaml)                                           |
-| Markdown         | `.md`, `.markdown`, `.mdx`                                                     | [Markdown](#markdown)                                   |
-| Go               | `.go`                                                                          | [Go](#go)                                               |
-| C, C++           | `.c`, `.h`, `.cc`, `.cpp`, `.cxx`, `.hh`, `.hpp`, `.hxx`                       | [C and C++](#c-and-c)                                   |
-| Python           | `.py`, `.pyi`, `.pyw`                                                          | [Python and Starlark](#python-and-starlark)             |
-| Starlark         | `.bzl`, `.bazel`, `.bzlmod`, `.star`, `BUILD`, `BUCK`, `WORKSPACE`, `Tiltfile` | [Python and Starlark](#python-and-starlark)             |
-| Rust             | `.rs`                                                                          | [Rust](#rust)                                           |
-| TypeScript       | `.ts`, `.mts`, `.cts`, `.d.ts`, `.tsx`                                         | [TypeScript and JavaScript](#typescript-and-javascript) |
-| JavaScript       | `.js`, `.mjs`, `.cjs`, `.jsx`                                                  | [TypeScript and JavaScript](#typescript-and-javascript) |
-| Java             | `.java`                                                                        | [Java](#java)                                           |
-| C#               | `.cs`                                                                          | [C#](#c)                                                |
-| Kotlin           | `.kt`, `.kts`                                                                  | [Kotlin](#kotlin)                                       |
-| Swift            | `.swift`                                                                       | [Swift](#swift)                                         |
-| Protocol Buffers | `.proto`                                                                       | [Protocol Buffers](#protocol-buffers)                   |
-| HCL (Terraform)  | `.tf`, `.tofu`, `.tfvars`, `.hcl`, `.nomad`                                    | [HCL](#hcl)                                             |
+| Language         | Files                                                                                                       | Paths                                                   |
+|------------------|-------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|
+| JSON             | `.json`, `.jsonc`, `.webmanifest`                                                                           | [JSON](#json)                                           |
+| TOML             | `.toml`, `Pipfile`                                                                                          | [TOML](#toml)                                           |
+| YAML             | `.yaml`, `.yml`, `.cff`                                                                                     | [YAML](#yaml)                                           |
+| Markdown         | `.md`, `.markdown`, `.mdx`                                                                                  | [Markdown](#markdown)                                   |
+| XML              | `.xml`, `.csproj`, `.fsproj`, `.vbproj`, `.vcxproj`, `.props`, `.targets`, `.xaml`, `.xsd`, `.xsl`, `.xslt` | [XML](#xml)                                             |
+| Go               | `.go`                                                                                                       | [Go](#go)                                               |
+| C, C++           | `.c`, `.h`, `.cc`, `.cpp`, `.cxx`, `.hh`, `.hpp`, `.hxx`                                                    | [C and C++](#c-and-c)                                   |
+| Python           | `.py`, `.pyi`, `.pyw`                                                                                       | [Python and Starlark](#python-and-starlark)             |
+| Starlark         | `.bzl`, `.bazel`, `.bzlmod`, `.star`, `BUILD`, `BUCK`, `WORKSPACE`, `Tiltfile`                              | [Python and Starlark](#python-and-starlark)             |
+| Rust             | `.rs`                                                                                                       | [Rust](#rust)                                           |
+| TypeScript       | `.ts`, `.mts`, `.cts`, `.d.ts`, `.tsx`                                                                      | [TypeScript and JavaScript](#typescript-and-javascript) |
+| JavaScript       | `.js`, `.mjs`, `.cjs`, `.jsx`                                                                               | [TypeScript and JavaScript](#typescript-and-javascript) |
+| Java             | `.java`                                                                                                     | [Java](#java)                                           |
+| C#               | `.cs`                                                                                                       | [C#](#c)                                                |
+| Kotlin           | `.kt`, `.kts`                                                                                               | [Kotlin](#kotlin)                                       |
+| Swift            | `.swift`                                                                                                    | [Swift](#swift)                                         |
+| Protocol Buffers | `.proto`                                                                                                    | [Protocol Buffers](#protocol-buffers)                   |
+| HCL (Terraform)  | `.tf`, `.tofu`, `.tfvars`, `.hcl`, `.nomad`                                                                 | [HCL](#hcl)                                             |
 
 <!-- </block> -->
 
@@ -97,6 +98,12 @@ services:
 - **A filter picks a map entry too.** In `{"a": {"name": "x"}}`, `#/~[name=x]` is `#/a`.
 - **A path can hold several filters**, such as `#/groups/~[name=api]/services/~[name=web]/port`. A filter can come
   first, in a file that is a list: `#/~[name=web]`.
+- **When several items share a path, the rest of the path looks only inside the item the filter picked.** For
+  example, two `ingress` blocks in an HCL resource share a path.
+  `#/resource/aws_security_group/web/~[from_port=443]/to_port` is the `to_port` of the block whose `from_port` is
+  `443`.
+- **A filter that reaches an unreadable path stops the run**, as that path does. An item blockwatch can't read, such
+  as one with a syntax error, also stops a filter that compares its key, because that item could match too.
 - **The value starts after the first `=` and ends at the last `]`,** so it can hold both. The key can't hold `=`.
   Inside a filter, escape the key and the value like any key: `/` as `~1`, `,` as `%2C`, and so on.
 
@@ -247,6 +254,69 @@ Clone the repository.
 
 <!-- </block> -->
 
+## XML
+
+`.xml` files have symbols, and so do the MSBuild files (`.csproj`, `.fsproj`, `.vbproj`, `.vcxproj`, `.props`,
+`.targets`), `.xaml`, `.xsd`, `.xsl` and `.xslt`.
+
+<!-- <block name="xml-paths"> -->
+
+Every element and every attribute is a symbol. A path is each element's name, from the root element down. An attribute
+is `@` and its name, under its element:
+
+```xml
+<project xmlns="http://maven.apache.org/POM/4.0.0">
+  <version>1.4.2</version>
+  <dependencies>
+    <dependency>
+      <artifactId>junit</artifactId>
+      <version>5.10.0</version>
+    </dependency>
+    <dependency scope="test">
+      <artifactId>guava</artifactId>
+      <version>33.0.0-jre</version>
+    </dependency>
+  </dependencies>
+  <description>
+    Tools &amp; helpers
+  </description>
+</project>
+```
+
+| Path                                                 | Points at                       |
+|------------------------------------------------------|---------------------------------|
+| `#/project/version`                                  | `1.4.2`                         |
+| `#/project/dependencies`                             | the whole element               |
+| `#/project/dependencies/dependency/version`          | a violation: two elements match |
+| `#/project/dependencies/~[artifactId=guava]/version` | `33.0.0-jre`                    |
+| `#/project/dependencies/~[artifactId=guava]/@scope`  | `test`                          |
+| `#/project/description`                              | `Tools & helpers`               |
+
+- **Elements with one name under one parent share a path**, such as the two `dependency` elements above. A path through
+  them is a violation, so pick one with a [filter](#picking-an-item-by-a-keys-value). Its key can be a child element,
+  such as `artifactId`, or an attribute. In a `.csproj` file, `#/Project/ItemGroup/~[@Include=Serilog]/@Version` is
+  the `Version` of the `PackageReference` whose `Include` is `Serilog`. A position, such as
+  `#/project/modules/module/1`, is not found.
+- **A prefix is part of the name, as written.** Escape its `:` as `%3A`: `#/manifest/application/@android%3Aname`.
+  Namespaces play no part, and `xmlns` attributes are not symbols. Names compare as written, case included.
+- **An element without child elements is its text.** Entities and character references are decoded, CDATA stays as
+  written, and comments are left out. The white space around the text is removed, but the line breaks and indents
+  inside it stay. `<a/>` and `<a></a>` are empty strings.
+- **An element with child elements has no value.** It gives its whole text, tags included, even when it also holds
+  text.
+- **An attribute is its decoded value.** Each tab and line break in it becomes a space, as XML requires. The white
+  space around it stays.
+- **An entity that the DOCTYPE declares stops the run for its path**, because it can stand for any text, even
+  elements. So does a reference to a character that XML forbids, such as `&#0;`.
+- **The XML declaration, the DOCTYPE, comments and processing instructions are not symbols.**
+- **An element covers its start tag, its content and its end tag.** An attribute covers `name="value"`. A comment
+  above an element is not part of it.
+- **A syntax error anywhere stops the run**, and so does an empty file. A few valid files stop it too, because of the
+  parser: a DOCTYPE without white space before its `]`, as in `[<!ENTITY e "x">]`, and a processing instruction with
+  data, such as `<?pi x?>`, inside an element.
+
+<!-- </block> -->
+
 ## Code files
 
 <!-- <block name="code-files"> -->
@@ -840,6 +910,7 @@ resource "aws_instance" "web" {
 - **A path with only some of a block's labels points at nothing.** `#/resource/aws_instance` is no symbol.
 - **A block written twice in one body makes its path a violation**, such as two `ingress` blocks in a resource. Two
   `locals` blocks make `#/locals` a violation, but `#/locals/name` still resolves when only one of them sets `name`.
+  A filter picks one of the blocks: `#/resource/aws_security_group/web/~[from_port=443]/to_port`.
 - **A key of an object is a segment when it is a name, a plain string, `true` or `false`**, such as `Team` or
   `"cost center"`. A key written as a number or an expression, such as `3` or `(var.k)`, is not. The items of a list
   are not symbols.

{blockwatch_cli-0.16.5 → blockwatch_cli-0.16.6}/setup.py

@@ -6,7 +6,7 @@ setup(
     name='blockwatch-pre-commit-placeholder',
     version='0.0.0',
     # <block name="blockwatch-cli-version" same-as-pattern="blockwatch-cli==(?P<value>\d+\.\d+\.\d+)">
-    install_requires=['blockwatch-cli==0.16.5'],
+    install_requires=['blockwatch-cli==0.16.6'],
     # </block>
     # Without it, setuptools takes the directories under src/ for Python packages.
     packages=[],

{blockwatch_cli-0.16.5 → blockwatch_cli-0.16.6}/src/language_parsers/mod.rs

@@ -1046,9 +1046,11 @@ mod tests {
             "cjs",
             "cpp",
             "cs",
+            "csproj",
             "cts",
             "cxx",
             "d.ts",
+            "fsproj",
             "go",
             "h",
             "hcl",
@@ -1068,6 +1070,7 @@ mod tests {
             "mjs",
             "mts",
             "nomad",
+            "props",
             "proto",
             "py",
             "pyi",
@@ -1075,13 +1078,21 @@ mod tests {
             "rs",
             "star",
             "swift",
+            "targets",
             "tf",
             "tfvars",
             "tofu",
             "toml",
             "ts",
             "tsx",
+            "vbproj",
+            "vcxproj",
             "webmanifest",
+            "xaml",
+            "xml",
+            "xsd",
+            "xsl",
+            "xslt",
             "yaml",
             "yml",
         ];