blockwatch-cli 0.16.7__tar.gz → 0.17.0__tar.gz

blockwatch_cli-0.17.0/.github/FUNDING.yml

@@ -0,0 +1,15 @@
+# These are supported funding model platforms
+
+github: mennanov # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+polar: # Replace with a single Polar username
+buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
+thanks_dev: # Replace with a single thanks.dev username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

{blockwatch_cli-0.16.7 → blockwatch_cli-0.17.0}/.markdownlint-cli2.yaml

@@ -21,6 +21,10 @@ config:
     # A shell command or a table row cannot be wrapped without changing what it means.
     code_blocks: false
     tables: false
+  MD010:
+    # A recipe line in a Makefile must start with a tab, so an example with spaces would not work.
+    ignore_code_languages:
+      - make
   MD024:
     # CHANGELOG.md follows Keep a Changelog, where every release repeats "Added" and "Fixed".
     # Requiring uniqueness only among headings sharing a parent still catches a real duplicate.

{blockwatch_cli-0.16.7 → blockwatch_cli-0.17.0}/AGENTS.md

@@ -226,11 +226,11 @@ The main modules:
   (`b/src/main.rs`), a path found in the walk and a `file:name` attribute all become a `RepoPath`. So the same file is
   always the same map key.
 - `src/language_parsers/` — one parser for each language, most of them a tree-sitter grammar. Markdown and MDX use
-  the `markdown` crate, and Lean has its own scanner. Each language has a `parser()` that returns a
-  `LanguageParser`, which knows which syntax nodes are comments. `src/block_parser.rs` turns those comments into
-  blocks. `language_parsers()` in `language_parsers/mod.rs` returns `LanguageParsers`: the parser of each extension.
-  Its `parser_for` picks the parser of a file, using the settings' extension mappings too. **To add a language, add a
-  module here and register it in that function.**
+  the `markdown` crate, Makefile uses the `makefile-lossless` crate, and Lean has its own scanner. Each language has
+  a `parser()` that returns a `LanguageParser`, which knows which syntax nodes are comments. `src/block_parser.rs`
+  turns those comments into blocks. `language_parsers()` in `language_parsers/mod.rs` returns `LanguageParsers`: the
+  parser of each extension. Its `parser_for` picks the parser of a file, using the settings' extension mappings too.
+  **To add a language, add a module here and register it in that function.**
 
   Some languages also have symbols. Such a language has a `SymbolsParser`, which its `parser()` passes to
   `.with_symbols(...)`:
@@ -239,6 +239,8 @@ The main modules:
   - 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.
+  - Makefile finds its symbols with `makefile-lossless`, the same crate that finds its comments. The crate is pinned to
+    one version. Its known bugs are listed in `docs/symbols.md`, not worked around.
 
   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

{blockwatch_cli-0.16.7 → blockwatch_cli-0.17.0}/CHANGELOG.md

@@ -12,6 +12,58 @@ Releases up to and including v0.3.11 predate this file. Their notes live on the
 
 ## [Unreleased] - ReleaseDate
 
