blockwatch 0.2.23

Language agnostic linter that keeps your code and documentation in sync and valid
Documentation

BlockWatch

Build Status codecov Crates.io Downloads

BlockWatch is a linter that keeps your code, documentation, and configuration in sync and enforces strict formatting and validation rules.

It helps you avoid broken docs and messy config files by enforcing rules directly in your comments. You can link code to documentation, auto-sort lists, ensure uniqueness, and even validate content with Regex, AI, or custom Lua scripts.

It works with almost any language (Rust, Python, JS, Go, Markdown, YAML, etc.) and can run on your entire repo or just your VCS diffs.

Features

  • Drift Detection: Link a block of code to its documentation. If you change the code but forget the docs, BlockWatch alerts you.
  • Strict Formatting: Enforce sorted lists (keep-sorted) and unique entries (keep-unique) so you don't have to nitpick in code reviews.
  • Content Validation: Check lines against Regex patterns (line-pattern) or enforce block size limits ( line-count).
  • AI Rules: Use natural language to validate code or text (e.g., "Must mention 'banana'").
  • Lua Scripting: Write custom validation logic in Lua scripts (check-lua).
  • Flexible: Run it on specific files, glob patterns, or just your unstaged changes.

Installation

Homebrew (macOS/Linux)

brew tap mennanov/blockwatch
brew install blockwatch

From Source (Rust)

cargo install blockwatch

Prebuilt Binaries

Check the Releases page for prebuilt binaries.

Quick start example

  1. Add a special block tag in the comments in any supported file (See Supported Languages) like this:

    user_ids = [
    # <block keep-sorted keep-unique>
    "cherry",
    "apple",
    "apple",
    "banana",
    # </block>
]

  2. Run blockwatch:

    blockwatch

    BlockWatch will fail and tell you that the list is not sorted and has duplicate entries.

  3. Fix the order and uniqueness:

    user_ids = [
    # <block keep-sorted keep-unique>
    "apple",
    "banana",
    "cherry",
    # </block>
]

  4. Run blockwatch again:

    blockwatch

    Now it passes!

How It Works

You define rules using HTML-like tags inside your comments.

Linking Code Blocks (affects)

This ensures that if you change some block of code, you're forced to look at the other blocks too.

src/lib.rs:

// <block affects="README.html:supported-langs">
pub enum Language {
    Rust,
    Python,
}
// </block>

README.html:

<!-- <block name="supported-langs"> -->
<ul>
    <li>Rust</li>
    <li>Python</li>
</ul>
<!-- </block> -->

If you modify the enum in src/lib.rs, BlockWatch will fail until you touch the corresponding block supported-langs in README.html as well.

Enforce Sort Order (keep-sorted)

Keep lists alphabetized. Default is asc (ascending).

# <block keep-sorted>
"apple",
"banana",
"cherry",
# </block>

If the list is not sorted alphabetically, BlockWatch will fail until you fix the order.

Sort by Regex

You can sort by a specific part of the line using a regex capture group named value.

items = [
    # <block keep-sorted="asc" keep-sorted-pattern="id: (?P<value>\d+)">
    "id: 1  apple",
    "id: 2  banana",
    "id: 10 orange",
    # </block>
]

Numeric Sort (keep-sorted-format)

By default, values are compared lexicographically (as strings). This means "10" sorts before "2" because "1" < "2" character-by-character. Use keep-sorted-format="numeric" to compare values as numbers instead.

numbers = [
    # <block keep-sorted keep-sorted-format="numeric">
    2
    10
    20
    # </block>
]

This works with keep-sorted-pattern to extract numeric values from lines with mixed content:

items = [
    # <block keep-sorted keep-sorted-format="numeric" keep-sorted-pattern="id: (?P<value>\d+)">
    "id: 2  banana",
    "id: 10 orange",
    "id: 20 apple",
    # </block>
]

Without keep-sorted-format="numeric", the example above would fail because "10" is lexicographically less than "2".

Enforce Unique Lines (keep-unique)

Prevent duplicates in a list.

# <block keep-unique>
"user_1",
"user_2",
"user_3",
# </block>

Uniqueness by Regex

Just like sorting, you can check uniqueness based on a specific regex match.

ids = [
    # <block keep-unique="^ID:(?P<value>\d+)">
    "ID:1 Alice",
    "ID:2 Bob",
    "ID:1 Carol",  # Violation: ID:1 is already used
    # </block>
]

Regex Validation (line-pattern)

Ensure every line matches a specific regex pattern.

slugs = [
    # <block line-pattern="^[a-z0-9-]+$">
    "valid-slug",
    "another-one",
    # </block>
]

Enforce Line Count (line-count)

Enforce the number of lines in a block. Supported operators: <, >, <=, >=, ==.

# <block line-count="<=5">
"a",
"b",
"c"
# </block>

Validate with AI (check-ai)

Use an LLM to validate logic or style.

<!-- <block check-ai="Must mention the company name 'Acme Corp'"> -->
<p>Welcome to Acme Corp!</p>
<!-- </block> -->

