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

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

@@ -235,22 +235,18 @@ The main modules:
   Some languages also have symbols. Such a language has a `SymbolsParser`, which its `parser()` passes to
   `.with_symbols(...)`:
 
-  - JSON uses a `QuerySymbolsParser`, built from a tree-sitter query (`.scm`) and a `NodeDecoder`.
+  - 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.
-  - YAML walks its syntax tree itself. An alias has a position in a sequence but can't be addressed, and a query can't
-    express that.
   - Markdown finds its sections with the `markdown` crate, the same parser that finds its comments.
 
   Each language's tests list every symbol it finds. When you give a language symbols, also document its paths in
   `docs/symbols.md` and in the "Symbols" section of the skill, `src/skill.md`. A test in `language_parsers/mod.rs` and the
   repository's own blocks keep the list of file types with symbols, and each language's section, in sync with the
   code.
-- `src/symbols.rs` — `Symbol`, the `SymbolsParser` trait, and `resolve`, which finds the symbol a path refers to.
-  `QuerySymbolsParser` runs a language's query and finds every addressable `Symbol` in one walk of the tree, with its
-  path, its definition range and its decoded value. It suits a language whose structure is its syntax tree. It rejects
-  a file with a syntax error, instead of resolving a path through tree-sitter's error recovery. It doesn't check the
-  query itself.
+- `src/symbols/mod.rs` — `Symbol`, the `SymbolsParser` trait, and `resolve`, which finds the symbol a path refers to.
+  `ensure_no_syntax_error` refuses a file with a syntax error, instead of resolving a path through tree-sitter's error
+  recovery.
 - `src/validators/` — one file for each validator (`affects`, `check_ai`, `check_lua`, `keep_sorted`, `keep_unique`,
   `line_count`, `line_pattern`, `same_as`). Each file exports a `detect` function. `Validator::detect` in
   `validators/mod.rs` calls them from one `match`.

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

@@ -12,6 +12,36 @@ 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
+
+- Symbols in Protocol Buffers files (`.proto`). `item.proto#/Item/Color/RED` points at the number of an enum value,
+  and `#/Item/name` at the number of a field. Each message, enum and service is a symbol, and so is each field, oneof,
+  enum value and rpc in it. The package is not part of a path, and options are not symbols. See
+  [Protocol Buffers](docs/symbols.md#protocol-buffers).
+- Symbols in HCL files: Terraform and OpenTofu (`.tf`, `.tofu`, `.tfvars`), Nomad (`.nomad`), and `.hcl` files such
+  as Terragrunt's. See [HCL](docs/symbols.md#hcl).
+- blockwatch now checks the tags in Nomad job files (`.nomad`). Before, it skipped them.
+
 ## [0.16.4] - 2026-11-03
 
 ### Added

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

@@ -235,22 +235,18 @@ The main modules:
   Some languages also have symbols. Such a language has a `SymbolsParser`, which its `parser()` passes to
   `.with_symbols(...)`:
 
-  - JSON uses a `QuerySymbolsParser`, built from a tree-sitter query (`.scm`) and a `NodeDecoder`.
+  - 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.
-  - YAML walks its syntax tree itself. An alias has a position in a sequence but can't be addressed, and a query can't
-    express that.
   - Markdown finds its sections with the `markdown` crate, the same parser that finds its comments.
 
   Each language's tests list every symbol it finds. When you give a language symbols, also document its paths in
   `docs/symbols.md` and in the "Symbols" section of the skill, `src/skill.md`. A test in `language_parsers/mod.rs` and the
   repository's own blocks keep the list of file types with symbols, and each language's section, in sync with the
   code.
-- `src/symbols.rs` — `Symbol`, the `SymbolsParser` trait, and `resolve`, which finds the symbol a path refers to.
-  `QuerySymbolsParser` runs a language's query and finds every addressable `Symbol` in one walk of the tree, with its
-  path, its definition range and its decoded value. It suits a language whose structure is its syntax tree. It rejects
-  a file with a syntax error, instead of resolving a path through tree-sitter's error recovery. It doesn't check the
-  query itself.
+- `src/symbols/mod.rs` — `Symbol`, the `SymbolsParser` trait, and `resolve`, which finds the symbol a path refers to.
+  `ensure_no_syntax_error` refuses a file with a syntax error, instead of resolving a path through tree-sitter's error
+  recovery.
 - `src/validators/` — one file for each validator (`affects`, `check_ai`, `check_lua`, `keep_sorted`, `keep_unique`,
   `line_count`, `line_pattern`, `same_as`). Each file exports a `detect` function. `Validator::detect` in
   `validators/mod.rs` calls them from one `match`.

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

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

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

@@ -1,6 +1,6 @@
 [package]
 name = "blockwatch"
-version = "0.16.4"
+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.4 → blockwatch_cli-0.16.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blockwatch-cli
-Version: 0.16.4
+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.4 → 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, or a constant in a Go, C, C++, Python, Rust, TypeScript, JavaScript, Java, C#, Kotlin or Swift 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.4  # Use latest release
+  rev: v0.16.6  # Use latest release
   hooks:
     - id: blockwatch
 ```
@@ -258,7 +259,7 @@ For plain git hooks, local pre-commit setups, and sandboxing untrusted Lua scrip
 - Go (with `go.mod`, `go.sum` and `go.work` support)
 - GraphQL (`.graphql`, `.graphqls`, `.gql`)
 - Groovy (with `.gradle` and `Jenkinsfile` support)
-- HCL (Terraform and OpenTofu: `.tf`, `.tfvars`, `.tofu`, `.hcl`)
+- HCL (Terraform and OpenTofu: `.tf`, `.tfvars`, `.tofu`, `.hcl`; Nomad: `.nomad`)
 - HTML (with `.xhtml` support)
 - JSON (`.json`, `.jsonc`, `.webmanifest`)
 - Java

{blockwatch_cli-0.16.4 → 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.4  # 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.4  # Use latest release
+  rev: v0.16.6  # Use latest release
   hooks:
     - id: blockwatch-commit-msg
 ```

{blockwatch_cli-0.16.4 → 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.4",
-          "semanticVersion": "0.16.4",
+          "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.4/docs/validators/keep-sorted.md"
+              "helpUri": "https://github.com/mennanov/blockwatch/blob/v0.16.6/docs/validators/keep-sorted.md"
             }
           ]
         }

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

