Defame1297
620f20b0fd
Why The two audit skills carried 1,724 lines of byte-identical duplication: the ADR-0020 boundary resolver (1,061), vale-wrap.sh (526), the Vale style rules (44) and the Contributing-files parser (93). Nothing shared them — they were held in sync by a 413-line pre-push gate and its 797-line test suite. Sync-by-gate had already failed once: at484357athe two parser copies drifted into different spellings of the bullet loop while a docstring asserted they were identical. That drift was behaviour-neutral and was re-unified by hand at598a7c3, so the copies were identical at merge time — but nothing had caught it, and the next drift need not be neutral. Implementation Notes Self-containment binds BETWEEN skills, not within one. The agentskills.io spec forbids reaching across skill directories, which is why two separate skills needed embedded copies; two files inside ONE skill may source a third. That is the whole reason the merge removes duplication rather than relocating it. The union of both bodies measured 1,532 words against BODY_MAX_WORDS=900, and only 211 of those words were shared, so SKILL.md is a dispatch body. Step 0 resolves the flow from the target path before any validation, and its table mirrors validate.sh's detection exactly: a directory holding SKILL.md or a SKILL.md file (skill); a *.agent.md, or a .md directly under an agents/ directory (agent); anything else stops without running a validator. Steps 1-3 live in references/skill-flow.md and references/agent-flow.md, and gotchas that apply to one flow live in that flow's file, since it is loaded on every invocation anyway. If validate.sh reports on the other artifact type, the body restarts at Step 0. Named factory-audit rather than forge-audit because forge is a live skill, and a family prefix that matches a live sibling reads as ownership rather than membership. The description carries one arrow per boundary target, because ADR-0020 resolves only the first target after an arrow. It drops the quoted "audit this skill"-style phrases, which restated "audited" in a second register (ADR-0020's duplicate-register rule). 241 characters, Gotchas 16% of the body: no size SUGGESTIONs. The boundary resolver stays embedded in two files rather than imported: a cache-installed plugin cannot read outside its own directory, and the repo-root hook resolves via .pre-commit-hooks.yaml where entry[0] is the only token pre-commit rewrites, so no single file is reachable by both. tests/test-adr0020-contract.sh hashes both copies for byte-identity, and asserts validate.sh sources the resolver and that no third copy exists. The entry scripts classify the target from its resolved parent directory, so a bare agent filename typed inside agents/ works; resolve SCRIPT_DIR CDPATH-safely; and exit 2 when a lib-*.sh is missing, rather than dying with exit 1, the tier the flows relay as real findings. The provenance run functions stash their findings code in KYBERFORGE_PROV_RC and return 0, so validate-provenance.sh calls them UNTESTED. Testing a function's status (`f || RC=$?`) disables errexit for its entire body, and no subshell or `set -e` inside can re-arm it once the call sits in a condition context (measured, both spellings). Their error paths use `exit`, which is unaffected either way; this keeps errexit armed for anything added later. Case 0's readability guard reads the file instead of asking `[[ -r ]]`. `-r` is access(2), which answers yes for uid 0 even on a mode-000 file, and this repo's dev environment is root -- so the guard could never fire where it exists to fire. A read attempt is also the stricter question, catching EIO. This is the reasoning scripts/check-vale-style-sync.sh carried before this commit deleted it; the hazard did not go with it. All three entry scripts are CDPATH-safe, vale-wrap.sh included: both of its cd sites are cleared, the --config resolution and the directory-mirror walk, where an exported CDPATH would otherwise print a decoy path into the -print0 stream and build the mirror from the decoy's files. The two remaining bare cd calls take absolute paths, which CDPATH is never consulted for. Impact BREAKING: skill-audit and agent-audit no longer exist as invocable skills. kyberforge goes to 2.0.0 (catalog 0.4.7). Check logic is unchanged: differential runs of the old and new validators across every skill and agent produced byte-identical stdout, stderr and exit codes, and the reconstructed Python payloads differ only in comments and the references/field-inventory.md -> agent-field-inventory.md rename. One doctrine governs the tiers: exit 0 is audited and clean, exit 1 is audited with findings OR a target present but unreadable, exit 2 is that nothing was audited at all. Edge paths DID change, deliberately (full table in ADR-0025): - a missing target exits 2 (never ran), not 1, under its own "does not exist" message; detection is by path shape, so a shape-matching path that is simply absent used to reach the validator and come back as a FAIL against a file that never existed; - an unshaped target exits 2 under the generic "matches neither" message, and a directory with no SKILL.md under a third, distinct one -- three exit-2 messages, not one; - a dangling symlink or a symlink loop stays exit 1: it is present but broken, which is a finding about the artifact rather than a usage error; - a SKILL.md file path is audited as its skill directory instead of refused; - a .md agent outside an agents/ directory is refused rather than audited; - a missing script library, a missing python3, a missing PyYAML, and no argument at all each exit 2. validate-provenance.sh already exited 2 for the last two; validate.sh now matches it. .pre-commit-hooks.yaml is a published contract consumed by external repos. Both hook IDs and both files: regexes are unchanged; only entry: and description: moved. scripts/check-vale-style-sync.sh (413), scripts/sync-vale-styles.sh (21), tests/test-check-vale-style-sync.sh (797) and agent-audit/scripts/README.md (47) are deleted. The checker made 17 assertions: 6 compared the two Vale copies and are moot; 10 are rehomed into tests/test-vale-wrap.sh (case 0, cases 28-31, and the suite's Vale-absent skip); and the cross-manifest files: agreement check, which selected hooks by entry: and so could not survive both hooks sharing one, is ported as case 33 pairing hooks by id:. Cases 28, 30 and 33 carry mutation self-tests; narrowing the local skill prefilter to 6 of 38 SKILL.md files now fails the suite. Skills go 39 to 38. Pre-push goes 9 repo-authored hooks to 8. ADR: 0025 BREAKING-CHANGE: the skill-audit and agent-audit skills are removed. Both flows are served by factory-audit, which auto-detects whether it was handed a skill directory or an agent file. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YR2CjVumUbEGWcMikcoXBD
131 lines
10 KiB
Markdown
131 lines
10 KiB
Markdown
# Vale audit prefilter expands into a plugin-content harness, scoped to prose-pattern rules only
|
|
|
|
Issue #84 wired Vale as a deterministic prefilter for `skill-audit`/`agent-audit`, scoped to
|
|
exactly four pattern-matchable checks (imperative description opener, vague capability wording,
|
|
generic reference-pointer padding, Copilot's dead `Use proactively` phrasing), documented only in
|
|
CONTEXT.md's "Vale audit prefilter" section — never its own ADR — and explicitly excluding body
|
|
discipline, near-miss exclusion strength, and control calibration as non-goals. This ADR records a
|
|
deferred PR #85 review item to broaden that coverage, retroactively captures #84's own rationale
|
|
(since it was never recorded as a decision in its own right), and layers the expansion on top
|
|
without reversing or weakening the original four rules.
|
|
|
|
**2026-08-17 amendment.** The CONTEXT.md section named above no longer holds that documentation.
|
|
CONTEXT.md was cut back to a glossary and the prefilter's mechanics — the two-copy style layout,
|
|
`vale-wrap.sh`, the `--config` argv defect, the rule inventory, and the 0-files-means-NOT-RUN
|
|
fallback — moved to `docs/spec/gates.md`. Read that file, not CONTEXT.md, for the harness itself;
|
|
this ADR still owns the scope decision.
|
|
|
|
**File scope stays the same.** `SKILL.md` plus agent files (`**/agents/*.md`,
|
|
`**/*.agent.md`) only — matching the existing prefilter's globs. Skill-level
|
|
`README.md` files and `plugin.json` manifests are not added: README.md files are navigational, not
|
|
spec-governed content, and `plugin.json` is JSON, not prose Vale can meaningfully lint.
|
|
|
|
**Rule categories are prose-pattern-matchable only.** Structural, schema, and security concerns
|
|
stay out of this Vale-based harness because this repo already has dedicated tools for them:
|
|
`skill-frontmatter` (required frontmatter fields), `validate-marketplace`
|
|
(`claude plugin validate --strict`, schema), and `gitleaks`/`detect-private-key` (secrets).
|
|
(ADR-0024 removed the companion `validate-plugins` gate along with the per-plugin manifests it
|
|
checked; the argument here is unaffected.)
|
|
Duplicating those concerns as Vale rules would fight tools that already own them better.
|
|
|
|
**Governance docs are excluded as a rule source.** `docs/research/governance_principles/CONTROLS.md`
|
|
and `governance.md` were investigated and found to contribute nothing minable: CONTROLS.md is
|
|
org/CI-infrastructure controls (secret scanning, dependency/license scanning, agent permission
|
|
scoping, audit logging, human approval gates, periodic reviews) — none of it is a prose pattern
|
|
expressible as a Vale rule against SKILL.md/agent-file text, and what it does cover is either
|
|
already handled elsewhere (gitleaks) or genuinely out of scope for a plugin-content prose harness
|
|
(dependency/license scanning is a code-dependency concern, not skill authoring).
|
|
|
|
**Spec-derived custom rules stay mostly as-is.** Re-reading agentskills.io's
|
|
`optimizing-descriptions.md` and `skill-authoring.md`, plus `claude-code-plugins/agent-definition.md`
|
|
and `github-copilot-plugins/agent-definition.md`, found that the existing four Kyberforge rules
|
|
already cover the pattern-matchable surface those specs describe. The remaining spec guidance —
|
|
calibrating control vs. giving freedom, avoiding menus of options, coherent skill scope, moderate
|
|
detail level — is semantic judgment, already `skill-audit`'s job via LLM review, not new lintable
|
|
rules. One confirmation surfaced: Claude Code's `Use proactively` phrasing is meaningful for `.md`
|
|
agent files (it triggers auto-invocation), unlike Copilot's `.agent.md` files where it's dead
|
|
phrasing — so `KyberforgeCopilot/ProactivePhrase`'s existing `.agent.md`-only scope is correct and
|
|
must not be extended to `.md` files.
|
|
|
|
**`write-good`/`alex` are trialed, not adopted wholesale.** These built-in/third-party Vale
|
|
packages are tuned for general blog-style prose (passive voice, weasel words, wordy phrases) and
|
|
are expected to be noisy against this repo's terse, imperative instruction-file corpus. Only
|
|
individual rules proven low-noise against the existing corpus get cherry-picked into
|
|
`styles/Kyberforge`; the packages are never referenced wholesale in `BasedOnStyles`.
|
|
|
|
**A new non-Vale check closes a real gap.** `skill-authoring.md` states `SKILL.md` should stay
|
|
under 500 lines / 5,000 tokens — currently unenforced anywhere in this repo. This is a whole-file
|
|
length ceiling, not a text pattern, so it isn't a Vale rule — it becomes a new deterministic script
|
|
and pre-commit hook, sibling to the existing `skill-frontmatter` hook.
|
|
|
|
**Rules land directly in `styles/Kyberforge`, enforcing immediately.** No trial/report-only tier
|
|
is introduced (see Considered Options). "Enforcing immediately" holds only because every rule in
|
|
both styles is `level: error`: Vale's exit code keys on `error`-level alerts alone, so a
|
|
`warning`- or `suggestion`-level rule prints an alert and still exits 0, and pre-commit suppresses
|
|
output from hooks that pass — such a rule is invisible and blocks nothing. Every Vale alert is
|
|
therefore a FAIL, in the audit skills and in the blocking pre-commit hook alike, with no ignorable
|
|
tier; that matches every other gate in this repo (shellcheck, the test suite,
|
|
conventional-pre-commit). The implementation pass finalizes the cherry-picked
|
|
`write-good`/`alex` rules and any new spec-derived rule wording, runs the full set against the
|
|
existing SKILL.md/agent-file corpus, fixes any resulting violations across that corpus, and lands
|
|
the rule changes and the corpus fixes as one atomic commit — the same enforcement model as the
|
|
original four rules, never a partial or opt-in state.
|
|
|
|
## Considered options
|
|
|
|
**Phased rollout via a separate trial style + config (rejected).** A `styles/KyberforgeTrial/`
|
|
directory plus a parallel `.vale.trial.ini` (mirroring the root config's globs but with
|
|
`BasedOnStyles = Kyberforge, KyberforgeTrial`) would let new rules be swept report-only via
|
|
`lint-runner`/`vale-run` before promotion into the enforcing `styles/Kyberforge` + root
|
|
`.vale.ini`. This was considered because `BasedOnStyles = Kyberforge` activates every rule file
|
|
under that directory automatically — there's no partial/opt-in application within a style, so a
|
|
rule dropped straight into `styles/Kyberforge` goes live in the blocking pre-commit hook
|
|
immediately. Rejected in favor of finalizing rules directly and fixing violations via subagent
|
|
before committing: simpler, no new trial-config machinery to build or maintain — at the cost of no
|
|
standing report-only tier for future candidate rules. Note that the first implementation shipped
|
|
graded severities (`error`/`warning`/`suggestion`) and thereby recreated the rejected option by
|
|
accident: the five non-`error` rules never affected an exit code and never surfaced output through
|
|
a passing pre-commit hook, so they were a report-only tier that reported to nobody. Flattening
|
|
every rule to `level: error` is what actually implements this decision.
|
|
|
|
## Consequences
|
|
|
|
- `styles/Kyberforge/` gained one new rule file, cherry-picked from `write-good`/`alex` as
|
|
low-noise against this repo's corpus: `SentenceOpenerThereIs.yml` (22 hits across 273 held-out
|
|
markdown files; both in-corpus hits were clean rewrites, needing no suppression).
|
|
- A second candidate, `VagueQualifier.yml`, was cherry-picked and then dropped. Against the 41
|
|
skill/agent files it hit twice: one marginal real finding (`prototype/SKILL.md`, "very different"
|
|
→ "fundamentally different") and one false positive (`caveman/SKILL.md`, which *quotes* `of
|
|
course` as an example of filler — a mention, not a use) that no rewrite could clear, forcing the
|
|
repo's only Vale suppression comments. Of its 15 held-out hits, 9 were in `docs/research/examples/`
|
|
(out-of-scope upstream material) and the remaining 6 were the word "very" in two idioms in a
|
|
single research doc, each already adjacent to the hard number carrying the fact. One marginal
|
|
catch does not pay for a permanent suppression, so the rule is deleted and this ADR's
|
|
"cherry-picked rules" is one rule, not two.
|
|
- A new pre-commit hook, `skill-size-check` (`scripts/skill-size-check.sh`), enforces the
|
|
500-line/5,000-token `SKILL.md` ceiling, sibling to `skill-frontmatter`. Both halves of that
|
|
ceiling are blocking gates, not just the line count: `MAX_LINES=500`, and `MAX_WORDS=2770` as a
|
|
word-count proxy for the 5,000-token limit (calibrated to the densest prose this repo measured,
|
|
1.81 tokens per word, so a worst-case `SKILL.md` at the ceiling still lands under 5,000 tokens —
|
|
`wc -w` is not BPE tokenization). Either one exceeded fails the hook. Both are
|
|
inclusive: a file at exactly 500 lines or exactly 2,770 words passes, and only one past a ceiling
|
|
fails. `skill-audit/scripts/validate.sh` (now `factory-audit/scripts/validate.sh`, see ADR-0025)
|
|
enforces the same pair on the same inclusive terms, so
|
|
the audit and the commit hook cannot disagree about whether a given `SKILL.md` is over size.
|
|
- `styles/KyberforgeTrial/` and `.vale.trial.ini` were deliberately not created — noted here so a
|
|
future reader doesn't wonder if a trial tier was forgotten.
|
|
- The styles-portability question — whether `styles/` and `.vale.ini` should move into
|
|
`plugins/lint/` so the prefilter also works for repos that install `kyberforge@holocron` as an
|
|
external plugin, rather than living at this repo's root — was deliberately deferred, not fixed,
|
|
in this pass. This repo-root placement remains intentional: this ADR's "File scope stays the
|
|
same" framing is specific to Kyberforge's own authoring conventions in this repo, not a generic
|
|
`lint`-plugin feature. Portability is a known limitation, tracked for a separate future session,
|
|
not silently forgotten.
|
|
|
|
**What this ADR's implementation pass did:** synced and trialed `write-good`/`alex` against the
|
|
existing SKILL.md/agent-file corpus, cherry-picked the one low-noise rule above into
|
|
`styles/Kyberforge`, wrote `scripts/skill-size-check.sh` and its pre-commit hook, fixed the
|
|
resulting corpus violations, and landed the rule changes and corpus fixes as one atomic commit —
|
|
matching the enforcement model described above (no partial or opt-in state), with every rule at
|
|
`level: error` so that model is real rather than nominal.
|