Targeted AI Checks

Use check-ai-pattern to send only specific parts of the text to the LLM.

prices = [
    # <block check-ai="Prices must be under $100" check-ai-pattern="\$(?P<value>\d+)">
    "Item A: $50",
    "Item B: $150",  # Violation
    # </block>
]

Supported environment variables

  • BLOCKWATCH_AI_API_KEY: API Key.
  • BLOCKWATCH_AI_MODEL: Model name (default: gpt-5-nano).
  • BLOCKWATCH_AI_API_URL: Custom OpenAI compatible API URL (optional).

Validate with Lua Scripts (check-lua)

Run custom validation logic using a Lua script. The script must define a global validate(ctx, content) function that returns nil if validation passes or a string error message if it fails.

colors = [
    # <block check-lua="scripts/validate_colors.lua">
    'red',
    'green',
    'blue',
    # </block>
]

scripts/validate_colors.lua:

function validate(ctx, content)
    if content:find("purple") then
        return "purple is not an allowed color"
    end
    return nil
end

The validate function receives two arguments:

  • ctx — a table with the following fields:
    • ctx.file — the source file path.
    • ctx.line — the line number of the block's start tag.
    • ctx.attrs — a table of all block attributes.
  • content — the trimmed text content of the block.

Lua safety mode

By default, Lua scripts run in a sandboxed mode with only the coroutine, table, string, utf8, and math standard libraries available. The io, os, and package libraries are not loaded, preventing file system access, command execution, and loading of external modules.

You can change the security level by setting the BLOCKWATCH_LUA_MODE environment variable:

# Allow IO and OS libraries (memory-safe, but with file/system access)
BLOCKWATCH_LUA_MODE=safe blockwatch

# Allow all libraries including C module loading (unsafe)
BLOCKWATCH_LUA_MODE=unsafe blockwatch
BLOCKWATCH_LUA_MODE Libraries available Security Level
sandboxed (default) coroutine, table, string, utf8, math Most secure - No file/OS access
safe All memory-safe libraries (including io, os, package) Memory-safe - Allows file/OS access
unsafe All Lua standard libraries with no restrictions (including C modules) Unsafe - Full system access

Usage

Run Locally

Validate all blocks in your project:

# Check everything
blockwatch

# Check specific files
blockwatch "src/**/*.rs" "**/*.md"

# Ignore stuff
blockwatch "**/*.rs" --ignore "**/generated/**"

Tip: Glob patterns should be quoted to avoid shell expanding them.

Check Only What Changed

Pipe a git diff to BlockWatch to validate only the blocks you touched. This is perfect for pre-commit hooks.

# Check unstaged changes
git diff --patch | blockwatch

# Check staged changes
git diff --cached --patch | blockwatch

# Check changes in a specific file only
git diff --patch path/to/file | blockwatch

# Check changes and some other (possibly unchanged) files
git diff --patch | blockwatch "src/always_checked.rs" "**/*.md"

Listing Blocks

You can list all blocks that BlockWatch finds without running any validation. This is useful for auditing your blocks or debugging your configuration.

# List all blocks in the current directory
blockwatch list

# List blocks in specific files
blockwatch list "src/**/*.rs" "**/*.md"

# List only blocks affected by current changes
git diff | blockwatch list

The output is a JSON object.

Example Output

{
  "README.md": [
    {
      "name": "available-validators",
      "line": 18,
      "column": 10,
      "is_content_modified": false,
      "attributes": {
        "name": "available-validators"
      }
    }
  ]
}

CI Integration

Pre-commit Hook

Add this to .pre-commit-config.yaml:

- repo: local
  hooks:
    - id: blockwatch
      name: blockwatch
      entry: bash -c 'git diff --patch --cached --unified=0 | blockwatch'
      language: system
      stages: [ pre-commit ]
      pass_filenames: false

GitHub Action

Add this to .github/workflows/your_workflow.yml:

- uses: mennanov/blockwatch-action@v1

Supported Languages

BlockWatch supports comments in:

  • Bash
  • C#
  • C/C++
  • CSS
  • Go (with go.mod, go.sum and go.work support)
  • HTML
  • Java
  • JavaScript
  • Kotlin
  • Makefile
  • Markdown
  • PHP
  • Python
  • Ruby
  • Rust
  • SQL
  • Swift
  • TOML
  • TypeScript
  • XML
  • YAML

CLI Options

  • List Blocks: blockwatch list outputs a JSON report of all found blocks.
  • Extensions: Map custom extensions: blockwatch -E cxx=cpp
  • Disable Validators: blockwatch -d check-ai
  • Enable Validators: blockwatch -e keep-sorted
  • Ignore Files: blockwatch --ignore "**/generated/**"

Known Limitations

  • Deleted blocks are ignored.
  • Files with unsupported grammar are ignored.

Contributing

Contributions are welcome! A good place to start is by adding support for a new grammar.

Run Tests

cargo test