@@ -24,23 +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)                                         |
+| 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> -->
 
@@ -95,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.
 
@@ -245,14 +254,78 @@ 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"> -->
 
 In a code file, each top-level name is a symbol: a constant, a variable, a type, a function or a macro. Its path is
 `#/NAME`.
-With `const MaxPorts = 8` in `consts.go`, `consts.go#/MaxPorts` points at `8`. In Java, C#, Kotlin and Swift, the
-members of a type are symbols too, under the type's name: `Config.java#/Config/MAX_PORTS`.
+With `const MaxPorts = 8` in `consts.go`, `consts.go#/MaxPorts` points at `8`. In Java, C#, Kotlin, Swift and Protocol
+Buffers, the members of a type are symbols too, under the type's name: `Config.java#/Config/MAX_PORTS`. In HCL, each
+block, attribute and object key is a symbol: `main.tf#/variable/region/default`.
 
 - **A value is the initializer as written.** blockwatch never works it out: `20 * 1024 * 1024` stays as it is, and so
   does `0x10`. Use `same-as-pattern` to take the part you need.
@@ -266,7 +339,8 @@ members of a type are symbols too, under the type's name: `Config.java#/Config/M
   with a name from the text that the parser had to skip. Other names in the file still resolve. The message shows
   where the error is.
 - **A path to a string that blockwatch can't decode stops the run.** Other paths in the file still resolve.
-- **Members are not symbols yet**, such as a method or a field, except in Java, C#, Kotlin and Swift.
+- **Members are not symbols yet**, such as a method or a field, except in Java, C#, Kotlin, Swift, Protocol Buffers
+  and HCL.
 
 <!-- </block> -->
 
