Skip to main content

Overview

Path Header Scanner Developer Guide

Contributor Guide

Extend language-aware path-header scanning while preserving preview-first and dry-run safety.

Commandmake check

Category

Development

Quick Command

setup -> focused change -> widening validation

Pythonpytestpre-commitscan safety

Contributor priorities​

Scanning is non-mutating by default. File updates require explicit --apply, while --dry-run must override every apply source. Contributors must preserve deterministic target resolution, language-aware syntax, exclusions, and clear valid, inserted, updated, and failed summaries.

Development Boundaries

CLI

Keep command parsing, argument resolution, and presentation under app/cli.

Scanner

Keep discovery, validation, processing, and updates under app/core/scan.

Languages

Keep header syntax and language-specific behavior under app/languages.

Safety

Test preview, --apply, configured apply, and --dry-run as distinct contracts using temporary files.

Quality workflow

Use the editable development installation, install the repository hook, run the smallest scanner or language test first, and finish with make check and the complete suite.