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

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

@@ -12,6 +12,23 @@ Releases up to and including v0.3.11 predate this file. Their notes live on the
 
 ## [Unreleased] - ReleaseDate
 
+## [0.16.7] - 2026-11-04
+
+### Added
+
+- Symbols in PHP files (`.php` and `.phtml`). `Invoice.php#/Invoice/STATUS_PAID` points at a class constant,
+  `#/Invoice/$perPage` at a property, and `version.php#/$wp_version` at a top-level variable. A
+  `define('NAME', value)` call is a symbol too, at `#/NAME`. The namespace is not part of a path. See
+  [PHP](docs/symbols.md#php).
+- Symbols in shell scripts (`.sh`, `.bash`, `.bashrc`, `.bash_profile` and `.envrc`). `install.sh#/GO_VERSION`
+  points at the value of a variable, and `#/log` at a function. A name counts when it is set outside functions, loops
+  and subshells. zsh files have no symbols. See [Shell](docs/symbols.md#shell).
+
+### Fixed
+
+- A Python or Starlark string with an escape that Python rejects, such as `"\x4"` or `"\N"`, gave its text as the
+  value. Now a path to it stops the run, as a path to a string with a `\N{...}` escape does.
+
 ## [0.16.6] - 2026-11-04
 
 ### Added

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

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

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

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

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

@@ -90,9 +90,9 @@ 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 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.
+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.
 
 <!-- <block name="available-validators"
      same-as="src/validators/mod.rs:validator-registry, docs/validators/README.md:validators-index"
@@ -220,7 +220,7 @@ exclusions, and custom extension mappings.
 
 ```yaml
 - repo: https://github.com/mennanov/blockwatch
-  rev: v0.16.6  # Use latest release
+  rev: v0.16.7  # Use latest release
   hooks:
     - id: blockwatch
 ```

{blockwatch_cli-0.16.6 → blockwatch_cli-0.16.7}/blockwatch.toml

@@ -50,4 +50,4 @@ same-as-pattern = '^\|\s*`(?P<value>[a-z-]+)`'
 [[block]]
 target = 'src/skill.md#/blockwatch/Symbols/Files with symbols'
 name = 'extensions-with-symbols'
-same-as-pattern = '`\.?(?P<value>[A-Za-z.]+)`'
+same-as-pattern = '`\.?(?P<value>[A-Za-z._]+)`'

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

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

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

@@ -22,7 +22,7 @@ declares, instead of tags in a comment.
 ## Files with symbols
 
 <!-- <block name="extensions-with-symbols" same-as="src/language_parsers/mod.rs:extensions-with-symbols"
-     same-as-pattern="`\.?(?P<value>[A-Za-z.]+)`"> -->
+     same-as-pattern="`\.?(?P<value>[A-Za-z._]+)`"> -->
 
 | Language         | Files                                                                                                       | Paths                                                   |
 |------------------|-------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|
@@ -44,6 +44,8 @@ declares, instead of tags in a comment.
 | Swift            | `.swift`                                                                                                    | [Swift](#swift)                                         |
 | Protocol Buffers | `.proto`                                                                                                    | [Protocol Buffers](#protocol-buffers)                   |
 | HCL (Terraform)  | `.tf`, `.tofu`, `.tfvars`, `.hcl`, `.nomad`                                                                 | [HCL](#hcl)                                             |
+| PHP              | `.php`, `.phtml`                                                                                            | [PHP](#php)                                             |
+| Shell            | `.sh`, `.bash`, `.bashrc`, `.bash_profile`, `.envrc`                                                        | [Shell](#shell)                                         |
 
 <!-- </block> -->
 
@@ -323,9 +325,9 @@ 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 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`.
+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`.
 
 - **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.
@@ -339,8 +341,8 @@ block, attribute and object key is a symbol: `main.tf#/variable/region/default`.
   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, Swift, Protocol Buffers
-  and HCL.
+- **Members are not symbols yet**, such as a method or a field, except in Java, C#, Kotlin, Swift, Protocol Buffers,
+  HCL and PHP.
 
 <!-- </block> -->
 
@@ -466,7 +468,8 @@ def load(path):
   value: `type Pair[T] = tuple[T, T]` is `#/Pair`.
 - **Strings follow Python's escapes.** `"\xe9"` is `é`. An escape Python doesn't know, such as `\d`, stays as written.
   A raw string is its text. An f-string without a field is its text, with `{{` as `{`. An f-string with a field and
-  bytes stay as written. A path to a string with a `\N{...}` escape stops the run.
+  bytes stay as written. A path to a string with a `\N{...}` escape stops the run, and so does a path to a string
+  with an escape that Python rejects, such as `"\x4"` or `"\N"`.
 - **Starlark files, such as `BUILD` and `.bzl`, follow the same rules.** A rule call, such as
   `cc_library(name = "lib")`, is not a symbol.
 - **Class members are not symbols yet.**
@@ -927,6 +930,159 @@ resource "aws_instance" "web" {
 
 <!-- </block> -->
 
+## PHP
+
+<!-- <block name="php-paths"> -->
+
+```php
+<?php
+namespace App\Billing;
+
+const MAX_RETRIES = 3;
+define('API_URL', 'https://api.example.com');
+$version = '2.4.1';
+
+if (!function_exists('money')) {
+    function money(int $cents): string { return number_format($cents / 100, 2); }
+}
+
+#[Entity]
+final class Invoice extends Model
+{
+    public const STATUS_PAID = 'paid';
+    protected static int $perPage = 25;
+    protected $table;
+
+    public function __construct(private readonly string $currency = "EUR") {}
+
+    public function table(): string { return $this->table; }
+}
+
+enum Status: string
+{
+    case Open = 'open';
+    case Paid = 'paid';
+}
+```
+
+| Path                    | Points at                                       |
+|-------------------------|-------------------------------------------------|
+| `#/MAX_RETRIES`         | `3`                                             |
+| `#/API_URL`             | `https://api.example.com`                       |
+| `#/$version`            | `2.4.1`                                         |
+| `#/money`               | the whole function                              |
+| `#/Invoice`             | the whole class, with `#[Entity]`               |
+| `#/Invoice/STATUS_PAID` | `paid`                                          |
+| `#/Invoice/$perPage`    | `25`                                            |
+| `#/Invoice/$table`      | `protected $table;`, as it has no default       |
+| `#/Invoice/$currency`   | `EUR`                                           |
+| `#/Invoice/table`       | the whole method                                |
+| `#/Status/Paid`         | `paid`                                          |
+| `#/App`                 | nothing, as a namespace is not a symbol         |
+
+- **Each top-level constant, variable, function, class, interface, trait and enum is a symbol, and so is each member
+  of a type**: a constant, a property, a method or an enum case. Both `const NAME = value;` and
+  `define('NAME', value);` define a constant.
+- **The namespace is not part of a path.** Two namespaces in one file that define one name make that path a
+  violation.
+- **A property and a variable keep their `$`**: `#/Invoice/$perPage`. So `$table` and `table()` have different paths.
+- **A top-level variable is a symbol**: `$version = '2.4.1';` is `#/$version`. Only `$name = value` counts, not
+  `$items['key'] = 1` or `$object->name = 1`. In `$a = $b = 1`, only `$a` is a symbol, and its value is `$b = 1`.
+- **A constructor parameter with a visibility is a property**: `private readonly string $currency` gives
+  `#/Invoice/$currency`. Its value is its default.
+- **A definition in an `if`, `else`, `try`, `catch`, `finally`, `switch`, `declare` or `{ }` block counts**, such as a
+  function in `if (!function_exists('money'))`. One in a loop doesn't. A name defined in both branches of an `if` is a
+  violation.
+- **Inside a function or a method, only a `define` is a symbol, and its path has no parent.** `define('BOOTED', 1);`
+  in the method `Kernel::boot()` gives `#/BOOTED`. Local variables, and functions and classes declared in a function,
+  are not symbols. Neither are closures, arrow functions and anonymous classes, or a `define` in them.
+- **A `define` counts only as a whole statement whose name is plain text.** It covers the statement, with its `;`.
+  `define($name, 1)`, `define('A\\', 1)`, `defined('X') or define('X', 1)` and a call with named arguments are not
+  symbols.
+- **Names compare as written.** PHP ignores the case of class, function and method names, but `#/MONEY` doesn't find
+  `function money`.
+- **Attributes are part of a definition. Doc comments are not.** In `const A = 1, B = 2;` and `public $a = 1, $b;`,
+  each name covers only its own part.
+- **`namespace`, `use` imports, trait uses and `declare(strict_types=1)` are not symbols.** A trait's members sit under
+  the trait, not under the classes that use it. The keys of an array, such as `return ['timezone' => 'UTC']` in a
+  Laravel config file, are not symbols yet.
+- **Strings follow PHP's escapes.** `'it\'s'` is `it's`, and `"caf\u{e9}"` is `café`. A heredoc or a nowdoc loses the
+  closing marker's indent on each line. A string with a variable, such as `"v$major"` or `"{$a}"`, stays as written.
+  So does a string whose bytes are not UTF-8, such as `"\xFF"`, and a string that PHP rejects.
+- **In a template, the symbols come from the PHP code.** The HTML around it is skipped.
+- **A syntax error stops the run for the definition that holds it, and for each type around it.** The other
+  definitions still resolve. The parser fails on a constructor parameter with `readonly` but no visibility, such as
+  `__construct(readonly int $id)`, so a path into its class stops the run.
+
+<!-- </block> -->
+
+## Shell
+
+<!-- <block name="shell-paths"> -->
+
+```bash
+#!/usr/bin/env bash
+GO_VERSION=1.22.5
+export REGISTRY='ghcr.io/acme'
+readonly IMAGE="${REGISTRY}/app:${GO_VERSION}"
+PORT="${PORT:-8080}"
+TARGETS=(linux darwin)
+
+if [[ "$(uname)" == Darwin ]]; then
+  SED=gsed
+else
+  SED=sed
+fi
+
+log() { echo "$@" >&2; }
+
+while [[ $# -gt 0 ]]; do
+  case "$1" in
+    --go) GO_VERSION="$2"; shift 2 ;;
+  esac
+done
+```
+
+| Path           | Points at                                            |
+|----------------|------------------------------------------------------|
+| `#/GO_VERSION` | `1.22.5`, as the copy in the loop doesn't count      |
+| `#/REGISTRY`   | `ghcr.io/acme`                                       |
+| `#/IMAGE`      | `"${REGISTRY}/app:${GO_VERSION}"`, as written        |
+| `#/PORT`       | `"${PORT:-8080}"`, as written                        |
+| `#/TARGETS`    | `(linux darwin)`, as written                         |
+| `#/SED`        | a violation, as both branches define it              |
+| `#/log`        | the whole function                                   |
+
+- **A variable or a function set outside functions, loops and subshells is a symbol.** The conditions and bodies of
+  `if`, the items of `case`, `{ ... }` groups and the commands of `&&` and `||` count. So a name set in two branches
+  is defined twice. Names set in `for`, `while` and `until` loops, in `( ... )`, in functions and in a statement that
+  ends with `&` don't count, as bash sets them in a subshell or each time the loop runs.
+- **`export`, `readonly`, `declare` and `typeset` set a name too**, with or without flags such as `-r`. When the
+  statement sets one name, the symbol covers the whole statement. In `export A=1 B=2`, `A` covers only `A=1`. The
+  value is still the one written: bash stores `abc` for `declare -l X=ABC` and `3` for `declare -i X=1+2`, but the
+  path gives `ABC` and `1+2`.
+- **These are not symbols:** `NAME+=value`, `A[0]=x`, `FOO=1 make` (it sets `FOO` only for `make`), `export NAME`
+  without `=`, `local`, `: "${NAME:=default}"`, and names set by `read`, `for` or `getopts`.
+- **Strings follow bash's quoting.** `'a b'` is `a b`. In `"..."`, only `\$`, `` \` ``, `\"` and `\\` lose their
+  backslash, and a `\` at the end of a line goes away with the line end. Outside quotes, every backslash goes:
+  `a\ b` is `a b`. Parts written together are joined: `"a"'b'c` is `abc`. `X=` is the empty string.
+- **A value that bash expands stays as written**, such as `$HOME`, `$(cmd)`, `` `cmd` `` or `~/bin`. So does a word
+  that starts with `~` after a quote, such as `"a"~/b`, and an array. Use `same-as-pattern` to take `8080` out of
+  `"${PORT:-8080}"`.
+- **A path to a `$'...'` or `$"..."` string stops the run.**
+- **A function's name can hold `-`, `.` and `:`.** Write each `:` as `%3A`: `ns::helper` is `#/ns%3A%3Ahelper`.
+- **zsh files (`.zsh`, `.zshrc`) have no symbols.** The parser misreads much of zsh's syntax.
+- **After a syntax error, the parser often skips a large part of the file**, and every name in that part stops the
+  run. It fails on `sed -e /^$/d`, on `${x/#$/y}`, and on a command whose name holds `::` after an assignment, such as
+  `V=2 ns::log "x"`. A comment in backticks, such as `` find . `# skip vendor` -name x ``, is worse: the parser reads
+  the rest of the file as the command's argument, so no name after it is found.
+- **A value outside quotes that goes on to the next line after a `\` is not found.** The parser reads `X=a\` and `b`
+  on the next line as `X=a` set only for a command `b`. Bash sets `X=ab`. Put the value in quotes instead.
+- **A value that ends with a lone `$` takes in the next line.** In `Z=$` followed by `W=1`, `#/Z` gives `$`, the line
+  end and `W=1`, as written, and `#/W` is not found. Bash sets `Z` to `$`. Write `Z='$'` instead.
+
+<!-- </block> -->
+
 ---
 
 [← Return to README](../README.md)

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