@@ -724,6 +798,135 @@ extension Config {
 
 <!-- </block> -->
 
+## Protocol Buffers
+
+<!-- <block name="proto-paths"> -->
+
+```protobuf
+syntax = "proto3";
+
+package shop.v1;
+
+option go_package = "shop/v1";
+
+message Item {
+  string name = 1;
+  map<string, int32> counts = 2;
+  enum Color {
+    COLOR_UNSPECIFIED = 0;
+    RED = 1;
+    BLUE = -2;
+  }
+  oneof price {
+    int64 cents = 3;
+  }
+}
+
+service Items {
+  rpc Get(Item) returns (Item);
+}
+```
+
+| Path                 | Points at                    |
+|----------------------|------------------------------|
+| `#/Item`             | the whole message            |
+| `#/Item/name`        | `1`                          |
+| `#/Item/counts`      | `2`                          |
+| `#/Item/Color`       | the whole enum               |
+| `#/Item/Color/RED`   | `1`                          |
+| `#/Item/Color/BLUE`  | `-2`                         |
+| `#/Item/price`       | the whole oneof              |
+| `#/Item/cents`       | `3`                          |
+| `#/Items/Get`        | the whole rpc                |
+
+- **Each message, enum and service is a symbol, at any depth, and so is each field, map field, oneof, enum value and
+  rpc in it.** A proto2 group, such as `optional group Result = 4 { ... }` in `Item`, is a symbol too, with its
+  fields under it: `#/Item/Result/code`. It has no value, though it has a number.
+- **The package is not part of a path.** A file has only one, so `#/Item` is enough.
+- **An enum value sits under its enum:** `#/Item/Color/RED`.
+- **A field's value is its number, and an enum value's value is its number.** Both stay as written: `0x3` stays `0x3`,
+  and `- 2` stays `- 2`. Options after the number don't change it: `BLUE = -2 [deprecated = true]` is `-2`.
+- **A oneof's fields sit in its message**, as code reads them: `#/Item/cents`, not `#/Item/price/cents`.
+- **An extension field sits where its `extend` is written**, not in the message it extends.
+  `extend Other { int32 tag = 100; }` at the top of the file gives `#/tag`, and inside `Item` it gives `#/Item/tag`.
+- **A definition covers its whole statement**, with its label, its options and its `;`, but not the comments above it.
+- **Options are not symbols**, and neither are `syntax`, `package`, `import`, `extend` blocks, `reserved` and
+  `extensions`. To check an option such as `go_package`, wrap it in a `[[block]]` entry with a `target-pattern`.
+- **A syntax error stops the run for the definition that holds it, and for each message around it.** The other
+  definitions still resolve.
+
+<!-- </block> -->
+
+## HCL
+
+Terraform, OpenTofu, Terragrunt, Nomad and Packer files are HCL.
+
+<!-- <block name="hcl-paths"> -->
+
+```hcl
+terraform {
+  required_providers {
+    aws = {
+      source  = "hashicorp/aws"
+      version = "~> 5.0"
+    }
+  }
+}
+
+variable "region" {
+  default = "us-east-1"
+}
+
+locals {
+  name = "app-${var.env}"
+  tags = { Team = "core", "cost center" = 42 }
+}
+
+resource "aws_instance" "web" {
+  ami       = data.aws_ami.ubuntu.id
+  count     = (3)
+  user_data = <<-EOT
+    #!/bin/sh
+    echo hi
+  EOT
+}
+```
+
+| Path                                         | Points at                                 |
+|----------------------------------------------|-------------------------------------------|
+| `#/terraform/required_providers/aws/version` | `~> 5.0`                                  |
+| `#/variable/region`                          | the whole block                           |
+| `#/variable/region/default`                  | `us-east-1`                               |
+| `#/locals/name`                              | `"app-${var.env}"`, as written            |
+| `#/locals/tags`                              | the whole object, as written              |
+| `#/locals/tags/cost center`                  | `42`                                      |
+| `#/resource/aws_instance/web/ami`            | `data.aws_ami.ubuntu.id`                  |
+| `#/resource/aws_instance/web/count`          | `3`                                       |
+| `#/resource/aws_instance/web/user_data`      | `#!/bin/sh` and `echo hi`, each on a line |
+
+- **Each block is a symbol, at any depth, and so is each attribute and each key of an object.** A block's path is its
+  type, then each of its labels: `#/resource/aws_instance/web`. In a `.tfvars` file, each attribute sits at the top:
+  `#/region`.
+- **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.
+- **A label or key with an escape, such as `"a\"b"`, gives no symbol**, and neither does anything under it.
+- **A value is the expression as written**, without parentheses around it: `count = (3)` is `3`.
+- **Strings follow HCL's escapes.** `"caf\u00e9"` is `café`, `$${` is `${`, and `%%{` is `%{`. A heredoc is its text,
+  with each line end. A `<<-` heredoc loses the indent that HCL removes. A string or heredoc with `${...}` or `%{...}`
+  stays as written. blockwatch doesn't turn text into Unicode NFC, as HCL does. A path to an escape that stands for no
+  character, such as `"\uD800"`, stops the run.
+- **A block covers its type, labels and body.** An attribute or a key covers its name and its value. Comments above
+  them are not part of them.
+- **A syntax error stops the run for the definition that holds it, and for each block around it.** After an error, the
+  parser can read the rest of the file wrongly, so a later path may not resolve.
+
+<!-- </block> -->
+
 ---
 
 [← Return to README](../README.md)

{blockwatch_cli-0.16.4 → 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.4'],
+    install_requires=['blockwatch-cli==0.16.6'],
     # </block>
     # Without it, setuptools takes the directories under src/ for Python packages.
     packages=[],

{blockwatch_cli-0.16.4 → blockwatch_cli-0.16.6}/src/blocks.rs

@@ -899,6 +899,10 @@ mod supported_languages_tests {
                 "tofu.tofu".to_string(),
                 "# <block>\nregion = \"eu-central-1\"\n# </block>".to_string(),
             ),
+            (
+                "nomad.nomad".to_string(),
+                "# <block>\ndatacenters = [\"dc1\"]\n# </block>".to_string(),
+            ),
             (
                 "htm.htm".to_string(),
                 "<!-- <block> -->\n<div>Content</div>\n<!-- </block> -->".to_string(),

{blockwatch_cli-0.16.4 → blockwatch_cli-0.16.6}/src/language_parsers/c.rs

@@ -45,6 +45,7 @@ impl SymbolsParser for CSymbolsParser {
             &definitions,
             &decode_string,
             None,
+            &[],
         ))
     }
 }