+## [0.17.0] - 2026-11-06
+
+### Added
+
+- Symbols in Dart files (`.dart`). `config.dart#/Invoice/maxLines` points at a field of the class `Invoice`, and
+  `#/kApiVersion` at a variable at the top of the file. Each type is a symbol, and so is each field, method, getter,
+  setter, named constructor and enum value in it. A named extension's members sit under its name. See
+  [Dart](docs/symbols.md#dart).
+
+### Changed
+
+- In a tag that wraps over several comment lines, a longer marker such as `##`, `////` or `---` is now blanked whole,
+  in every language with `#`, `//` or `--` comments. So an attribute value that goes on to such a line loses the extra
+  characters. For example, in Python, a value that goes on to the line `##a` now holds `a` there, not `#a`. The same
+  goes for the stars at the start of a line in a `/* */` comment, such as ` ** `.
+
+### Fixed
+
+- A tag that wraps over several comment lines is no longer reported as malformed when each line starts with a longer
+  marker, such as `///`, `////`, `//!`, `##`, `---` or Python's `#:`. This works in every language with `//`, `#` or
+  `--` comments. In C and C++, it also works with Doxygen's `///<` and `//!<`. In Markdown, a tag can now wrap over
+  several `[//]: # (...)` lines too. In a `/* */` or OCaml `(* *)` comment, it can wrap over lines that start with
+  ` ** `.
+- In Bash and zsh files, a comment that starts with `#!` is no longer skipped, unless it is the shebang on the first
+  line. Before, a tag in such a comment was ignored.
+- A string value with one of these line ends now reads as its language reads it:
+  - In JavaScript and TypeScript, a backslash before U+2028 or U+2029 joins the two lines. Before, the value kept the
+    separator.
+  - In a JavaScript or TypeScript template, a lone `\r` line end is `\n`. Before, the value kept the `\r`.
+  - In a C++ raw string, a `\r\n` line end is `\n`. Before, the value kept the `\r`.
+
+## [0.16.8] - 2026-11-05
+
+### Added
+
+- Symbols in Makefiles (`Makefile`, `GNUmakefile`, `makefile`, `.mk` and `.mak`). `Makefile#/GO_VERSION` points at
+  the value of a variable, and `#/build` at the rule of a target. A value is read as GNU make reads it, without its
+  inline comment, and is never expanded. See [Makefile](docs/symbols.md#makefile).
+
+### Fixed
+
+- Some block tags in Makefile comments were not found, such as one after an assignment, as in `VERSION := 1.2 # ...`,
+  or one below a `(` that is not part of a reference. Now Makefiles are read with the `makefile-lossless` crate. A
+  comment that ends in `\` takes in the next line. A `#` after a rule's `;`, after a backslash, as in `\#`, or inside
+  `$(...)` doesn't start a comment.
+
+### Changed
+
+- A block tag in a Makefile is now found on a recipe line whose first character after the tab is `#`, and after any
+  `#` in a `define` body. Make reads no comment there, so these tags were not found before. See the known limits in
+  [Makefile](docs/symbols.md#makefile).
+
 ## [0.16.7] - 2026-11-04
 
 ### Added

{blockwatch_cli-0.16.7 → blockwatch_cli-0.17.0}/CLAUDE.md

@@ -226,11 +226,11 @@ The main modules:
   (`b/src/main.rs`), a path found in the walk and a `file:name` attribute all become a `RepoPath`. So the same file is
   always the same map key.
 - `src/language_parsers/` — one parser for each language, most of them a tree-sitter grammar. Markdown and MDX use
-  the `markdown` crate, and Lean has its own scanner. Each language has a `parser()` that returns a
-  `LanguageParser`, which knows which syntax nodes are comments. `src/block_parser.rs` turns those comments into
-  blocks. `language_parsers()` in `language_parsers/mod.rs` returns `LanguageParsers`: the parser of each extension.
-  Its `parser_for` picks the parser of a file, using the settings' extension mappings too. **To add a language, add a
-  module here and register it in that function.**
+  the `markdown` crate, Makefile uses the `makefile-lossless` crate, and Lean has its own scanner. Each language has
+  a `parser()` that returns a `LanguageParser`, which knows which syntax nodes are comments. `src/block_parser.rs`
+  turns those comments into blocks. `language_parsers()` in `language_parsers/mod.rs` returns `LanguageParsers`: the
+  parser of each extension. Its `parser_for` picks the parser of a file, using the settings' extension mappings too.
+  **To add a language, add a module here and register it in that function.**
 
   Some languages also have symbols. Such a language has a `SymbolsParser`, which its `parser()` passes to
   `.with_symbols(...)`:
@@ -239,6 +239,8 @@ The main modules:
   - 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.
+  - Makefile finds its symbols with `makefile-lossless`, the same crate that finds its comments. The crate is pinned to
+    one version. Its known bugs are listed in `docs/symbols.md`, not worked around.
 
   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

{blockwatch_cli-0.16.7 → blockwatch_cli-0.17.0}/Cargo.lock

@@ -274,7 +274,7 @@ checksum = "3ded4057c258ba199e2d26386d3af3780957ecaee6c4ef4041c6b4b8b97c0b06"
 
 [[package]]
 name = "blockwatch"
-version = "0.16.7"
+version = "0.17.0"
 dependencies = [
  "anyhow",
  "assert-json-diff",
@@ -289,6 +289,7 @@ dependencies = [
  "heck",
  "ignore",
  "libc",
+ "makefile-lossless",
  "markdown",
  "mlua",
  "percent-encoding",
@@ -326,7 +327,6 @@ dependencies = [
  "tree-sitter-json",
  "tree-sitter-kotlin-ng",
  "tree-sitter-lua",
- "tree-sitter-make",
  "tree-sitter-nix",
  "tree-sitter-ocaml",
  "tree-sitter-php",
@@ -491,6 +491,12 @@ version = "1.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "7f8f80099a98041a3d1622845c271458a2d73e688351bf3cb999266764b81d48"
 
+[[package]]
+name = "countme"
+version = "3.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7704b5fdd17b18ae31c4c1da5a2e0305a2bf17b5249300a9ee9ed7b72114c636"
+
 [[package]]
 name = "cpufeatures"
 version = "0.3.1"
@@ -861,6 +867,12 @@ dependencies = [
  "regex-syntax",
 ]
 
+[[package]]
+name = "hashbrown"
+version = "0.14.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e5274423e17b7c9fc20b6e7e208532f9b19825d82dfd615708b70edd83df41f1"
+
 [[package]]
 name = "hashbrown"
 version = "0.17.1"
@@ -1119,7 +1131,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "cc4e190f5d26ca7051642629da2c52fc03bde85a03197c99408dcd291734c855"
 dependencies = [
  "equivalent",
- "hashbrown",
+ "hashbrown 0.17.1",
 ]
 
 [[package]]
@@ -1274,6 +1286,15 @@ dependencies = [
  "which",
 ]
 
+[[package]]
+name = "makefile-lossless"
+version = "0.4.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "25a80f1e6bd18fe790d69cc1dda3eedaaa75bbd052a9734a137017056b5e1fa7"
+dependencies = [
+ "rowan",
+]
+
 [[package]]
 name = "markdown"
 version = "1.0.0"
@@ -1341,7 +1362,7 @@ dependencies = [
  "mlua-sys",
  "num-traits",
  "parking_lot",
- "rustc-hash",
+ "rustc-hash 2.1.3",
 ]
 
 [[package]]
@@ -1535,7 +1556,7 @@ dependencies = [
  "pin-project-lite",
  "quinn-proto",
  "quinn-udp",
- "rustc-hash",
+ "rustc-hash 2.1.3",
  "rustls",
  "socket2",
  "thiserror",
@@ -1557,7 +1578,7 @@ dependencies = [
  "rand 0.10.3",
  "rand_pcg",
  "ring",
- "rustc-hash",
+ "rustc-hash 2.1.3",
  "rustls",
  "rustls-pki-types",
  "slab",
@@ -1751,6 +1772,24 @@ dependencies = [
  "windows-sys 0.52.0",
 ]
 
+[[package]]
+name = "rowan"
+version = "0.16.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "417a3a9f582e349834051b8a10c8d71ca88da4211e4093528e36b9845f6b5f21"
+dependencies = [
+ "countme",
+ "hashbrown 0.14.5",
+ "rustc-hash 1.1.0",
+ "text-size",
+]
+
+[[package]]
+name = "rustc-hash"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "08d43f7aa6b08d49f382cde6a7982047c3426db949b1424bc4b7ec9ae12c6ce2"
+
 [[package]]
 name = "rustc-hash"
 version = "2.1.3"
@@ -2183,6 +2222,12 @@ version = "0.5.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "8f50febec83f5ee1df3015341d8bd429f2d1cc62bcba7ea2076759d315084683"
 
+[[package]]
+name = "text-size"
+version = "1.1.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f18aa187839b2bdb1ad2fa35ead8c4c2976b64e4363c386d45ac0f7ee85c9233"
+
 [[package]]
 name = "thiserror"
 version = "2.0.21"
@@ -2602,16 +2647,6 @@ dependencies = [
  "tree-sitter-language",
 ]
 
-[[package]]
-name = "tree-sitter-make"
-version = "1.1.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c5998dc7cbcbdab19fae8aefef982bf2d6544513d8d2e69cc44aec4c63810104"
-dependencies = [
- "cc",
- "tree-sitter-language",
-]
-
 [[package]]
 name = "tree-sitter-nix"
 version = "0.3.0"

{blockwatch_cli-0.16.7 → blockwatch_cli-0.17.0}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "blockwatch"
-version = "0.16.7"
+version = "0.17.0"
 edition = "2024"
 repository = "https://github.com/mennanov/blockwatch"
 description = "Language agnostic linter that keeps your code and documentation in sync and valid"
@@ -25,6 +25,8 @@ fnv = "1.0"
 globset = "0.4.18"
 heck = "0.5"
 ignore = "0.4"
+# Pinned exactly: a new version can change which symbols and comments a Makefile has.
+makefile-lossless = "=0.4.8"
 markdown = "1.0.0"
 mlua = { version = "0.12.0", features = ["lua54", "vendored", "async", "send"] }
 percent-encoding = "2.3"
@@ -61,7 +63,6 @@ tree-sitter-javascript = "0.25"
 tree-sitter-json = "0.24.8"
 tree-sitter-kotlin-ng = "1.1"
 tree-sitter-lua = "0.5"
-tree-sitter-make = "1.1"
 tree-sitter-nix = "0.3.0"
 tree-sitter-ocaml = "0.26"
 tree-sitter-php = "0.25"

{blockwatch_cli-0.16.7 → blockwatch_cli-0.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blockwatch-cli
-Version: 0.16.7
+Version: 0.17.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.16.7 → blockwatch_cli-0.17.0}/README.md

@@ -90,9 +90,10 @@ Two validators work across files:
 
 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, 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, Swift or PHP file, a variable in a shell script, 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.
+Python, Rust, TypeScript, JavaScript, Java, C#, Kotlin, Swift, PHP or Dart file, a variable in a shell script or a
+Makefile, 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"
@@ -220,7 +221,7 @@ exclusions, and custom extension mappings.
 
 ```yaml
 - repo: https://github.com/mennanov/blockwatch
-  rev: v0.16.7  # Use latest release
+  rev: v0.17.0  # Use latest release
   hooks:
     - id: blockwatch
 ```
@@ -260,7 +261,7 @@ For plain git hooks, local pre-commit setups, and sandboxing untrusted Lua scrip
 - GraphQL (`.graphql`, `.graphqls`, `.gql`)
 - Groovy (with `.gradle` and `Jenkinsfile` support)
 - HCL (Terraform and OpenTofu: `.tf`, `.tfvars`, `.tofu`, `.hcl`; Nomad: `.nomad`)
-- HTML (with `.xhtml` support)
+- HTML (with `.xhtml` support; comments inside `<script>` and `<style>` are not read)
 - JSON (`.json`, `.jsonc`, `.webmanifest`)
 - Java
 - JavaScript (with `.mjs` and `.cjs` support)
@@ -272,7 +273,7 @@ For plain git hooks, local pre-commit setups, and sandboxing untrusted Lua scrip
 - Markdown
 - Nix
 - OCaml (`.ml`, `.mli`)
-- PHP
+- PHP (comments inside `<script>` and `<style>` are not read)
 - Protocol Buffers (`.proto`)
 - Python (with `.pyi` and `.pyw` support)
 - Ruby (with `Gemfile`, `Rakefile`, `Podfile`, `Brewfile`, `Fastfile`, `Vagrantfile`, `.gemspec`, `.podspec`, `.rake`,

{blockwatch_cli-0.16.7 → blockwatch_cli-0.17.0}/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.7  # Use latest release
+  rev: v0.17.0  # 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.7  # Use latest release
+  rev: v0.17.0  # Use latest release
   hooks:
     - id: blockwatch-commit-msg
 ```

{blockwatch_cli-0.16.7 → blockwatch_cli-0.17.0}/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.7",
-          "semanticVersion": "0.16.7",
+          "version": "0.17.0",
+          "semanticVersion": "0.17.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.16.7/docs/validators/keep-sorted.md"
+              "helpUri": "https://github.com/mennanov/blockwatch/blob/v0.17.0/docs/validators/keep-sorted.md"
             }
           ]
         }

{blockwatch_cli-0.16.7 → blockwatch_cli-0.17.0}/docs/symbols.md

@@ -46,6 +46,8 @@ declares, instead of tags in a comment.
 | HCL (Terraform)  | `.tf`, `.tofu`, `.tfvars`, `.hcl`, `.nomad`                                                                 | [HCL](#hcl)                                             |
 | PHP              | `.php`, `.phtml`                                                                                            | [PHP](#php)                                             |
 | Shell            | `.sh`, `.bash`, `.bashrc`, `.bash_profile`, `.envrc`                                                        | [Shell](#shell)                                         |
+| Makefile         | `Makefile`, `GNUmakefile`, `makefile`, `.mk`, `.mak`                                                        | [Makefile](#makefile)                                   |
+| Dart             | `.dart`                                                                                                     | [Dart](#dart)                                           |
 
 <!-- </block> -->
 
@@ -326,8 +328,8 @@ is `@` and its name, under its element:
 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, Swift, Protocol
-Buffers and PHP, 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`.
+Buffers, PHP and Dart, 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.
@@ -342,7 +344,7 @@ HCL, each block, attribute and object key is a symbol: `main.tf#/variable/region
   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, Swift, Protocol Buffers,
-  HCL and PHP.
+  HCL, PHP and Dart.
 
 <!-- </block> -->
 
@@ -423,7 +425,7 @@ int helper(void) { return 0; }
 - **Prototypes and `extern` variables are not symbols.** The definition is.
 - **`template <...>` and `extern "C"` are part of the definition.** The contents of `extern "C" { ... }` are top-level.
 - **Strings follow C's escapes, and strings written one after the other are joined.** A raw string, `R"(...)"`, is its
-  text. `L`, `u` and `U` strings and character literals stay as written.
+  text, with each `\r\n` line end read as `\n`. `L`, `u` and `U` strings and character literals stay as written.
 - **Namespaces, class members and names such as `Foo::bar` are not symbols yet.**
 
 <!-- </block> -->
@@ -1083,6 +1085,193 @@ done
 
 <!-- </block> -->
 
+## Makefile
+
+<!-- <block name="makefile-paths"> -->
+
+```make
+GO_VERSION := 1.22.5
+VERSION ?= $(shell git describe --tags)
+export IMAGE = ghcr.io/acme/app:$(VERSION)
+LINT := v2.10.1   # keep in sync with CI
+TARGETS = linux \
+          darwin
+CFLAGS += -O2
+
+ifeq ($(shell uname),Darwin)
+SED = gsed
+else
+SED = sed
+endif
+
+define BANNER
+Build $(VERSION)
+endef
+
+build: deps
+	go build ./...
+
+bin/app: $(SRC)
+	go build -o $@ .
+
+%.o: %.c
+	$(CC) -c $<
+
+.PHONY: build
+```
+
+| Path           | Points at                                         |
+|----------------|---------------------------------------------------|
+| `#/GO_VERSION` | `1.22.5`                                          |
+| `#/VERSION`    | `$(shell git describe --tags)`, as written        |
+| `#/IMAGE`      | `ghcr.io/acme/app:$(VERSION)`, as written         |
+| `#/LINT`       | `v2.10.1`, without the comment                    |
+| `#/TARGETS`    | `linux darwin`                                    |
+| `#/CFLAGS`     | not found, as `+=` adds to a name                 |
+| `#/SED`        | a violation, as both branches set it              |
+| `#/BANNER`     | `Build $(VERSION)`                                |
+| `#/build`      | the whole rule: the target line and the recipe    |
+| `#/bin~1app`   | the whole rule                                    |
+| `#/%25.o`      | not found, as a pattern rule is not a symbol      |
+| `#/.PHONY`     | not found, as a special target is not a symbol    |
+
+- **A variable or a target set at the top or in a conditional is a symbol.** Every branch of `ifeq`, `ifneq`,
+  `ifdef` and `ifndef` counts, at any depth. So a name set in two branches is defined twice. Variables and targets
+  share one set of names, so a variable and a target with the same name are defined twice too.
+- **Every assignment but `+=` sets a name:** `=`, `:=`, `::=`, `:::=`, `?=` and `!=`, with any of `export`,
+  `override` and `private` in front. So does `define NAME` ... `endef`, with the same keywords and operators.
+  `X ?= 1` next to `X = 2` is defined twice too.
+- **A target covers its whole rule.** In `a b: c`, both `a` and `b` cover the whole rule. A target in two rules is
+  defined twice, even with `::`. Write each `/` in a target as `~1`: `bin/app` is `#/bin~1app`.
+- **A rule ends at its last recipe line.** It takes in a conditional below it when a branch of the conditional starts
+  with a recipe line, since make could read that branch. A rule in a branch of a conditional ends with that branch,
+  since a path can't tell which branch make reads.
+- **A line that starts with a tab is a recipe line only in a rule, as in make.** It is one when the last statement
+  above it, apart from conditionals, comments and other recipe lines, is a rule. Each branch of a conditional starts
+  from the statements above the conditional. After `endif`, a tab line is a recipe line when any branch ended in a
+  rule. Anywhere else, an assignment on such a line sets a name, such as `CC = clang` after a tab, and a `#` on it
+  starts a comment. After `.RECIPEPREFIX = >`, a recipe line starts with `>` in place of a tab.
+- **These are not symbols:** `NAME += value`, a target-specific variable such as `build: NAME = x`, `export NAME`
+  without a value, a computed name such as `$(PKG)_VERSION = 1` or `$(BIN):`, a pattern rule such as `%.o`, a suffix
+  rule, and a special target. A suffix rule, such as `.c.o`, is the old way to write `%.o: %.c`. Its target is one or
+  two of the suffixes that make knows, such as `.c`, `.o` or `.sh`, and it has no prerequisites. So
+  `.sh: install.txt` is a symbol. A special target is `.` followed by only capital letters and `_`, such as
+  `.PHONY`. So `.venv` and `.coverage` are symbols. The files that `include` reads are not searched. A path into
+  such a file works.
+- **A value is read as GNU make reads it, but it is never expanded:**
+  - A `#` starts a comment, which is not part of the value. `\#` gives `#`.
+  - A `\` at the end of a line joins the next line, with one space between them. The white space after the operator
+    is left out, even when the value starts on the next line, as in `SRCS = \`.
+  - `$(...)`, `${...}` and `$$` stay as written, with any `#` in them.
+  - The white space at the end is left out. GNU make keeps it, but a `same-as` check would fail on spaces no one
+    can see.
+  - `X != cmd` gives `cmd`. The command is not run.
+  - A `define` body keeps its comments and its `\#`, as make does.
+  - `X =` gives the empty string.
+  - A carriage return before a line feed is left out, as make does.
+- **A line that make joins to a statement is part of it.** So it sets no name:
+  - After a comment that ends in `\`, the next line is part of the comment.
+  - In `A = a$\` with `B = 1` on the next line, `#/A` gives `a$ B = 1`, and `#/B` is not found.
+  - The lines of a `define` body are part of it, up to the `endef` that make matches to it. A `define` inside it
+    needs its own `endef`, and an `endef` after a tab doesn't count.
+- **BSD make's own lines, such as `.if` and `.include`, set nothing.** An assignment between `.if` and `.endif`
+  sets its name, as anywhere else.
+- **A file that make stops on stops the run:** one with a `define` without `endef`, a conditional without `endif`,
+  an `else` or `endif` outside a conditional, a second `else` in one conditional, or an `ifeq` without its arguments.
+  The message shows the line. For a missing `endif`, that is the end of the file, as in make's own message.
+
+<!-- <block name="makefile-nesting"> -->
+
+- **A file nested more than 128 levels deep stops the run too,** with conditionals or with `$(...)` references.
+  Make reads it, but the `makefile-lossless` crate skips the conditionals nested deeper, so a name set in them would
+  be missing.
+
+<!-- </block> -->
+
+- **Known limits.** blockwatch reads Makefiles with the `makefile-lossless` crate, and keeps what it finds:
+  - A rule takes in the comment lines after its last recipe line. In `test:`, a recipe line, then `# Tools.`, `#/test`
+    covers `# Tools.`. So editing that comment counts as a change to `#/test`.
+  - In a `define` body, a line that starts with a tab keeps a `\` at its end, and the line end after it. Make joins
+    the two lines with one space.
+  - A line that make stops on can give targets. `a b = 6` gives `#/a` and `#/b`, and `= 7` gives `#/7`. Make stops
+    on them with "missing separator" and "empty variable name".
+  - A comment is found on a recipe line whose first character after the tab is `#`, and after any `#` in a `define`
+    body. So a block tag there is found. Make passes these lines on as they are, without reading a comment.
+  - In `lint: N = x;y # value`, `# value` is read as a comment. Make keeps it in the value that `N` has for `lint`.
+  - In `D = a$# b`, the `#` and the text after it are read as comments, and `#/D` gives `a$#`. Make reads `$#` as a
+    variable reference, so the line has no comment, and the value is `a$# b`.
+
+<!-- </block> -->
+
+## Dart
+
+<!-- <block name="dart-paths"> -->
+
+```dart
+const kApiVersion = '2.1.0';
+int retries = 3, timeout = 30;
+String get greeting => 'hi';
+
+class Invoice {
+  static const int maxLines = 20 * 1024;
+  final int id;
+
+  Invoice(this.id);
+  Invoice.draft() : id = 0;
+
+  int get total => _total;
+  set total(int v) => _total = v;
+  void send() {}
+}
+
+enum Mode { light, dark('d'); const Mode([this.code]); final String? code; }
+
+extension StringX on String { bool get isBlank => trim().isEmpty; }
+```
+
+| Path                 | Points at                                         |
+|----------------------|---------------------------------------------------|
+| `#/kApiVersion`      | `2.1.0`                                           |
+| `#/retries`          | `3`                                               |
+| `#/greeting`         | `hi`                                              |
+| `#/Invoice`          | the whole class                                   |
+| `#/Invoice/maxLines` | `20 * 1024`                                       |
+| `#/Invoice/id`       | `final int id;`, as it has no value               |
+| `#/Invoice/draft`    | the whole constructor                             |
+| `#/Invoice/total`    | a violation, as a getter and a setter share it    |
+| `#/Invoice/send`     | the whole method                                  |
+| `#/Mode/dark`        | `dark('d')`, as an enum value has no value        |
+| `#/Mode/code`        | `final String? code;`                             |
+| `#/StringX/isBlank`  | `trim().isEmpty`                                  |
+
+- **Each top-level variable, function, getter, setter, type and type alias is a symbol, and so is each member of a
+  type**: a field, a method, a getter, a setter, a named constructor or an enum value. Classes, mixins, enums,
+  extensions and extension types are types. Dart has no nested types, so a path has at most two names:
+  `#/Mode/dark`.
+- **A named constructor is a symbol**, as code calls it by its name: `Invoice.draft()` is `#/Invoice/draft`. The
+  unnamed constructor is not, even when it is written `Invoice.new()`. The header of an extension type can declare a
+  named constructor and a field: `extension type Meters.from(double value)` gives `#/Meters/from` and
+  `#/Meters/value`.
+- **A named extension's members sit under its name**: `#/StringX/isBlank`. Two extensions of `String` in one file
+  don't clash. An extension without a name has no symbols.
+- **A getter and a setter with one name are defined twice**, and so are a named constructor and a field with one
+  name, such as `Button.disabled()` and `disabled`. Wrap the one you mean in a block instead.
+- **A variable's value is its initializer, and a getter's is the `v` of `=> v`.** A getter with a block body has no
+  value, and neither has a function, a method or a constructor.
+- **Annotations are part of a definition. Doc comments are not.** In `int a = 1, b = 2;`, each name covers only its
+  own part.
+- **The unnamed constructor, operators, `external` declarations, `library`, `import` and `part` directives, local
+  declarations and closures are not symbols.** A file with `part of` has its own symbols.
+- **Strings follow Dart's escapes.** `'caf\u{e9}'` is `café`. Adjacent strings, such as `'a' "b"`, are joined. A raw
+  string, such as `r'C:\new'`, has no escapes. A `'''` or `"""` string loses a first line that holds only spaces and
+  tabs. Each line end in a string is a line feed, unless a backslash comes before it. A string with `$name` or
+  `${...}` in any part stays as written. A path to a string that Dart rejects, such as `'\u{110000}'`, or to half of a
+  character, such as `'\u{D800}'`, stops the run.
+- **A syntax error stops the run for the member that holds it, and for the type around it.** The other members still
+  resolve.
+
+<!-- </block> -->
+
 ---
 
 [← Return to README](../README.md)

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