Шлюз соответствия
Шлюз соответствия Apothem — механическая часть пятнадцатипунктного шлюза предэмиссии (M1-M15), который должен пройти каждый выпускаемый артефакт.
Пятнадцать пунктов
| Пункт | ID | Мандат | Класс проверки | Сбой → действие |
|---|---|---|---|---|
| 1 | M1 | Агностицизм к проекту-хосту | Обоснованный | Пересмотреть для соответствия соглашениям хоста |
| 2 | M2 | Редакционная дисциплина (журнал раскрытия) | Обоснованный | Добавить маркеры раскрытия |
| 3 | M3 | Десять измерений качества | Механический + обоснованный | Пересмотреть по не прошедшим измерениям |
| 4 | M4 | Самоприменение (блок верификации присутствует) | Обоснованный | Записать блок верификации |
| 5 | M5 | Принцип авторитета (без выдуманных идентичности / конечной точки / секрета) | Механический | Направить на запрос |
| 6 | M6 | Внедрение экспертизы (выявленные пробелы) | Обоснованный | Выявить пробелы; процитировать уточнения |
| 7 | M7 | Аннотация вариантов (маркер Recommended + обоснование по драйверу) | Механический | Аннотировать наборы вариантов |
| 8 | M8 | Определённость (без уклончивости в предписывающей прозе) | Механический | Преобразовать уклончивые формулировки в условные конструкции |
| 9 | M9 | Визуальный рычаг (структурные темы сопровождаются диаграммами) | Механический + обоснованный | Создать / обновить диаграмму |
| 10 | M10 | Двунаправленное связывание (взаимные обратные указатели замкнуты) | Механический | Замкнуть полурёбра |
| 11 | M11 | Гибкие спринты (Цель / Бэклог / DoR / DoD / Ревью / Ретроспектива) | Обоснованный | Реструктурировать в виде спринтов |
| 12 | M12 | Отчётность по фазам и каноническая компоновка | Механический + обоснованный | Создать сводку; перенести в каноническую компоновку |
| 13 | M13 | Ремесло кода (линтер / форматирование / проверка типов; магические числа; bare-except) | Механический | Применить правила ремесла кода для каждого языка |
| 14 | M14 | Системность (объявляет вышестоящие / нижестоящие / равноправные / принуждающие элементы) | Механический + обоснованный | Объявить; проиндексировать в реестрах |
| 15 | M15 | Готовность к продакшену (тесты + документация + CHANGELOG + соответствующий коммит + зелёный CI + стабильность semver) | Механический + обоснованный | Добавить недостающие поверхности |
Шлюз запускает только машинно проверяемые валидаторы. Обоснованное суждение, которого требуют пункты класса «Обоснованный», и обоснованная часть каждого пункта класса «Механический + обоснованный» оцениваются в ходе ревью.
Шкала тяжести
У шлюза нет шкалы «Критический», «Важный» или «Рекомендательный» и нет порога в две находки. Без --strict (или APOTHEM_CONFORMITY_STRICT=1) шлюз сообщает о находках и завершается с кодом 0. С --strict проверка одного файла или хука завершается с кодом 2, если не проходит какой-либо сопоставитель, а запуск по всему корпусу (--all или --all-perwrite) завершается с кодом 2, если не проходит блокирующий валидатор или сопоставитель; рекомендательные находки только выводятся в отчёт. Установленный хук Write/Edit не передаёт --strict, поэтому он сообщает о находках и запись продолжается, если только APOTHEM_CONFORMITY_STRICT=1 не задана в его переменных окружения.
Валидаторы
Механическая часть находится в src/apothem/conformity/, а оркестрирует её src/apothem/conformity/gate.py.
Каждый валидатор запускается одним из трёх способов:
- per-write: при каждой ожидающей записи (
--hook) или для каждого отслеживаемого файла с--all-perwrite. - standalone: по всему репозиторию с
--allили по одному с--check <name>. - change-set: по проиндексированному diff, запускается напрямую как
python -m apothem.conformity.semver_stability_grep --staged, а не через шлюз.
Приведённая ниже таблица генерируется из модулей валидаторов.
The conformity package ships 54 validators: 22 per-write, 31 standalone and 1 change-set. The gate registers the per-write and standalone ones.
| Validator | Runs | Rule anchor | What it checks |
|---|---|---|---|
agent-capability-grep | standalone | agent-capability-discipline (per-harness capability matrix) | Verify every harness declares its agentic-capability matrix. |
agents-md-coverage-grep | standalone | rules/agents-md-convention.md | Flag stale agent-companion files under the root-only AGENTS.md convention. |
agnosticism-grep | standalone | rules/agnostic-posture.md §3 (harness neutrality) + §1 (default-off) | Flag harness bias and re-introduced enforcement presets in shipped surfaces. |
always-on-budget-grep | per-write | D1 token-budget-discipline §Always-on body budget | Body-budget conformity matcher for always-on rules. Pointed at a rules directory it also holds the loaded always-on set and the rule index to byte ceilings. |
bare-except-grep | per-write | M13.3 error handling | Flag bare except clauses without typed exceptions or re-raise. |
binding-five-direction-grep | standalone | M10 bidirectional-binding §1 (five-direction Bindings section) | Require the five-direction Bindings section on every rule, command, agent, and skill. |
binding-reciprocity-corpus-grep | standalone | M10 bidirectional-binding §2 (↔ self-reciprocal) | Cross-file binding-reciprocity corpus walk — the ↔-symmetric half-edge check. |
binding-reciprocity-grep | per-write | M10 bidirectional-binding §Notation | Flag binding declarations using non-canonical arrow notation. |
brand-mark-grep | per-write | rules/plain-language.md (brand-mark display/identifier casing) | Flag brand-mark display/identifier form drift on brand-touched surfaces. |
commented-out-code-grep | per-write | M13.1 why-not-what comments | Flag substantial commented-out code blocks left in source. |
completion-claim-grep | per-write | rules/session-closure.md (verifiable-close output honesty) | Flag unsupported completion / guarantee claims in cohort prose. |
conventional-commit-grep | standalone | CLAUDE.md Coding Conventions — Conventional Commits | Flag HEAD commit messages that drift from the Conventional-Commits grammar. |
copilot-instructions-presence-grep | per-write | — | GitHub Copilot surface presence check. |
cross-platform-matrix-grep | standalone | cross-platform OS x Python CI matrix | Verify CI declares a cross-platform OS x Python matrix. |
determinism-grep | standalone | rules/determinism.md | Prove every command and skill surface has a deterministic output shape. |
diagram-staleness-grep | per-write | M9 visual-leverage §Fidelity | Flag diagrams whose verification date is missing or stale. |
dynamism-grep | standalone | rules/dynamism.md (static-version embeds) | Flag static-string version embeds in dynamism-required surfaces. |
editorconfig-presence-grep | standalone | supply-chain SOTA-rigor §editorconfig | Verify a canonical .editorconfig is present at the project root. |
file-header-grep | per-write | — | Authorship-header presence and canonical-form check. |
freshness-token-grep | standalone | rules/freshness-facade.md | Flag freshness-narrative phrases on shipped public surfaces. |
frontmatter-grep | per-write | the per-class frontmatter JSON Schemas (src/apothem/schemas/) | Validate per-artifact-class YAML frontmatter against required-key sets. |
frontmatter-value-grep | standalone | per-class JSON Schema enum/pattern value constraints | Validate frontmatter VALUES against the per-class JSON Schema enum/pattern constraints. |
gate-evidence-grep | standalone | commands/plan-execute.md Gate evidence; rules/pre-emission-gate-bars.md section 2 (attestation schema) | Advisory: flag plan-suite gate claims that lack a command, an exit status or output, and a HEAD SHA beside them, and fifteen-bar attestations that omit a field of the rule's schema. |
gitattributes-presence-grep | standalone | supply-chain .gitattributes contract | Verify the repo-root .gitattributes carries the canonical contract. |
harden-runner-grep | standalone | harden-runner egress baseline | Verify every workflow job opens with a conformant harden-runner step. |
hedging-grep | per-write | M8 definitiveness §Hedging | Flag hedging vocabulary in prescriptive contexts. |
license-author-consistency-grep | per-write | — | LICENSE author-identity presence check. |
link-check | per-write | rules/code-craft-markdown.md §6 Link Discipline | Validate Markdown internal links against the on-disk reference graph. |
magic-number-grep | per-write | M13.10 magic numbers | Flag magic numbers in source code. |
multi-surface-coherence-grep | per-write | — | Shared-claim coherence across AI-conventions surfaces. |
naming-grep | standalone | CLAUDE.md Coding Conventions (kebab-case naming) | Validate filesystem paths against the canonical naming convention. |
no-global-plans-grep | standalone | CLAUDE.md Plans Discipline (no global plans) | Walk the git index for tracked plans paths; fail when found. |
no-toplevel-docs-grep | standalone | single-source-of-truth (docs live in site/, not root docs/) | Fail when a top-level docs/ directory exists at the repository root. |
oidc-trusted-publishing-grep | standalone | OIDC trusted publishing | Verify release workflows use OIDC trusted publishing. |
option-annotation-grep | per-write | M7 option-annotation (H6 per-option bind) | Enforce the per-option Recommended label-to-body bind (H6). |
orphan-output-grep | per-write | M12 canonical-layout + M14 systemicity | Flag artifacts emitted to non-canonical locations or without provenance. |
permissions-minimum-scope-grep | standalone | minimum-scope workflow permissions | Verify every GitHub Actions workflow declares a minimum-scope permissions: block. |
plain-language-grep | standalone | rules/plain-language.md — user-facing prose | Flag mechanistic / harness-internal vocabulary in user-facing prose. |
plan-next-step-consistency-grep | standalone | rules/recommend-next-step.md | Advisory: flag plan-suite infra files whose Recommended-Next-Step footer drifts from the suite's recorded next pipeline stage. |
plan-suite-structure-grep | standalone | context-management-scratch 2 (suite-locality + closed vocab) + canonical-layout-reporting-tiers 2.1 (numeric-prefix discipline) | Validate plan-suite structure: suite-locality, closed vocab, numeric prefix. |
plans-discipline-language-grep | standalone | CLAUDE.md Plans Discipline (multi-surface language) | Verify the canonical Plans Discipline language reaches every required surface. |
production-ready-pr-grep | per-write | M15 production-ready §Same-change-set | Flag commits whose change-set lacks the production-ready four-class shape. |
recommend-next-step-grep | standalone | rules/recommend-next-step.md | Verify every command file carries a ## Recommended Next Step block. |
redundancy-grep | standalone | rules/operational-mandates.md §CM-7 coherent-product non-redundancy | Flag substantively-duplicated paragraphs across the governed corpus. |
reference-token-grep | standalone | rules/own-voice-reimplementation.md | Flag leaked reference-platform branding tokens on authored surfaces. |
registry-capability-consistency-grep | standalone | rules/agent-capability-discipline.md — registry capability cells backed by evidence | Flag registry capability cells not backed by install / materializer / projection evidence. |
secret-leak-grep | per-write | M13.8 security + M15 production-ready | Block emission of artifacts containing hardcoded credentials. |
semver-stability-grep | change-set | M15 semver-stability | Semver stability matcher (M15 mechanical fraction). |
smoke-install-grep | standalone | production-ready section 8.1 paired install scripts | Smoke-test the paired install scripts at the repository root. |
static-version-grep | standalone | rules/dynamism.md §static-version-resolution | Verify version-bearing sites resolve dynamically, not as static literals. |
token-efficiency-grep | per-write | clean-room-generation §5 + token-efficiency-rewrite | Flag filler phrases, throat-clearing openers, and content-free qualifiers. |
unpinned-action-grep | per-write | M15 production-ready §Supply-chain | Flag GitHub Actions workflows that pin actions to mutable refs. |
user-confirm-grep | per-write | M5 authority-inquiry §10 | Block emission of artifacts containing unresolved authority placeholders. |
workflow-concurrency-grep | standalone | workflow concurrency + per-job timeouts | Enforce concurrency + per-job timeout discipline on GitHub workflows. |
Запуск шлюза
В установленном окружении шлюз запускается автоматически: settings.json
Claude Code подключает его как хук PreToolUse, который перед каждым Write/Edit
вызывает материализованную копию в ~/.claude/.apothem/support/conformity/gate.py.
Затем шлюз проверяет только записи в пределах области действия своего хука, а
запись вне этой области проходит молча; Запуск шлюза соответствия
перечисляет эту область. В чекауте исходного кода тот же код запускается через
модульную форму; перед каждой командой python ниже добавляйте PYTHONPATH=src.
По умолчанию шлюз рекомендательный: он сообщает о находках и завершается с кодом
0. Добавьте --strict, чтобы завершаться с кодом 2 при блокирующей находке.
Неизвестное имя валидатора приводит к завершению с кодом 3.
# Every standalone validator across the repository:
python -m apothem.conformity.gate --all .
# The same sweep, failing on a blocking finding (the CI form):
python -m apothem.conformity.gate --all --strict .
# Every per-write validator against every tracked file:
python -m apothem.conformity.gate --all-perwrite .
# One validator by name (names come from --list):
python -m apothem.conformity.gate --check naming-grep .
# List every registered validator as JSON:
python -m apothem.conformity.gate --list
# Single-file dispatch (mimics the PreToolUse hook):
echo '{"tool_input": {"file_path": "path/to/file", "content": "..."}}' \
| python -m apothem.conformity.gate --hookpython -m apothem.conformity.gate --help выводит краткую справку по использованию.
Полную процедуру см. в Запуск шлюза соответствия.
Справочник
- Реестр шлюза предэмиссии — канонические определения пунктов
- Реестр внешнего соответствия — подробная семантика M1-M15
- Сквозные мандаты — источник истины по мандатам
- Дисциплина производительности — бюджеты времени выполнения по классам
Проверка бинарных артефактов
Проверка бинарных артефактов Apothem — ноль скомпилированных / упакованных бинарников, отслеживаемых в исходном коде. Доказательство для проверки Binary-Artifacts в OpenSSF Scorecard.
Руководства по эксплуатации
Руководства по эксплуатации Apothem — пошаговые операционные процедуры для релизов, настройки издателя, включения Pages, восстановления и создания адаптеров.