@@ -163,12 +164,7 @@ fn top_level_definitions<'tree>(
         }
         "alias_declaration" => node
             .child_by_field_name("name")
-            .map(|name| Definition {
-                parents: Vec::new(),
-                names: vec![name],
-                range: start..node.end_byte(),
-                value: None,
-            })
+            .map(|name| Definition::new(Vec::new(), name, start..node.end_byte(), None))
             .into_iter()
             .collect(),
         _ => Vec::new(),
@@ -208,16 +204,12 @@ fn declaration_definitions(declaration: Node<'_>, start: usize) -> Vec<Definitio
         if value.is_none() && (is_function || is_extern) {
             continue;
         }
-        definitions.push(Definition {
-            parents: Vec::new(),
-            names: vec![name],
-            range: if alone {
-                start..declaration.end_byte()
-            } else {
-                declarator.byte_range()
-            },
-            value: value.map(Value::Initializer),
-        });
+        let range = if alone {
+            start..declaration.end_byte()
+        } else {
+            declarator.byte_range()
+        };
+        definitions.push(Definition::new(Vec::new(), name, range, value));
     }
     definitions
 }
@@ -264,24 +256,19 @@ fn typedef_definitions<'tree>(
 /// identifier, such as `Foo::bar` or `operator==`.
 fn function_definition(function: Node<'_>, start: usize) -> Option<Definition<'_>> {
     let (name, _) = declared_name(function.child_by_field_name("declarator")?)?;
-    Some(Definition {
-        parents: Vec::new(),
-        names: vec![name],
-        range: start..function.end_byte(),
-        value: None,
-    })
+    Some(Definition::new(
+        Vec::new(),
+        name,
+        start..function.end_byte(),
+        None,
+    ))
 }
 
 /// The definitions of `specifier`, a struct, union, class or enum type that starts at `start`:
 /// the type's name when it has a body, and the enumerators of a plain `enum`.
 fn type_definitions(specifier: Node<'_>, start: usize) -> Vec<Definition<'_>> {
     let mut definitions: Vec<Definition> = defined_type_name(specifier)
-        .map(|name| Definition {
-            parents: Vec::new(),
-            names: vec![name],
-            range: start..specifier.end_byte(),
-            value: None,
-        })
+        .map(|name| Definition::new(Vec::new(), name, start..specifier.end_byte(), None))
         .into_iter()
         .collect();
     definitions.extend(enumerators(specifier));
@@ -312,14 +299,12 @@ fn enumerators(specifier: Node<'_>) -> Vec<Definition<'_>> {
     body.named_children(&mut cursor)
         .filter(|child| child.kind() == "enumerator")
         .filter_map(|enumerator| {
-            Some(Definition {
-                parents: Vec::new(),
-                names: vec![enumerator.child_by_field_name("name")?],
-                range: enumerator.byte_range(),
-                value: enumerator
-                    .child_by_field_name("value")
-                    .map(Value::Initializer),
-            })
+            Some(Definition::new(
+                Vec::new(),
+                enumerator.child_by_field_name("name")?,
+                enumerator.byte_range(),
+                enumerator.child_by_field_name("value"),
+            ))
         })
         .collect()
 }
@@ -464,7 +449,6 @@ fn macro_value<'tree>(
 /// Returns an error if an escape is not one C has, stands for no character, doesn't fit in a
 /// byte, or makes bytes that are not UTF-8 text.
 fn decode_string(node: &Node, source: &str) -> anyhow::Result<Option<String>> {
-    let mut cursor = node.walk();
     match node.kind() {
         "concatenated_string" => code::decode_concatenated(node, source, &decode_string),
         // The prefix and the opening quote make one token, such as `u8"`.
@@ -473,9 +457,7 @@ fn decode_string(node: &Node, source: &str) -> anyhow::Result<Option<String>> {
             _ => Ok(None),
         },
         "raw_string_literal" => match node.child(0).map(|open| open.kind()) {
-            Some("R\"" | "u8R\"") => Ok(node
-                .children(&mut cursor)
-                .find(|child| child.kind() == "raw_string_content")
+            Some("R\"" | "u8R\"") => Ok(code::child(*node, "raw_string_content")
                 .map(|content| node_text(&content, source).to_string())),
             _ => Ok(None),
         },