Defame1297
175ea89c0a
Check 9 shipped in #130 to close #118, but three defects meant it could not do the job it was added for. Why: - It is INFO-only, so it always exits 0 — and SKILL.md graded exit 0 "a genuine pass" and said the script "prints nothing on success". Every check-9 INFO was discarded before it reached a report, behind three further doors that only opened on a non-zero exit. - `parse_field_raw()` matched `(.+)`, which does not span newlines, so only the first physical line of a wrapped value was compared. Rewriting only the continuation line of a wrapped Description from a hedge to a confident claim produced no finding at all — verbatim the regression #118 was filed about. The bullet branch had the same shape: a wrapped bullet broke the loop and dropped every later entry. - A `git show` failure at the base ref was treated as "creation, nothing to flag" and skipped the whole skill with no output, collapsing "absent at that ref" with "not tracked under that name". A gitignored `.claude/skills/` copy reported clean while the authoring path reported four changed claims. The script's own usage text promises this is "never a silent skip". Implementation notes: - Exit-code guidance re-keyed on output as well as code: 0-and-silent passes, 0-with-output is INFO-only findings, 1 is FAILs, 2 never ran. - `parse_field_raw()` is line-based and joins continuation lines; `normalize_field_text()`'s docstring is now true rather than aspirational. A reorder deliberately fires: the two fields share one parser, and order-insensitivity would mean splitting a prose Description on commas. - The discarded `show_err` is now surfaced as one whole-check INFO naming both readings. - `--base-ref=` given empty now beats the env var, as the usage text always claimed. `validate.sh` gains an ADR-0022 `metadata.version` check at FAIL tier, because any lower tier lets skill-author Step 4 report done on a file the commit gate then refuses. Its `read` heuristic now skips here-doc bodies — reflowing the one offending line would have cleared the finding and left the cause, since every usage() heredoc is one wrap from putting the English verb in column 0. Impact: provenance tests 73 -> 82, validate tests 64 -> 72. Test 72 previously deleted origin/main before asserting the override, so it proved the flag works with no default rather than that it beats one; it now moves origin/main forward first. Refs: #118 ADR: 0022 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EeH8SCbcrCAQrtymkNuhKP
1678 lines
83 KiB
Bash
Executable File
1678 lines
83 KiB
Bash
Executable File
#!/usr/bin/env bash
|
||
set -euo pipefail
|
||
|
||
usage() {
|
||
cat <<EOF
|
||
Usage: validate.sh <skill-dir>
|
||
|
||
Validate a skill directory against the agentskills.io specification.
|
||
|
||
Arguments:
|
||
skill-dir Path to the skill directory containing SKILL.md.
|
||
|
||
Exit codes:
|
||
0 All checks passed (may include SUGGESTIONs)
|
||
1 One or more checks failed
|
||
EOF
|
||
}
|
||
|
||
if [[ "${1:-}" == "--help" || "${1:-}" == "-h" ]]; then
|
||
usage
|
||
exit 0
|
||
fi
|
||
|
||
if [[ $# -lt 1 ]]; then
|
||
echo "Error: skill-dir is required." >&2
|
||
echo "" >&2
|
||
usage >&2
|
||
exit 1
|
||
fi
|
||
|
||
# PyYAML is a HARD dependency, not a nice-to-have. The description VALUE has to
|
||
# be measured after YAML folding is resolved, and the hand-rolled reader that
|
||
# used to stand in for PyYAML disagreed with it across the 400-character FAIL
|
||
# boundary — same description, two verdicts, depending on which reader ran.
|
||
# Refusing to start is the only honest option; the repo's jq / apm / vale
|
||
# dependencies are declared the same way.
|
||
# Check the interpreter separately from the library: `python3 -c` fails the same
|
||
# way whether python3 is missing or PyYAML is, and reporting the wrong missing
|
||
# dependency sends the reader to install the wrong thing.
|
||
if ! command -v python3 > /dev/null 2>&1; then
|
||
echo "Error: python3 is required but was not found on PATH." >&2
|
||
echo " Why: skipping the ADR-0020 description, body and boundary-target gates would be a vacuous pass." >&2
|
||
echo " Fix: install python3 (pre-commit itself is a Python application, so it is almost certainly already present)." >&2
|
||
exit 1
|
||
fi
|
||
|
||
if ! python3 -c 'import yaml' > /dev/null 2>&1; then
|
||
echo "Error: PyYAML is required but is not importable by python3." >&2
|
||
echo " Why: skipping the ADR-0020 description, body and boundary-target gates would be a vacuous pass." >&2
|
||
echo " Fix: python3 -m pip install PyYAML (or your distro's python3-yaml package)." >&2
|
||
exit 1
|
||
fi
|
||
|
||
python3 -u - "$1" <<'PYTHON'
|
||
import sys
|
||
import os
|
||
import re
|
||
import glob
|
||
|
||
import yaml
|
||
|
||
# Output is UTF-8 for the same reason input is: under LC_ALL=C the streams
|
||
# default to ASCII, and this script's own message text carries em dashes (the
|
||
# ADR-0020 boundary SUGGESTION is one). Pinning only the reads moved the crash
|
||
# from the read to the write — a UnicodeEncodeError raised while PRINTING, after
|
||
# every check has already run, which loses the whole report and (here) flips a
|
||
# clean exit 0 into a traceback and an exit 1. read_text() in the shared
|
||
# resolver block below pins the reads; this pins the writes.
|
||
#
|
||
# Deliberately OUTSIDE the ADR-0020 shared boundary resolver block: the two
|
||
# validate.sh copies print findings, skill-size-check.sh has its own top-level
|
||
# equivalent, and tests/test-adr0020-contract.sh hashes that block for
|
||
# byte-identity across all three.
|
||
for _stream in (sys.stdout, sys.stderr):
|
||
try:
|
||
_stream.reconfigure(encoding='utf-8')
|
||
except AttributeError: # pragma: no cover — Python < 3.7
|
||
pass
|
||
|
||
skill_dir = os.path.abspath(sys.argv[1])
|
||
skill_md = os.path.join(skill_dir, "SKILL.md")
|
||
|
||
if not os.path.isfile(skill_md):
|
||
print(f"Error: '{skill_md}' not found.", file=sys.stderr)
|
||
sys.exit(1)
|
||
|
||
failed = False
|
||
suggestions = []
|
||
|
||
def ok(msg):
|
||
print(f"PASS {msg}")
|
||
|
||
def fail(msg):
|
||
# stderr, matching scripts/skill-size-check.sh's ERROR routing. All three
|
||
# scripts in the ADR-0020 family now agree: findings that fail the run go to
|
||
# stderr, everything advisory (PASS / SUGGESTION / INFO) goes to stdout.
|
||
# Both repo callers capture `2>&1`, so nothing a human reads moves.
|
||
global failed
|
||
print(f"FAIL {msg}", file=sys.stderr)
|
||
failed = True
|
||
|
||
def suggest(msg):
|
||
# SUGGESTIONs are printed after every check and NEVER touch the exit code.
|
||
# skill-audit's Step 4 report counts them into its `PASS (N suggestions)`
|
||
# result line, which is what makes the ADR-0020 SUGGESTION tier visible
|
||
# rather than another silently-ignored warning (ADR-0013).
|
||
suggestions.append(msg)
|
||
|
||
def info(msg):
|
||
# A check that DECLINED to run says so out loud, rather than passing
|
||
# silently. Silence is what let a whole gate family go missing unnoticed.
|
||
print(f"INFO {msg}")
|
||
|
||
|
||
# ===== BEGIN ADR-0020 SHARED BOUNDARY RESOLVER =====
|
||
# ONE resolver, embedded VERBATIM in three scripts:
|
||
# scripts/skill-size-check.sh
|
||
# plugins/kyberforge/.apm/skills/skill-audit/scripts/validate.sh
|
||
# plugins/kyberforge/.apm/skills/agent-audit/scripts/validate.sh
|
||
# The block between these markers must stay byte-identical in all three. It is
|
||
# copied rather than imported because a cache-installed plugin's scripts cannot
|
||
# read files outside their own plugin directory, so there is no single file all
|
||
# three can share (same constraint that forces the ADR-0020 constants to be
|
||
# duplicated). Edit one copy, then paste it over the other two.
|
||
#
|
||
# Requires: glob, os, re, yaml (imported by the host script; PyYAML is a hard
|
||
# dependency, preflighted in bash before the interpreter starts).
|
||
|
||
# --- Input ----------------------------------------------------------------
|
||
# Every file this resolver's callers read goes through read_text(), which pins
|
||
# UTF-8 explicitly instead of inheriting locale.getpreferredencoding(). Under
|
||
# LC_ALL=C that inherited encoding is ASCII, so a perfectly ordinary em dash in
|
||
# a SKILL.md aborted the run with a bare UnicodeDecodeError traceback — loud,
|
||
# but pointing at the interpreter rather than at the file or the fix. A file
|
||
# that genuinely is not UTF-8 still fails; it just says so.
|
||
|
||
|
||
class EncodingError(Exception):
|
||
pass
|
||
|
||
|
||
def read_text(path):
|
||
"""File contents as text, UTF-8, with a diagnostic instead of a traceback."""
|
||
try:
|
||
with open(path, encoding='utf-8') as fh:
|
||
return fh.read()
|
||
except UnicodeDecodeError as exc:
|
||
raise EncodingError(
|
||
"not valid UTF-8 (%s at byte %d) — re-save the file as UTF-8; "
|
||
"this gate does not guess at other encodings"
|
||
% (exc.reason, exc.start))
|
||
|
||
|
||
# --- Universe ------------------------------------------------------------
|
||
# The set of names a boundary clause may resolve against is derived from an
|
||
# AUTHORING ROOT found by walking up FROM THE TARGET FILE. It is NEVER derived
|
||
# from this script's own location: deriving it from ${BASH_SOURCE} leaked
|
||
# holocron's 39-skill universe into every consumer repo that ran this hook
|
||
# through pre-commit, so a consumer skill routing to `skill-audit` resolved
|
||
# against a plugin it had never installed.
|
||
#
|
||
# An authoring root is the nearest ancestor holding plugins/*/.apm/skills/ or
|
||
# plugins/*/.apm/agents/ (a plugin monorepo), falling back to the nearest
|
||
# ancestor holding .git. When one is found the universe is:
|
||
# 1. every skill and agent under <root>/plugins/*/ — sibling plugins resolve,
|
||
# which is what a monorepo means,
|
||
# 2. the target's own apm package,
|
||
# 3. the packages that package DECLARES in apm.yml dependencies.apm.
|
||
# Deployed .claude/ and .agents/ trees are deliberately NOT consulted when the
|
||
# root came from the plugins/ probe. They are `apm install` output, gitignored,
|
||
# and present only on a machine that has run it: four cross-plugin targets in
|
||
# this repo (gitea-branches -> git-branches, gitea-branches -> git-history,
|
||
# gitea-issues -> git-branches, gitea-workflow -> git-workflow) resolved through
|
||
# .claude/skills/ alone, so the same commit measured 2 dangling targets on a
|
||
# developer machine and 6 on a fresh clone. A gate shipping hot with no baseline
|
||
# cannot give two answers.
|
||
#
|
||
# Deployed trees ARE used when no plugin monorepo was found — whether the walk
|
||
# landed on a bare .git ancestor or on nothing at all. That is the consumer
|
||
# case: the file being checked lives in or beside a deployed tree, inside an
|
||
# ordinary git repo, with no monorepo to read. The two cases are told apart by
|
||
# which probe matched, never by how many names a root contributed; see
|
||
# known_targets().
|
||
|
||
|
||
def _is_fs_root(path):
|
||
return os.path.dirname(path) == path
|
||
|
||
|
||
def _collect_package(pkg_dir, names):
|
||
"""Add every skill/agent name a package directory exposes, any layout."""
|
||
# glob.escape() the DIRECTORY only. A checkout path containing `[`, `]`,
|
||
# `*` or `?` — a worktree named `feature[2]`, say — otherwise turns the
|
||
# whole pattern into a character class that matches nothing, and the
|
||
# resolver degrades to the "DID NOT RUN" INFO with rc=0 across every file
|
||
# in the tree. The wildcards in `sub` are the intended ones and stay raw.
|
||
safe_dir = glob.escape(pkg_dir)
|
||
for sub in ('.apm/skills/*/', 'skills/*/'):
|
||
for path in glob.glob(os.path.join(safe_dir, sub)):
|
||
# A directory is a skill only if it HOLDS a SKILL.md. An empty
|
||
# leftover — a deleted skill whose directory survived, a scaffolding
|
||
# stub, an editor's stray mkdir — is untracked by git, so it exists
|
||
# on the machine that made it and nowhere else. Counting it made a
|
||
# boundary target resolve locally and dangle in a fresh clone: the
|
||
# same install-dependence the deployed-tree rule above exists to
|
||
# remove, arriving through a different door.
|
||
if os.path.isfile(os.path.join(path, 'SKILL.md')):
|
||
names.add(os.path.basename(path.rstrip('/')).lower())
|
||
for sub in ('.apm/agents/*.md', 'agents/*.md'):
|
||
for path in glob.glob(os.path.join(safe_dir, sub)):
|
||
# The same rule one directory over, which until now had no
|
||
# counterpart here at all: the skills branch above tests for a
|
||
# SKILL.md, the agents branch took every glob hit on trust. A
|
||
# DIRECTORY named `ghost-agent.md` matches `*.md` and glob does not
|
||
# tell the two apart, so a leftover of that shape resolved a routing
|
||
# target on the machine holding it and dangled everywhere else —
|
||
# identical install-dependence, arriving through the one door
|
||
# nobody guarded.
|
||
if not os.path.isfile(path):
|
||
continue
|
||
base = os.path.basename(path)
|
||
if base.endswith('.agent.md'):
|
||
base = base[:-len('.agent.md')]
|
||
else:
|
||
base = base[:-len('.md')]
|
||
names.add(base.lower())
|
||
|
||
|
||
def _apm_package_root(start_dir):
|
||
"""Nearest ancestor that is an apm package root (apm.yml or .apm/).
|
||
|
||
The filesystem root is never a candidate: a stray /.apm/skills/ — a
|
||
scaffolding test's leftover, say, and one really does exist on at least one
|
||
machine here — would otherwise become the package root of every path on it.
|
||
Capped at ten levels so a pathological path can't become a filesystem
|
||
crawl; that covers every real layout by a wide margin.
|
||
"""
|
||
current = os.path.abspath(start_dir)
|
||
for _ in range(10):
|
||
if _is_fs_root(current):
|
||
return None
|
||
if (os.path.isfile(os.path.join(current, 'apm.yml'))
|
||
or os.path.isdir(os.path.join(current, '.apm'))):
|
||
return current
|
||
current = os.path.dirname(current)
|
||
return None
|
||
|
||
|
||
def _authoring_root(start_dir):
|
||
"""Nearest ancestor that is a plugin monorepo, else the nearest .git tree.
|
||
|
||
Returns (root, matched_plugins_probe). The flag reports WHICH probe
|
||
matched: True for the plugins/*/.apm/{skills,agents} glob, False for the
|
||
.git fallback and for no match at all. known_targets() needs that
|
||
distinction — only a real plugins/ root makes the deployed trees
|
||
redundant, and a name-count delta cannot tell the two apart.
|
||
|
||
Two passes, not one interleaved walk: a nested .git (a submodule, a
|
||
worktree of a sub-package) must not win over a real plugins/ root further
|
||
up. Both passes stop before the filesystem root for the same reason
|
||
_apm_package_root does.
|
||
"""
|
||
probes = (
|
||
lambda d: bool(glob.glob(os.path.join(glob.escape(d), 'plugins', '*', '.apm', 'skills'))
|
||
or glob.glob(os.path.join(glob.escape(d), 'plugins', '*', '.apm', 'agents'))),
|
||
lambda d: os.path.exists(os.path.join(d, '.git')))
|
||
for index, probe in enumerate(probes):
|
||
current = os.path.abspath(start_dir)
|
||
for _ in range(12):
|
||
if _is_fs_root(current):
|
||
break
|
||
if probe(current):
|
||
return current, index == 0
|
||
current = os.path.dirname(current)
|
||
return None, False
|
||
|
||
|
||
def _collect_authoring_root(root, names):
|
||
"""Every plugin in the monorepo contributes its names."""
|
||
for pkg in glob.glob(os.path.join(glob.escape(root), 'plugins', '*')):
|
||
if os.path.isdir(pkg):
|
||
_collect_package(pkg, names)
|
||
|
||
|
||
def _declared_dependency_dirs(pkg_dir):
|
||
"""Directories of the apm packages pkg_dir's manifest DECLARES.
|
||
|
||
Reads dependencies.apm and resolves each entry to a directory on disk:
|
||
a monorepo-relative `path:` (against the package root and the nearest
|
||
ancestor manifest, which is the monorepo root) or an installed
|
||
apm_modules/<name>/. Entries that resolve to nothing are skipped — an
|
||
undeployed dependency contributes no names rather than an error.
|
||
"""
|
||
manifest = os.path.join(pkg_dir, 'apm.yml')
|
||
if not os.path.isfile(manifest):
|
||
return []
|
||
try:
|
||
data = yaml.safe_load(read_text(manifest)) or {}
|
||
except Exception:
|
||
return []
|
||
if not isinstance(data, dict):
|
||
return []
|
||
deps = data.get('dependencies')
|
||
deps = deps.get('apm') if isinstance(deps, dict) else None
|
||
if not isinstance(deps, list):
|
||
return []
|
||
|
||
roots = [pkg_dir]
|
||
ancestor = os.path.dirname(os.path.abspath(pkg_dir))
|
||
for _ in range(10):
|
||
if _is_fs_root(ancestor):
|
||
break
|
||
if os.path.isfile(os.path.join(ancestor, 'apm.yml')):
|
||
roots.append(ancestor)
|
||
break
|
||
ancestor = os.path.dirname(ancestor)
|
||
|
||
found = []
|
||
for entry in deps:
|
||
candidates = []
|
||
if isinstance(entry, dict):
|
||
rel = entry.get('path')
|
||
name = entry.get('name')
|
||
if not name and rel:
|
||
name = os.path.basename(str(rel).rstrip('/'))
|
||
if rel:
|
||
candidates.extend(os.path.join(r, str(rel)) for r in roots)
|
||
if name:
|
||
candidates.append(os.path.join(pkg_dir, 'apm_modules', str(name)))
|
||
elif isinstance(entry, str):
|
||
name = re.split(r'[#@]', entry)[0].strip().rstrip('/').split('/')[-1]
|
||
if name:
|
||
candidates.append(os.path.join(pkg_dir, 'apm_modules', name))
|
||
candidates.extend(os.path.join(r, 'plugins', name) for r in roots)
|
||
for candidate in candidates:
|
||
if os.path.isdir(candidate):
|
||
found.append(candidate)
|
||
return found
|
||
|
||
|
||
def _deployed_roots(start_dir):
|
||
""".claude/ and .agents/ trees above start_dir — what a host really sees.
|
||
|
||
Consulted ONLY when no plugin monorepo root was found; see the header. The
|
||
filesystem root is skipped for the same reason _apm_package_root skips it:
|
||
a stray /.claude/skills/ must not join every path's universe.
|
||
"""
|
||
found = []
|
||
current = os.path.abspath(start_dir)
|
||
for _ in range(10):
|
||
if _is_fs_root(current):
|
||
break
|
||
for name in ('.claude', '.agents'):
|
||
base = os.path.join(current, name)
|
||
if os.path.isdir(base):
|
||
found.append(base)
|
||
current = os.path.dirname(current)
|
||
return found
|
||
|
||
|
||
def known_targets(start_dir):
|
||
"""Every skill/agent name a boundary clause in start_dir may name."""
|
||
names = set()
|
||
start = os.path.abspath(start_dir)
|
||
|
||
# Siblings: a cache-installed plugin and a deployed .claude/skills/ tree
|
||
# both put peers one level up, with no plugins/ directory above them. The
|
||
# grandparent is guarded against the filesystem root exactly like the two
|
||
# walk-up loops above — for a start dir of /skills/<x> the grandparent is
|
||
# `/`, and collecting there picks up this machine's stray /.apm/skills/.
|
||
parent = os.path.dirname(start)
|
||
grandparent = os.path.dirname(parent)
|
||
if (os.path.basename(parent) in ('skills', 'agents')
|
||
and os.path.isdir(parent) and not _is_fs_root(grandparent)):
|
||
_collect_package(grandparent, names)
|
||
|
||
package = _apm_package_root(start)
|
||
if package:
|
||
_collect_package(package, names)
|
||
for dep_dir in _declared_dependency_dirs(package):
|
||
_collect_package(dep_dir, names)
|
||
|
||
# A .git ancestor is an authoring root only if it actually holds plugins.
|
||
# _authoring_root() falls back to the nearest .git, so it is truthy in ANY
|
||
# git repo; without the distinction that fallback wins in every consumer
|
||
# checkout, _collect_authoring_root() contributes nothing, and the deployed
|
||
# branch below is dead code in the exact case it exists for. So condition
|
||
# on WHICH probe matched, which _authoring_root() reports directly. A
|
||
# name-count delta looks equivalent and is not: _collect_authoring_root()
|
||
# re-collects the checked file's own plugin, whose names the blocks above
|
||
# already added, so a one-plugin monorepo shows a delta of zero and would
|
||
# wrongly reach for the deployed trees — including the user's global
|
||
# ~/.claude/skills, making the verdict depend on what happens to be
|
||
# installed (ADR-0020 lines 118-127).
|
||
root, root_has_plugins = _authoring_root(start)
|
||
if root:
|
||
_collect_authoring_root(root, names)
|
||
if not root_has_plugins:
|
||
for base in _deployed_roots(start):
|
||
_collect_package(base, names)
|
||
return names
|
||
|
||
|
||
# --- Extraction -----------------------------------------------------------
|
||
# False positives are the design constraint here, not recall. The rules:
|
||
# * A BARE target must be hyphenated AND sit in a boundary sentence (one
|
||
# carrying "do not"/"instead"/"rather than"/"not for"). Without the second
|
||
# condition, pc-run's "run pre-commit hooks" reads as a route to a
|
||
# non-existent `pre-commit` skill.
|
||
# * A BARE arrow target counts only in ADR-0020's compressed boundary form,
|
||
# `Not <thing> -> <skill-name>`. The example that motivated it is gone:
|
||
# diagnose's process chain "fix -> regression-test", which without the
|
||
# gate read as a route to a non-existent `regression-test` skill, was cut
|
||
# when issue #99 retrofitted that description. So the gate is currently
|
||
# UNEXERCISED — gating and not gating produce the same verdict corpus-wide.
|
||
# Keep it anyway. It is a false-positive guard against prose no one has
|
||
# written yet, and any new process chain re-arms it. Unexercised is not the
|
||
# same as unnecessary, and the branch it guards is still load-bearing: the
|
||
# bare-arrow rule is the sole extractor for three real targets in
|
||
# kyberforge's audit skills (agent-audit -> agent-author, agent-audit ->
|
||
# skill-audit, skill-audit -> skill-author), all written unbackticked.
|
||
# * A backticked hyphenated token counts only inside a boundary sentence.
|
||
# Unconditionally, `pre-push` or `commit-msg` in a TRIGGER clause is a hard
|
||
# FAIL with no escape hatch. Gating it costs nothing (measured over this
|
||
# corpus: 54 targets before and after); DELETING it costs 7 real targets
|
||
# across three gitea skills, so it is gated, not removed.
|
||
# * SINGLE-WORD targets are deliberately NOT matchable bare — `research`,
|
||
# `triage`, `forge`, `prototype` and `tdd` are all real skill names and all
|
||
# ordinary English, so a bare-word rule would flag most of the corpus. A
|
||
# single-word target must be written `` `forge` `` or /forge to be seen.
|
||
# That is a known recall limitation, accepted over the false positives.
|
||
# Tool names (Read/Write/Edit) are excluded by the lowercase-only pattern; MCP
|
||
# tool names (issue_write) by its rejection of underscores; file names by its
|
||
# rejection of dots and slashes.
|
||
#
|
||
# ATTRIBUTIVE USE. The boundary-sentence gate above does NOT solve the
|
||
# `pre-commit` false positive, and the comment that claimed it did was wrong:
|
||
# "instead", "rather than", "do not" and "not for" are exactly the words a
|
||
# boundary clause uses, so the gate is open precisely where the risk is. All of
|
||
# these were hard dangling FAILs with no suppression:
|
||
# Use pre-commit hooks instead of ad-hoc scripts.
|
||
# Invoke the pull-request template instead of writing one by hand.
|
||
# Use conventional-commits formatting rather than free-form messages.
|
||
# Composes label-resolution logic instead of duplicating it.
|
||
# Do not use for X — run the `pre-push` hooks instead.
|
||
# What separates every one of them from a real route is grammar, not marking:
|
||
# the hyphenated token is a compound MODIFIER of the noun that follows it
|
||
# ("pre-commit hooks", "pull-request template"), where a route target is
|
||
# terminal — followed by punctuation, a conjunction, or a boundary word. So a
|
||
# target whose next token is an ordinary lowercase noun is CONFIRM-ONLY: it
|
||
# still resolves and still counts as a route when the name exists, but it can
|
||
# never raise a dangling error on its own.
|
||
#
|
||
# This is deliberately NOT the simpler "only marked targets may dangle" rule,
|
||
# which would have been wrong here: BOTH live true positives in this corpus are
|
||
# BARE — research's "(use neuledge-context)" and gitea-issues' "Composes
|
||
# gitea-labels-\n milestones", where the `>` fold yields "gitea-labels-
|
||
# milestones" and the trailing hyphen is what keeps it terminal. Marking is a
|
||
# poor proxy, so the follower token is the signal, and it is applied to
|
||
# backticked targets too.
|
||
#
|
||
# TERMINAL IS NOT ENOUGH — IN-SENTENCE CORROBORATION. The follower test clears
|
||
# `pre-push` in the example above only because that example happens to be
|
||
# followed by the noun "hooks". Move the same token into terminal position and
|
||
# it was a hard FAIL again, with no suppression mechanism anywhere in this gate:
|
||
# Do not use for running hooks — run `pre-commit` instead.
|
||
# Do not use for the commit message — see `commit-msg`.
|
||
# Do not use for type errors — run `type-check` first.
|
||
# Instead, use `semantic-release`.
|
||
# Do not use for the old flow — use the clean-up instead.
|
||
# Do not run end-to-end, run unit-tests.
|
||
# Every one of those is grammatically identical to a genuinely broken route:
|
||
# "route verb + hyphenated name + terminal" is also exactly how prose cites a
|
||
# tool, a hook, a file format or an English compound. Nothing local separates
|
||
# them, and the skills most exposed are the ones this contract sends authors
|
||
# back to rewrite first — pc-run, pc-author, vale-run, vale-config and the apm-*
|
||
# family are all ABOUT hyphenated tools.
|
||
#
|
||
# So the confidence to BLOCK a commit comes from the sentence, not the token: a
|
||
# prose-form target may raise a hard error only when its own sentence names at
|
||
# least one OTHER target that RESOLVES. A routing sentence proves itself by
|
||
# routing somewhere real; a lone unresolvable name proves nothing. That is not a
|
||
# rule fitted to the fixtures — it is the shape of both live true positives,
|
||
# which sit beside `write-docs` and `gitea-labels-milestones` respectively, and
|
||
# it changes this corpus's verdict by exactly nothing.
|
||
#
|
||
# An uncorroborated unresolvable target is NOT discarded: every caller reports
|
||
# it at its SUGGESTION tier, naming the target. The finding stays visible on
|
||
# every run; only the power to block a commit is withdrawn, which is the part
|
||
# that had no escape hatch.
|
||
#
|
||
# EXPLICIT ROUTE NOTATION is exempt from corroboration and always blocks:
|
||
# ADR-0020's compressed arrow (`Not <thing> -> <name>`) and Claude Code's
|
||
# invocation form (`/<name>`). Neither is ever how English cites a tool — nobody
|
||
# writes `-> pre-commit` or `/pre-commit` to mean the hook — so there is no
|
||
# ambiguity to resolve, and an author who wants a route checked unconditionally
|
||
# has two ways to say so.
|
||
#
|
||
# BOTH FORMS ARE SWEPT FOR ON THEIR OWN, and that is a repair of the promise
|
||
# above rather than a widening of it. Until the sweeps existed, notation was
|
||
# only ever seen as the OBJECT OF A ROUTE VERB (`use
|
||
# /name`) or as the tail of a `not ... ->` clause with no `;` or sentence end in
|
||
# between. Every one of these therefore exited 0 in total silence — no ERROR, no
|
||
# SUGGESTION, not even the target's name:
|
||
# Do not use for Y — /no-such-skill instead.
|
||
# Do not use for Y; /no-such-skill handles that.
|
||
# Do not use for Y (/no-such-skill covers it).
|
||
# Do not use for Y — that is /no-such-skill's job.
|
||
# Do not use for Y — defer to /no-such-skill.
|
||
# Do not use for Y — /no-such-skill.
|
||
# Do not use for Y; -> no-such-skill covers it.
|
||
# For W, /no-such-skill is the right entry point.
|
||
# The target was never EXTRACTED, so the notation-first rule in _add() had
|
||
# nothing to apply itself to and the "always blocks" promise was false for the
|
||
# ordinary way an author writes the thing. The SUGGESTION tier made it worse
|
||
# than a gap: its printed remedy tells the author to "write it as `/name` or
|
||
# `-> name` and it will be checked properly", and taking that advice turned a
|
||
# visible SUGGESTION into silence — the gate teaching the one edit that blinds
|
||
# it.
|
||
#
|
||
# THE TWO SWEEPS ARE GATED DIFFERENTLY, and the asymmetry is the whole point.
|
||
# `/name` is Claude Code's invocation syntax and nothing else — no English
|
||
# sentence contains one by accident — so the ADR-0020 amendment and
|
||
# docs/spec/gates.md both promise it blocks UNCONDITIONALLY, for any name. So
|
||
# NOTATION_SLASH is swept over every sentence, boundary marker or not. Gating it
|
||
# on BOUNDARY_MARKER made that promise false for the last sentence of
|
||
# Do not use for Z — use /real-skill instead.
|
||
# For W, /no-such-skill is the right entry point.
|
||
# which exited 0 in total silence: the boundary clause is one sentence up, so
|
||
# the sweep never looked at the sentence carrying the broken route. Extraction is
|
||
# per-sentence by design (corroboration is scoped to one sentence), which is
|
||
# exactly what made the gap invisible.
|
||
#
|
||
# NOTATION_ARROW stays gated on BOUNDARY_MARKER, and so does the backtick sweep.
|
||
# Neither form is unambiguous: `-> name` is also how a process chain is written
|
||
# ("reproduce -> minimise -> regression-test") and a code span is how a tool, a
|
||
# file and a skill are all cited. Ungating either would fire on prose that
|
||
# carries no routing intent at all — the false-positive class this whole
|
||
# extractor is tuned against.
|
||
#
|
||
# BOTH `/name` PATTERNS REFUSE A TOKEN THAT IS PART OF A PATH: a following `/`,
|
||
# or a `.` followed by a non-space, means `references/foo.md`, `docs/a/b.md` or
|
||
# `https://x/y`, not a route. A sentence's closing `.` is not followed by a
|
||
# non-space, so `— /no-such-skill.` still counts.
|
||
#
|
||
# THAT GUARD IS WRITTEN `(?![\w-])` AND NOT `\b`, because `\b` is not a guard at
|
||
# all here: it holds after a hyphen, so when the trailing lookahead rejected the
|
||
# full segment the engine simply backtracked to a shorter hyphen-terminated
|
||
# prefix and reported THAT as a route. Every one of these was a hard blocking
|
||
# ERROR naming a skill nobody had written:
|
||
# the config lives at /opt-tools/bin/thing. -> 'opt'
|
||
# see /api-docs/v2.md for the schema. -> 'api' AND 'api-docs'
|
||
# the file /no-such-skill.md documents it. -> 'no-such'
|
||
# `(?![\w-])` forbids the shortened prefix outright, so the whole segment is
|
||
# rejected as the path it is. MARKED_TARGET carries the same guard: it had no
|
||
# trailing lookahead whatsoever, so `see /api-docs/v2.md` raised the second of
|
||
# the two errors above through the route-verb path rather than the sweep.
|
||
#
|
||
# NAMESPACE: `plugin:skill` is live in this repo (native user-scope installs
|
||
# still resolve `gitea:gitea-prs`), so the patterns admit an optional
|
||
# `<plugin>:` prefix and normalize_target() strips it before resolution.
|
||
NS = r"(?:[a-z0-9]+(?:-[a-z0-9]+)*:)?"
|
||
NAME_ANY = NS + r"[a-z0-9]+(?:-[a-z0-9]+)*"
|
||
NAME_HYPH = NS + r"[a-z0-9]+(?:-[a-z0-9]+)+"
|
||
ROUTE_VERB = (r"(?:use|uses|using|run|runs|invoke|invokes|invoking|try|see"
|
||
r"|that'?s|compose|composes|call|calls"
|
||
r"|routes?\s+to|delegates?\s+to|prefers?|switch(?:es)?\s+to"
|
||
r"|hands?\s+off\s+to)")
|
||
MARKED_TARGET = (r"(?:`/?(%s)`|(?<![\w./*-])/(%s)(?![\w-])(?!/|\.\S))"
|
||
% (NAME_ANY, NAME_ANY))
|
||
ANY_TARGET = r"(?:%s|(%s)\b)" % (MARKED_TARGET, NAME_HYPH)
|
||
ROUTE_MARKED = re.compile(r"\b%s\s+(?:the\s+|an?\s+)?%s" % (ROUTE_VERB, MARKED_TARGET), re.I)
|
||
ROUTE_ANY = re.compile(r"\b%s\s+(?:the\s+|an?\s+)?%s" % (ROUTE_VERB, ANY_TARGET), re.I)
|
||
# re.I on ALL of them, uniformly. The patterns are built from the same
|
||
# lowercase NAME_* fragments, so half of them carrying the flag and half not
|
||
# meant `Skill-Audit` at the start of a boundary sentence was extracted by
|
||
# ROUTE_ANY but invisible to BACKTICK — contradicting normalize_target()'s own
|
||
# docstring, which exists precisely because extraction is case-insensitive and
|
||
# the universe is not.
|
||
CONT_MARKED = re.compile(r"\s*(?:or|and|/|,)\s*%s" % MARKED_TARGET, re.I)
|
||
CONT_ANY = re.compile(r"\s*(?:or|and|/|,)\s*%s" % ANY_TARGET, re.I)
|
||
ARROW_MARKED = re.compile(r"(?:->|→)\s*%s" % MARKED_TARGET, re.I)
|
||
# The two EXPLICIT ROUTE NOTATION sweeps. NOTATION_SLASH runs over EVERY
|
||
# sentence; NOTATION_ARROW is scoped to a boundary sentence by its caller (see
|
||
# the asymmetry note in the header). NOTATION_SLASH is deliberately not a reuse
|
||
# of MARKED_TARGET's `/name` alternative: that one only ever runs behind a route
|
||
# verb or an arrow, and it may match a namespaced or path-adjacent token in
|
||
# positions this free-standing sweep must refuse.
|
||
# NOTATION_ARROW is ARROW_BOUNDARY minus its leading `\bnot\b%s*?`, which is
|
||
# what made `Do not use for Y; -> no-such-skill covers it.` invisible:
|
||
# CLAUSE_BODY cannot cross the `;`, so the clause's own punctuation disarmed the
|
||
# check. Dropping that prefix costs the one false positive the bare-arrow bullet
|
||
# above names — a process chain ending in a hyphenated word, `Instead, reproduce
|
||
# -> minimise -> regression-test.` — and costs it only in a sentence that already
|
||
# carries a BOUNDARY_MARKER. That exposure is neither new nor larger: the same
|
||
# chain written `Do not use for X — reproduce -> regression-test.` was already a
|
||
# hard ERROR under ARROW_BOUNDARY, so this changes which boundary words reach the
|
||
# arrow, not whether prose can. An author who means the chain and not a route
|
||
# writes it in its own sentence, where neither pattern looks.
|
||
NOTATION_SLASH = re.compile(
|
||
r"(?<![\w./*-])/(%s)(?![\w-])(?!/|\.\S)" % NAME_ANY, re.I)
|
||
NOTATION_ARROW = re.compile(r"(?:->|→)\s*(%s)\b" % NAME_HYPH, re.I)
|
||
# CLAUSE_BODY is what may sit between `Not` and the arrow, and it is NOT
|
||
# `[^.;]`. That class cannot cross a `.`, so every boundary clause naming a
|
||
# DOTTED FILENAME between the two — `.pre-commit-config.yaml`, `AGENTS.md`,
|
||
# `.vale.ini` — was invisible to both patterns below, and the two resulting
|
||
# failures were different sizes (issue #110):
|
||
# * with a BACKTICKED target the clause was MISDIAGNOSED. The backtick sweep
|
||
# still extracted the target, so the route was checked, but the gate
|
||
# reported "no boundary clause" on a clause that was present and working.
|
||
# Three authors in two retrofit waves reworded a correct clause to satisfy
|
||
# the regex, one of them stripping the very filename that discriminates the
|
||
# skill from its neighbour.
|
||
# * with a BARE target the clause was UNCHECKED. ARROW_BOUNDARY is the only
|
||
# extractor for a bare arrow target, so `Not AGENTS.md -> no-such-skill`
|
||
# produced no target, no dangling report and no missing-clause SUGGESTION.
|
||
# Silence, not noise — the worse of the two failure modes.
|
||
# A dot inside a filename is followed by a non-space; a sentence-ending dot is
|
||
# followed by whitespace or by end of string. So the class admits a `.` only
|
||
# when the next character is not whitespace, which crosses `AGENTS.md` and
|
||
# still stops at a real sentence end.
|
||
CLAUSE_BODY = r"(?:[^.;]|\.(?=\S))"
|
||
ARROW_BOUNDARY = re.compile(
|
||
r"\bnot\b%s*?(?:->|→)\s*(%s)\b" % (CLAUSE_BODY, NAME_HYPH), re.I)
|
||
BACKTICK = re.compile(r"`(%s)`" % NAME_HYPH, re.I)
|
||
# A boundary clause takes two shapes and BOTH count: the prose markers, and
|
||
# ADR-0020's compressed arrow form `Not <thing> -> <name>`.
|
||
BOUNDARY_MARKER = re.compile(r"\b(?:do\s+not|instead|rather\s+than|not\s+for)\b", re.I)
|
||
BOUNDARY_ARROW = re.compile(r"\bnot\b%s*?(?:->|→)" % CLAUSE_BODY, re.I)
|
||
# Sentence boundaries decide the CORROBORATION scope above, so getting one wrong
|
||
# is not cosmetic — it moves a target between SUGGESTION and blocking ERROR. Two
|
||
# shapes common in these descriptions defeat the naive "period, space, capital"
|
||
# rule, in OPPOSITE directions:
|
||
# OVER-SPLIT. `e.g. "set up the manifest"` ends no sentence, but the quote
|
||
# looks like one starting. The clause is cut in half, the corroborating
|
||
# target lands on the far side of the cut, and a genuinely dangling target
|
||
# silently demotes to SUGGESTION — the gate takes a measurement and then
|
||
# throws it away, which is the vacuous-green shape this file exists to stop.
|
||
# UNDER-SPLIT. A real sentence opening with a code span or a lowercase skill
|
||
# name ("... Composes it. `gitea-prs` also uses it.") is not seen as a start
|
||
# at all, so two sentences merge and a resolving target vouches for an
|
||
# unresolvable one it never stood beside — a hard FAIL with no escape hatch,
|
||
# which is exactly the failure the corroboration rule was added to prevent.
|
||
# Both are closed here: the five abbreviations that actually occur in routing
|
||
# prose are excluded as sentence ends, and the opener class admits a backtick or
|
||
# a lowercase letter. Verified zero-delta on the current corpus (37 ERROR / 58
|
||
# SUGGESTION / 2 dangling before and after) — this protects the descriptions
|
||
# issue #99 is about to rewrite, not the ones already measured.
|
||
# re.I here too, and NOT as a tidy-up: this was the one pattern in the file
|
||
# built without it, contradicting the uniformity note on CONT_*/ARROW_* above.
|
||
# Without the flag `E.g.` and `I.e.` — the sentence-initial spellings, which is
|
||
# where an abbreviation most often lands — matched none of the lookbehinds, so
|
||
# the clause split at the abbreviation, the corroborating target was stranded on
|
||
# the far side of the cut, and a genuinely dangling target silently demoted from
|
||
# blocking ERROR to SUGGESTION. That is the OVER-SPLIT failure described
|
||
# directly above, still live for exactly the capitalised half of the input.
|
||
SENTENCE_SPLIT = re.compile(
|
||
u'(?<!\\be\\.g\\.)(?<!\\bi\\.e\\.)(?<!\\betc\\.)(?<!\\bvs\\.)(?<!\\bcf\\.)'
|
||
u'(?<=[.!?])\\s+(?=[A-Za-z`"“(])', re.I)
|
||
|
||
# The token that may follow a route target without turning it into a compound
|
||
# modifier: punctuation, end of sentence, a conjunction, a boundary word, or a
|
||
# head noun that names the artifact itself ("the git-workflow skill"). Anything
|
||
# else — `hooks`, `template`, `formatting`, `logic` — is attributive prose.
|
||
FOLLOWER = re.compile(r"[`\s]*([a-z][a-z0-9]*)")
|
||
FOLLOWER_OK = frozenset("""
|
||
and or nor but for to when if unless while after before with from in on at by
|
||
of as than then instead rather directly first only always never also even
|
||
both either neither so because since per via plus alone here there this that
|
||
these those it its they them is are was were be been being has have had will
|
||
would can could should must may might does do did
|
||
skill skills agent agents plugin plugins command commands
|
||
""".split())
|
||
|
||
|
||
def normalize_target(target):
|
||
"""Comparison key: namespace stripped, lowercased.
|
||
|
||
Extraction is case-insensitive (re.I) but the universe is built from
|
||
lowercase directory names, so `Git-Commits` at the start of a sentence
|
||
resolved to nothing until this normalization existed.
|
||
"""
|
||
return target.split(':')[-1].lower()
|
||
|
||
|
||
def has_boundary_clause(description):
|
||
return bool(BOUNDARY_MARKER.search(description)
|
||
or BOUNDARY_ARROW.search(description))
|
||
|
||
|
||
def _first(match):
|
||
"""(name, start, end) offsets for the first group that matched."""
|
||
for index in range(1, (match.re.groups or 0) + 1):
|
||
if match.group(index):
|
||
return match.group(index), match.start(index), match.end(index)
|
||
return None, None, None
|
||
|
||
|
||
def _terminal(text, pos):
|
||
"""True if the token at pos does not make the preceding name a modifier."""
|
||
follower = FOLLOWER.match(text, pos)
|
||
return not follower or follower.group(1) in FOLLOWER_OK
|
||
|
||
|
||
def _notation(text, start, arrow):
|
||
"""True if the name is written in route NOTATION rather than in prose.
|
||
|
||
Two forms qualify: `/name` (Claude Code's invocation syntax, detected from
|
||
the character before the name) and `-> name` (ADR-0020's compressed boundary
|
||
form, passed in by the caller that matched the arrow). A backticked name
|
||
does NOT qualify — a code span is how a tool, a file and a skill are all
|
||
cited, so it carries no intent the follower test hasn't already read.
|
||
"""
|
||
return arrow or (start > 0 and text[start - 1] == '/')
|
||
|
||
|
||
def _add(out, text, name, start, end, strict=None, arrow=False):
|
||
"""Record one target as (name, may_dangle, notation).
|
||
|
||
NOTATION IS DECIDED FIRST, and when it is set the follower test is skipped.
|
||
The header above promises that route notation "always blocks", and for the
|
||
`/name` form that was false: `-> name` reached this function with
|
||
strict=True from its two call sites, but `/name` did not, so it fell to
|
||
_terminal() and a follower outside FOLLOWER_OK set may_dangle=False. The
|
||
target then reached unresolved_targets() unblockable — and, before the
|
||
companion fix there, unreported as well. `... use /no-such-skill
|
||
afterwards.` exited 0 in total silence, on the one form ADR-0020 offers an
|
||
author who wants a route checked unconditionally.
|
||
"""
|
||
if not name:
|
||
return
|
||
notation = _notation(text, start, arrow)
|
||
if strict is None and notation:
|
||
strict = True
|
||
out.append((name,
|
||
_terminal(text, end) if strict is None else strict,
|
||
notation))
|
||
|
||
|
||
def _scan(text, route_re, cont_re, out):
|
||
for match in route_re.finditer(text):
|
||
name, start, end = _first(match)
|
||
if not name:
|
||
continue
|
||
_add(out, text, name, start, end)
|
||
# "use git-history or git-branches instead" / "use gitea-issues /
|
||
# gitea-prs" — keep consuming conjoined targets after the first.
|
||
pos = match.end()
|
||
while True:
|
||
cont = cont_re.match(text, pos)
|
||
if not cont:
|
||
break
|
||
_add(out, text, *_first(cont))
|
||
pos = cont.end()
|
||
|
||
|
||
def _extract_sentence(sentence):
|
||
"""[(name, may_dangle, notation)] for the routing targets in ONE sentence.
|
||
|
||
Kept separate from _extract() because corroboration is scoped to a single
|
||
sentence: a target's evidence is what stands beside it, not what the rest of
|
||
the description happens to mention.
|
||
"""
|
||
out = []
|
||
boundary = bool(BOUNDARY_MARKER.search(sentence))
|
||
_scan(sentence,
|
||
ROUTE_ANY if boundary else ROUTE_MARKED,
|
||
CONT_ANY if boundary else CONT_MARKED,
|
||
out)
|
||
for match in ARROW_MARKED.finditer(sentence):
|
||
# `-> name` and `-> /name` are route notation, not prose: nothing
|
||
# reads as a compound modifier after an arrow, so no follower test.
|
||
_add(out, sentence, *_first(match), strict=True, arrow=True)
|
||
for match in ARROW_BOUNDARY.finditer(sentence):
|
||
_add(out, sentence, match.group(1), match.start(1), match.end(1),
|
||
strict=True, arrow=True)
|
||
# `/name` wherever it sits, in ANY sentence — not only where a route verb or
|
||
# an arrow happens to precede it, and NOT only inside a boundary sentence.
|
||
# See the EXPLICIT ROUTE NOTATION note in the header for the eight phrasings
|
||
# this recovers and for why silence was the failure mode. The sweep takes no
|
||
# follower test: _add() reads the notation first and marks it.
|
||
for match in NOTATION_SLASH.finditer(sentence):
|
||
_add(out, sentence, match.group(1), match.start(1), match.end(1))
|
||
if boundary:
|
||
# The arrow and backtick forms are ambiguous in ordinary prose, so they
|
||
# stay scoped to a sentence that carries a boundary marker.
|
||
for match in NOTATION_ARROW.finditer(sentence):
|
||
_add(out, sentence, match.group(1), match.start(1), match.end(1),
|
||
strict=True, arrow=True)
|
||
for match in BACKTICK.finditer(sentence):
|
||
_add(out, sentence, match.group(1), match.start(1), match.end(1))
|
||
return out
|
||
|
||
|
||
def _extract(description):
|
||
"""[(name, may_dangle, notation)] for every routing target."""
|
||
out = []
|
||
for sentence in SENTENCE_SPLIT.split(description):
|
||
out.extend(_extract_sentence(sentence))
|
||
return out
|
||
|
||
|
||
def boundary_targets(description):
|
||
"""Every routing target, for reporting and for confirming a route."""
|
||
return sorted({name for name, _, _ in _extract(description)})
|
||
|
||
|
||
def _arrow_targets(description):
|
||
"""Names extracted from ARROW notation specifically.
|
||
|
||
Kept apart from boundary_targets() because the arrow form is the one shape
|
||
that ALWAYS names a target: ADR-0020's `Not <thing> -> <name>`. A clause
|
||
written that way from which nothing could be extracted is a parse failure
|
||
that deserves its own message, and telling it apart needs the arrow targets
|
||
alone rather than every target in the description.
|
||
"""
|
||
out = []
|
||
for sentence in SENTENCE_SPLIT.split(description):
|
||
for match in ARROW_MARKED.finditer(sentence):
|
||
name, _, _ = _first(match)
|
||
if name:
|
||
out.append(name)
|
||
for match in ARROW_BOUNDARY.finditer(sentence):
|
||
out.append(match.group(1))
|
||
return out
|
||
|
||
|
||
def boundary_clause_status(description):
|
||
"""'absent', 'unparsed' or 'present' — three outcomes, not two.
|
||
|
||
Issue #110's standing request: the gate must distinguish "no boundary
|
||
clause" from "boundary clause I could not parse". Reporting the first for
|
||
the second sends the author hunting for a problem that is not there, and
|
||
three of them reworded a correct clause to satisfy a regex instead.
|
||
|
||
'unparsed' is the narrow, certain case: an ADR-0020 arrow clause was
|
||
detected and NO target came out of it. The arrow form always names one, so
|
||
zero targets means the name is written in a shape the extractor cannot see
|
||
— a single-word bare target (`Not X -> forge`, which has to be written
|
||
`` `forge` `` or `/forge`) is the live example, since single-word names are
|
||
deliberately not matchable bare.
|
||
|
||
A PROSE clause yielding no target is NOT reported: "Do not use for anything
|
||
else" is a complete and legitimate boundary clause that names nowhere to go.
|
||
"""
|
||
if BOUNDARY_ARROW.search(description) and not _arrow_targets(description):
|
||
return 'unparsed'
|
||
if has_boundary_clause(description):
|
||
return 'present'
|
||
return 'absent'
|
||
|
||
|
||
def multi_target_arrow_clauses(description):
|
||
"""[(first, second)] for arrow clauses naming more than one target.
|
||
|
||
Issue #107: only the FIRST target after an arrow is resolved. The
|
||
conjunction continuation (CONT_*) is wired to the prose route verbs and
|
||
never to arrows, so `Not X -> a or b` resolved `a`, left `b` neither
|
||
resolved nor reported, and then printed "1 of 1 boundary target(s) resolve"
|
||
on a clause naming two — a gate under-reporting its own coverage, which is
|
||
the one failure mode ADR-0020 says a gate must not have.
|
||
|
||
The clause is REJECTED rather than the arrow scan extended. Extending it
|
||
would widen the resolver's deliberately conservative false-positive tuning
|
||
across every arrow in the corpus; rejecting costs nothing and makes the
|
||
one-arrow-per-target convention — already what every retrofitted gitea
|
||
skill does in practice — explicit instead of folkloric. The caller emits a
|
||
SUGGESTION telling the author to split.
|
||
"""
|
||
hits = []
|
||
for sentence in SENTENCE_SPLIT.split(description):
|
||
matches = (list(ARROW_MARKED.finditer(sentence))
|
||
+ list(ARROW_BOUNDARY.finditer(sentence)))
|
||
for match in matches:
|
||
first, _, _ = _first(match)
|
||
if not first:
|
||
continue
|
||
cont = CONT_ANY.match(sentence, match.end())
|
||
if not cont:
|
||
continue
|
||
second, _, _ = _first(cont)
|
||
if second:
|
||
hits.append((first, second))
|
||
return hits
|
||
|
||
|
||
def unresolved_targets(description, known):
|
||
"""Targets resolving to nothing, split into (blocking, reported).
|
||
|
||
`blocking` earns a hard error; `reported` is SUGGESTION tier — named on
|
||
every run, never fatal. Three conditions gate the promotion, and all of them
|
||
are documented at length in the ATTRIBUTIVE USE and CORROBORATION notes
|
||
above:
|
||
|
||
1. the target must be terminal, not a compound modifier ("pre-commit
|
||
hooks" is prose about a tool, not a route),
|
||
2. it must be written in route notation (`/name`, `-> name`), OR
|
||
3. its own sentence must name another target that DOES resolve.
|
||
|
||
Everything else is reported and left alone. `known` is the resolved
|
||
universe from known_targets(); passing an empty set is not meaningful —
|
||
callers check for that first and decline out loud instead.
|
||
|
||
A NON-TERMINAL target is reported, never dropped. FOLLOWER_OK is a closed
|
||
whitelist of maybe eighty words, so the follower rule says "this token is
|
||
outside a list I keep" and not "this is prose" — and the old `continue`
|
||
turned that into invisibility at every tier. The gate then failed OPEN on
|
||
its own unfamiliarity: any target followed by a word nobody thought to
|
||
enumerate was neither blocked nor mentioned, so the check that did not run
|
||
said nothing about not running. The follower rule may withdraw the power to
|
||
BLOCK a commit — that is what it was added for, and the ATTRIBUTIVE USE note
|
||
above is the argument for it — but it may not withdraw visibility, which is
|
||
the same rule the corroboration tier already follows.
|
||
"""
|
||
blocking, reported = set(), set()
|
||
for sentence in SENTENCE_SPLIT.split(description):
|
||
found = _extract_sentence(sentence)
|
||
resolved = {normalize_target(name) for name, _, _ in found
|
||
if normalize_target(name) in known}
|
||
for name, may_dangle, notation in found:
|
||
key = normalize_target(name)
|
||
if key in known:
|
||
continue
|
||
if not may_dangle:
|
||
reported.add(name)
|
||
continue
|
||
if notation or (resolved - {key}):
|
||
blocking.add(name)
|
||
else:
|
||
reported.add(name)
|
||
return sorted(blocking), sorted(reported - blocking)
|
||
|
||
# --- Frontmatter ----------------------------------------------------------
|
||
# Tolerant on the way in, HARD-FAILING on the way out. A UTF-8 BOM, a leading
|
||
# blank line, trailing whitespace after either `---`, or CRLF line endings all
|
||
# defeated the old `^---\n(.*?)\n---`, and the miss was SILENT: every ADR-0020
|
||
# check was skipped and the file reported green (measured: a 550-character
|
||
# description with a 1,000-word body exited 0 behind a BOM). A file that cannot
|
||
# be measured must never report green, so every caller of these two ERRORs on a
|
||
# miss instead of moving on.
|
||
#
|
||
# The CLOSING marker is anchored at column 0 — deliberately NOT `[ \t]*---`.
|
||
# YAML block-scalar content must be indented deeper than its key, so an
|
||
# indented `---` inside a folded description is CONTENT; letting it close the
|
||
# frontmatter truncated the description mid-value and silently reclassified the
|
||
# rest as body, which is a vacuous green in both directions at once. Leading
|
||
# whitespace is still tolerated on the OPENING marker, where no such content
|
||
# can exist.
|
||
FRONTMATTER_RE = re.compile(
|
||
r'^[ \t\r\n]*---[ \t]*\r?\n(.*?)\r?\n---[ \t]*(?:\r?\n|\Z)', re.DOTALL)
|
||
|
||
|
||
def strip_bom(text):
|
||
return text[1:] if text.startswith(u'') else text
|
||
|
||
|
||
class FrontmatterError(Exception):
|
||
pass
|
||
|
||
|
||
def description_value(fm_text):
|
||
"""The description VALUE, with YAML folding resolved.
|
||
|
||
PyYAML is a HARD requirement, preflighted in bash. The hand-rolled fallback
|
||
this replaced diverged from a real parser across the FAIL boundary — one
|
||
corpus description measured 270 characters parsed and 412 unparsed, and a
|
||
quoted `"description"` key or an explicit `description: null` returned empty
|
||
from it, silently skipping the description AND routing checks. A gate that
|
||
disagrees with itself depending on which reader ran is worse than no gate.
|
||
|
||
This is the ONLY reader any of the three scripts may use to decide whether a
|
||
description is present. A line regex cannot: `description:` with no value
|
||
followed by `model: sonnet` lets `\\s*` cross the newline and captures the
|
||
NEXT key, which reads as a non-empty description, skips the "missing or
|
||
empty" failure, and then early-returns out of every ADR-0020 gate on the
|
||
genuinely empty folded value. That combination exited 0 with zero output on
|
||
a BLOCKING pre-push gate.
|
||
"""
|
||
try:
|
||
data = yaml.safe_load(fm_text)
|
||
except Exception as exc:
|
||
# Every FrontmatterError message is a COMPLETE clause, never a detail a
|
||
# caller wraps in one. Callers used to prefix a hard-coded "frontmatter
|
||
# is not valid YAML (...)", which is true only of this branch: the two
|
||
# type failures below come from frontmatter that parsed fine, and
|
||
# telling their author the YAML is invalid sends them hunting for a
|
||
# syntax error that is not there — on a blocking gate with no baseline.
|
||
raise FrontmatterError('frontmatter is not valid YAML (%s)'
|
||
% re.sub(r'\s+', ' ', str(exc)).strip())
|
||
if not isinstance(data, dict):
|
||
raise FrontmatterError('frontmatter is not a YAML mapping')
|
||
value = data.get('description')
|
||
if value is None:
|
||
return ''
|
||
if not isinstance(value, str):
|
||
# NOT str()-coerced. `description: true` became the 4-character "True"
|
||
# and sailed through the 400-character gate; a list or mapping was
|
||
# measured as its Python repr. Neither is a description a host can
|
||
# preload, so this is a parse failure, reported as one.
|
||
raise FrontmatterError(
|
||
'description is a %s, not a string' % type(value).__name__)
|
||
return re.sub(r'\s+', ' ', value).strip()
|
||
|
||
|
||
def hand_invoked(fm_text):
|
||
"""True when the frontmatter marks this file as reached only by hand.
|
||
|
||
`disable-model-invocation: true` removes a skill from the model-visible
|
||
listing entirely — it is not preloaded, and the Skill tool refuses to call
|
||
it — so its description is never matched against user intent. ADR-0020 and
|
||
skill-author's contract give such a skill ONE plain human-facing sentence:
|
||
no trigger list, no boundary clause. No validator knew the field existed
|
||
(issue #108), so the boundary-clause SUGGESTION fired on exactly the shape
|
||
the contract mandates, and its remedy — "add a boundary clause so the router
|
||
knows where NOT to send this skill" — was addressed to a router that cannot
|
||
see the skill at all. An author who followed the advice made the file worse.
|
||
|
||
Only the ROUTING rules are lifted. The body word budget still applies: the
|
||
body is loaded on invocation like any other, and competes with the caller's
|
||
live conversation the same way. So does the 400-character description FAIL —
|
||
a hand-invoked description is not preloaded, but it is still the one line
|
||
the user reads when choosing from the `/` menu, and the ceiling is the
|
||
outlier stop rather than the style target.
|
||
|
||
A parse failure returns False rather than raising. This is a MODIFIER on
|
||
other checks, not a check of its own: the frontmatter's validity is decided,
|
||
and failed, by description_value() on the same text, and raising a second
|
||
exception here would report one broken file twice with two different
|
||
diagnoses.
|
||
"""
|
||
try:
|
||
data = yaml.safe_load(fm_text)
|
||
except Exception:
|
||
return False
|
||
if not isinstance(data, dict):
|
||
return False
|
||
value = data.get('disable-model-invocation')
|
||
if isinstance(value, str):
|
||
# PyYAML already resolves the unquoted YAML 1.1 booleans, so this only
|
||
# catches a QUOTED "true" — which a host reads as truthy and which no
|
||
# gate should treat as opting back in to the routing rules.
|
||
return value.strip().lower() in ('true', 'yes', 'on')
|
||
return value is True
|
||
|
||
|
||
# --- Body-shape checks (skills only; agents have no references/ dir) -------
|
||
# Deterministic and countable, so they are enforced here. Whether a given
|
||
# gotcha is WARRANTED is semantic and stays the auditor's judgment, which is why
|
||
# both gotcha checks are SUGGESTION tier. A missing reference file is not a
|
||
# style opinion — it is a broken pointer — so that one is ERROR tier.
|
||
#
|
||
# Both read a FENCE-MASKED copy of the body. Scanning the raw body made a
|
||
# ```-fenced example a hard ERROR — and the skills most likely to carry one are
|
||
# skill-author and skill-audit, which DOCUMENT the references/ convention — and
|
||
# let a `## Gotchas` heading inside a fenced block stand in for the real
|
||
# section. Masking preserves every byte offset (content becomes spaces,
|
||
# newlines stay), so a span found in the mask slices the original.
|
||
GOTCHA_MAX_ENTRIES = 5
|
||
GOTCHA_MAX_BODY_FRACTION = 0.25
|
||
# The heading has to BE "Gotchas", not merely contain the word: `## Gotcha
|
||
# handling` and `## Why gotchas matter` are prose sections, and treating one as
|
||
# the Gotchas section measured a span that was never a gotcha list.
|
||
GOTCHA_HEADING = re.compile(r'^(#{1,6})[ \t]+(?:[^\n]*?[ \t])?gotchas?[ \t]*:?[ \t]*$',
|
||
re.I | re.M)
|
||
# Column 0 only. `^[ \t]{0,3}` counted a two-space-indented CHILD bullet as a
|
||
# top-level entry, so a five-entry section with sub-bullets reported nine.
|
||
GOTCHA_ENTRY = re.compile(r'^(?:[-*+]|\d+[.)])[ \t]+', re.M)
|
||
FENCE_OPEN = re.compile(r'^[ \t]{0,3}(`{3,}|~{3,})')
|
||
REFERENCE_POINTER = re.compile(
|
||
r'(?<![\w./-])(?:\./)?references/([A-Za-z0-9][A-Za-z0-9._/-]*\.md)')
|
||
# A pointer named in a sentence that says the file is GONE is a historical
|
||
# mention, not a dispatch entry: "the old `references/legacy.md` was removed in
|
||
# v2" is prose and must not be a hard ERROR. Narrow on purpose — a live
|
||
# dispatch table never describes its own target as removed, so this costs no
|
||
# recall.
|
||
REFERENCE_PAST = re.compile(
|
||
r'\b(?:removed|deleted|renamed|superseded|replaced|obsolete|deprecated'
|
||
r'|former|formerly|gone|no longer|used to)\b', re.I)
|
||
# A pointer QUALIFIED by another skill's name — "skill-audit's
|
||
# references/validation-scripts.md" — names a file that is deliberately NOT in
|
||
# this skill's directory. Requiring it on the local disk left NO legal spelling
|
||
# for a cross-skill reference at all: the only alternative, a full repo path
|
||
# (`plugins/kyberforge/.apm/skills/skill-audit/references/...`), is itself a
|
||
# FAIL under skill-audit's own file-structure rubric, because a path that climbs
|
||
# out of the skill directory stops resolving once the plugin is cache-installed.
|
||
# The possessive form is the sanctioned spelling, and it is skipped here. It is
|
||
# not checked further — this function has no way to locate another skill's
|
||
# directory, and inventing one would reintroduce exactly the cross-plugin path
|
||
# assumption the rubric forbids.
|
||
REFERENCE_QUALIFIER = re.compile(u"[A-Za-z0-9][A-Za-z0-9._-]*`?['’]s[ \t]+`?$")
|
||
|
||
|
||
def mask_fenced(text):
|
||
"""Body with fenced code blocks blanked out, byte offsets preserved."""
|
||
out = []
|
||
fence = None
|
||
for line in text.splitlines(keepends=True):
|
||
stripped = line.rstrip('\r\n')
|
||
opener = FENCE_OPEN.match(stripped)
|
||
marker = opener.group(1) if opener else None
|
||
if fence is None:
|
||
if marker:
|
||
fence = marker
|
||
out.append(' ' * len(stripped) + line[len(stripped):])
|
||
continue
|
||
out.append(line)
|
||
else:
|
||
out.append(' ' * len(stripped) + line[len(stripped):])
|
||
if (marker and marker[0] == fence[0] and len(marker) >= len(fence)
|
||
and not stripped.strip()[len(marker):].strip()):
|
||
fence = None
|
||
# An UNCLOSED fence has no cost-free answer, only a choice of which way to
|
||
# be wrong. Masking to end-of-body blanks the rest of the body, silently
|
||
# disabling the ERROR-tier references/ check and the gotcha counts.
|
||
# Returning the raw text instead exposes the unclosed example's own
|
||
# content, so a fenced example naming a nonexistent references/ file
|
||
# becomes a hard ERROR it would not have been had the fence been closed —
|
||
# confirmed, not hypothetical. The loud-false-positive direction is the one
|
||
# chosen: this script's rule is that a file it cannot measure must never
|
||
# report green, and masking-onward is exactly that failure. Both outcomes
|
||
# need an already-malformed file, and the false positive costs one fence.
|
||
if fence is not None:
|
||
return text
|
||
return ''.join(out)
|
||
|
||
|
||
def gotcha_stats(body):
|
||
"""(entry count, section word count) for the first Gotchas section, or None.
|
||
|
||
The section runs to the next heading at the same level or shallower.
|
||
Entries are top-level list items; a section written as subheadings instead
|
||
of a list counts those. Headings and entries are read from the fence mask;
|
||
the word count is taken from the original slice, because fenced lines are
|
||
real body words and the fraction is measured against the whole body.
|
||
"""
|
||
masked = mask_fenced(body)
|
||
match = GOTCHA_HEADING.search(masked)
|
||
if not match:
|
||
return None
|
||
level = len(match.group(1))
|
||
rest = masked[match.end():]
|
||
nxt = re.search(r'^#{1,%d}[ \t]+' % level, rest, re.M)
|
||
end = match.end() + (nxt.start() if nxt else len(rest))
|
||
section = masked[match.end():end]
|
||
entries = len(GOTCHA_ENTRY.findall(section))
|
||
if entries == 0 and level < 6:
|
||
entries = len(re.findall(r'^#{%d,6}[ \t]+' % (level + 1), section, re.M))
|
||
return entries, len(body[match.end():end].split())
|
||
|
||
|
||
def missing_reference_pointers(body, skill_dir):
|
||
"""references/<file>.md named in the body but absent from disk."""
|
||
masked = mask_fenced(body)
|
||
missing = set()
|
||
for match in REFERENCE_POINTER.finditer(masked):
|
||
start = masked.rfind('\n', 0, match.start()) + 1
|
||
end = masked.find('\n', match.end())
|
||
if end < 0:
|
||
end = len(masked)
|
||
# The pointer's OWN SPAN is excised before the sweep. Run over the
|
||
# whole line, the past-tense test matched the very path it was judging,
|
||
# so a file exempted itself by its NAME: `references/deprecated-api.md`,
|
||
# `references/removed-flags.md` and `references/gone.md` produced no
|
||
# ERROR at all, while `references/missing.md` — an identical break —
|
||
# errored. The exemption is about what the SENTENCE says about the
|
||
# pointer, never about what the pointer is called.
|
||
line = masked[start:match.start()] + masked[match.end():end]
|
||
if REFERENCE_PAST.search(line):
|
||
continue
|
||
if REFERENCE_QUALIFIER.search(masked[start:match.start()]):
|
||
continue
|
||
if not os.path.isfile(os.path.join(skill_dir, 'references', match.group(1))):
|
||
missing.add('references/' + match.group(1))
|
||
return sorted(missing)
|
||
# ===== END ADR-0020 SHARED BOUNDARY RESOLVER =====
|
||
|
||
|
||
# A leading BOM is stripped before anything is parsed or counted. It changes
|
||
# neither count below — it is not a line separator and str.split() does not
|
||
# treat it as whitespace — but it did defeat the frontmatter match.
|
||
try:
|
||
content = strip_bom(read_text(skill_md))
|
||
except EncodingError as exc:
|
||
fail(f"SKILL.md is {exc}. Nothing downstream can be measured, so this is a "
|
||
f"hard failure, not a skip")
|
||
print("One or more checks failed.")
|
||
sys.exit(1)
|
||
|
||
# --- Parse frontmatter ---
|
||
fm_match = FRONTMATTER_RE.match(content)
|
||
if not fm_match:
|
||
fail("No parseable YAML frontmatter block found. Expected a `---` line, the "
|
||
"fields, then a closing `---` line (a BOM, leading blank lines, trailing "
|
||
"spaces after either marker and CRLF endings are all tolerated). Nothing "
|
||
"downstream can be measured, so this is a hard failure, not a skip")
|
||
print("One or more checks failed.")
|
||
sys.exit(1)
|
||
|
||
fm = fm_match.group(1)
|
||
body_start = fm_match.end()
|
||
|
||
# Extract name. The character class is `[ \t]`, never `\s`: under re.MULTILINE
|
||
# a `\s*` after the colon crosses the newline, so a valueless `name:` followed
|
||
# by `description: ...` captured the NEXT KEY as the name and reported a
|
||
# mismatch instead of an absence. Same class of bug as the `description:` one
|
||
# the shared resolver's description_value() docstring records.
|
||
name_m = re.search(r'^name:[ \t]*(\S+)', fm, re.MULTILINE)
|
||
name = name_m.group(1).strip('"\'') if name_m else ""
|
||
|
||
# Extract description — the VALUE, with YAML folding resolved. Most of this
|
||
# corpus writes descriptions as `>`-folded block scalars, so the raw lines
|
||
# carry indentation and newlines that are not part of the value: every length
|
||
# measurement below is wrong unless the scalar is folded first.
|
||
try:
|
||
desc = description_value(fm)
|
||
except FrontmatterError as exc:
|
||
# `exc` carries the whole clause — invalid YAML, a non-mapping block, or a
|
||
# description of the wrong type. Do not prefix a diagnosis here; the last
|
||
# one named a syntax error for two failures that have none.
|
||
fail(f"{exc}. Nothing downstream can be measured, so this is a hard "
|
||
f"failure, not a skip")
|
||
print("One or more checks failed.")
|
||
sys.exit(1)
|
||
|
||
dir_name = os.path.basename(skill_dir)
|
||
|
||
# ADR-0020's hand-invocation carve-out (issue #108). `disable-model-invocation:
|
||
# true` takes the skill out of the model-visible listing entirely, so the
|
||
# trigger/capability/boundary rules and the 250-character routing target do not
|
||
# apply to it — the audit's own references/description-quality.md Step 0 says
|
||
# so, and until this line existed no check here knew the field existed. What the
|
||
# flag does NOT lift: the body word budget and the 400-character description
|
||
# ceiling. See the shared resolver's hand_invoked().
|
||
by_hand = hand_invoked(fm)
|
||
|
||
# --- Checks ---
|
||
|
||
# name present
|
||
if name:
|
||
ok(f"name present: '{name}'")
|
||
else:
|
||
fail("name field is missing or empty")
|
||
|
||
# name matches directory
|
||
if name and dir_name:
|
||
if name == dir_name:
|
||
ok(f"name '{name}' matches directory '{dir_name}'")
|
||
else:
|
||
fail(f"name '{name}' does not match directory '{dir_name}'")
|
||
|
||
# name length
|
||
if name:
|
||
if len(name) <= 64:
|
||
ok(f"name length {len(name)} chars (limit: 64)")
|
||
else:
|
||
fail(f"name '{name}' is {len(name)} chars — exceeds 64-character limit")
|
||
|
||
# name format
|
||
if name:
|
||
if re.match(r'^[a-z0-9]+(-[a-z0-9]+)*$', name):
|
||
ok("name format valid (kebab-case)")
|
||
else:
|
||
fail(f"name '{name}' is invalid — use lowercase letters, numbers, and hyphens only; no leading, trailing, or consecutive hyphens")
|
||
|
||
# description present
|
||
if desc:
|
||
ok("description present")
|
||
else:
|
||
fail("description field is missing or empty")
|
||
|
||
# description length — agentskills.io spec backstop. UNCHANGED by ADR-0020:
|
||
# 1024 is the specification's hard limit, and the ADR-0020 budget gate below
|
||
# sits underneath it rather than replacing it.
|
||
if desc:
|
||
dlen = len(desc)
|
||
if dlen <= 1024:
|
||
ok(f"description length {dlen} chars (agentskills.io spec limit: 1024)")
|
||
else:
|
||
fail(f"description length {dlen} chars — exceeds 1024-character limit")
|
||
|
||
# Unfilled placeholder detection — matches FILL IN: followed by actual content,
|
||
# but not backtick-quoted references like `FILL IN:` used in instructions.
|
||
PLACEHOLDER_RE = re.compile(r'(?<!`)FILL IN:[^`\n]')
|
||
|
||
# description contains unfilled placeholder
|
||
if desc and PLACEHOLDER_RE.search(desc):
|
||
fail("description still contains 'FILL IN:' placeholder — replace before shipping")
|
||
else:
|
||
if desc:
|
||
ok("description has no unfilled placeholders")
|
||
|
||
# --- ADR-0022: metadata.version is mandatory -------------------------------
|
||
# FAIL, not SUGGESTION, and the tier is set by the gate rather than by taste.
|
||
# `.pre-commit-config.yaml`'s `skill-frontmatter` hook REJECTS a SKILL.md with
|
||
# no `metadata.version`, and rejects a value that is not three-part semver.
|
||
# skill-author's Step 4 says to run this audit and "resolve every FAIL", so any
|
||
# tier below FAIL lets that step report done on a skill the commit gate then
|
||
# refuses — the same audit-disagrees-with-the-gate failure the MAX_LINES note
|
||
# below warns about, arrived at from the other direction. Verified before this
|
||
# check existed: a SKILL.md with no `metadata:` block at all reported "All
|
||
# checks passed".
|
||
#
|
||
# The rule is DUPLICATED from that hook for the same cache-isolation reason as
|
||
# every other constant here — an installed plugin's scripts cannot read the
|
||
# repo-root config. Keep the two in step: this check must accept exactly what
|
||
# the hook accepts.
|
||
SEMVER_RE = re.compile(r'^\d+\.\d+\.\d+$')
|
||
|
||
try:
|
||
fm_data = yaml.safe_load(fm)
|
||
except Exception:
|
||
# Unreachable in practice: description_value() above parses the same text
|
||
# and hard-exits on a YAML error, so anything arriving here already parsed.
|
||
fm_data = None
|
||
metadata_block = fm_data.get('metadata') if isinstance(fm_data, dict) else None
|
||
|
||
if not isinstance(metadata_block, dict) or metadata_block.get('version') is None:
|
||
fail("frontmatter has no metadata.version — ADR-0022 makes it mandatory for "
|
||
"every skill, and the skill-frontmatter pre-commit hook rejects the file "
|
||
"without it. Add `metadata:` / ` version: \"1.0.0\"` (new skills start "
|
||
"at \"0.1.0\")")
|
||
else:
|
||
version_value = metadata_block['version']
|
||
# NOT str()-coerced blind: `version: 1.0` is a YAML float, and its "1.0"
|
||
# spelling is exactly the two-part value the hook rejects — coercing and
|
||
# then matching keeps this check and the hook agreeing on that case.
|
||
version_text = version_value if isinstance(version_value, str) else str(version_value)
|
||
version_text = version_text.strip()
|
||
if SEMVER_RE.match(version_text):
|
||
ok(f"metadata.version present: '{version_text}' (ADR-0022)")
|
||
else:
|
||
fail(f"metadata.version '{version_text}' is not three-part semver — the "
|
||
f"skill-frontmatter pre-commit hook rejects it. Use MAJOR.MINOR.PATCH, "
|
||
f"e.g. \"1.0.0\"")
|
||
|
||
# SKILL.md size ceilings (agentskills.io skill-authoring.md: 500 lines,
|
||
# ~5,000 tokens). Both constants are DUPLICATED from the repo-root pre-commit
|
||
# hook scripts/skill-size-check.sh — a plugin skill's scripts cannot read files
|
||
# outside the plugin directory once the plugin is cache-installed, so there is
|
||
# no single source to share. Keep the two in sync by hand: if they drift, this
|
||
# audit will report a skill ready to ship that the commit hook then rejects.
|
||
MAX_LINES = 500
|
||
# Word-count proxy for the ~5,000-token ceiling, calibrated to the densest
|
||
# prose in the corpus (7.22 chars/word): 2770 words is ~20,000 characters,
|
||
# ~5,000 tokens at 4 characters per token. See skill-size-check.sh's header
|
||
# for the full measurement.
|
||
MAX_WORDS = 2770
|
||
|
||
# ADR-0020 context-budget gates. DUPLICATED from scripts/skill-size-check.sh
|
||
# for exactly the same cache-isolation reason as MAX_LINES/MAX_WORDS above, and
|
||
# carrying the same warning — tests/test-skill-size-check.sh asserts the copies
|
||
# agree, so drift fails CI instead of shipping an audit that disagrees with the
|
||
# commit hook. agent-audit/scripts/validate.sh holds a third copy of the two
|
||
# description constants; per ADR-0020 agents take the description gates and
|
||
# deliberately take NO body word gate, because an agent body becomes the system
|
||
# prompt of a fresh context rather than competing with a live conversation.
|
||
#
|
||
# These are NOT the same measurements as MAX_LINES/MAX_WORDS and must not be
|
||
# unified with them: MAX_WORDS counts the WHOLE FILE including frontmatter and
|
||
# is a spec-conformance backstop; BODY_MAX_WORDS counts the body ONLY and is a
|
||
# quality gate. Likewise the 1024-character description limit above is the
|
||
# agentskills.io spec ceiling and stays exactly as it is — DESC_MAX_CHARS sits
|
||
# underneath it.
|
||
DESC_SUGGEST_CHARS = 250
|
||
DESC_MAX_CHARS = 400
|
||
BODY_SUGGEST_WORDS = 600
|
||
BODY_MAX_WORDS = 900
|
||
|
||
line_count = len(content.splitlines())
|
||
if line_count <= MAX_LINES:
|
||
ok(f"SKILL.md line count {line_count} (limit: {MAX_LINES})")
|
||
else:
|
||
fail(f"SKILL.md line count {line_count} — exceeds {MAX_LINES}-line limit")
|
||
|
||
# str.split() with no argument splits on runs of whitespace, matching the
|
||
# `wc -w` the hook uses, and counts the whole file including frontmatter.
|
||
word_count = len(content.split())
|
||
if word_count <= MAX_WORDS:
|
||
ok(f"SKILL.md word count {word_count} (limit: {MAX_WORDS}, proxy for ~5,000 tokens)")
|
||
else:
|
||
fail(f"SKILL.md word count {word_count} — exceeds {MAX_WORDS}-word limit (proxy for ~5,000 tokens)")
|
||
|
||
body = content[body_start:]
|
||
|
||
# --- ADR-0020: description budget -----------------------------------------
|
||
if desc:
|
||
dlen = len(desc)
|
||
if dlen > DESC_MAX_CHARS:
|
||
fail(f"description is {dlen} chars — exceeds the {DESC_MAX_CHARS}-character "
|
||
f"ADR-0020 ceiling. It is preloaded into every session whether or not the "
|
||
f"skill is invoked. Keep a trigger clause, at most one capability clause, "
|
||
f"and a boundary clause; move capability enumeration, output-format detail, "
|
||
f"composition notes and implementation detail to the body or README.md")
|
||
elif dlen > DESC_SUGGEST_CHARS and not by_hand:
|
||
suggest(f"description is {dlen} chars — over the {DESC_SUGGEST_CHARS}-character "
|
||
f"ADR-0020 target (hard fail at {DESC_MAX_CHARS}). The SUGGESTION tier is "
|
||
f"what moves the corpus average; the FAIL tier only stops outliers")
|
||
elif by_hand:
|
||
ok(f"description length {dlen} chars (hand-invoked: the {DESC_SUGGEST_CHARS}-character "
|
||
f"routing target does not apply, the {DESC_MAX_CHARS}-character ceiling still does)")
|
||
else:
|
||
ok(f"description length {dlen} chars (ADR-0020 target: {DESC_SUGGEST_CHARS})")
|
||
|
||
# --- ADR-0020: body budget -------------------------------------------------
|
||
# Counts the BODY ONLY — everything after the closing --- of the frontmatter.
|
||
# This is a different measurement from MAX_WORDS above, which counts the whole
|
||
# file including frontmatter as a spec-conformance backstop. Both are reported.
|
||
body_word_count = len(body.split())
|
||
if body_word_count > BODY_MAX_WORDS:
|
||
fail(f"SKILL.md body is {body_word_count} words — exceeds the {BODY_MAX_WORDS}-word "
|
||
f"ADR-0020 ceiling (body only; separate from the {MAX_WORDS}-word whole-file "
|
||
f"limit above). Move lookup tables, spec restatements, output schemas, templates "
|
||
f"and rationale prose to references/ behind an explicit "
|
||
f"\"If X, read `references/file.md`\" trigger. At two or more mutually exclusive "
|
||
f"flows, dispatch is mandatory: the body carries the dispatch table and the gates "
|
||
f"common to every branch, each flow gets its own self-contained references/ file")
|
||
elif body_word_count > BODY_SUGGEST_WORDS:
|
||
suggest(f"SKILL.md body is {body_word_count} words — over the {BODY_SUGGEST_WORDS}-word "
|
||
f"ADR-0020 target (hard fail at {BODY_MAX_WORDS})")
|
||
else:
|
||
ok(f"SKILL.md body word count {body_word_count} (ADR-0020 target: {BODY_SUGGEST_WORDS})")
|
||
|
||
# --- Reference pointers must exist -----------------------------------------
|
||
# FAIL, not SUGGESTION: a dispatch table naming a references/ file that is not
|
||
# on disk is a hard break, and until this check existed nothing in the
|
||
# gate/audit/vale stack noticed it — all three exited 0.
|
||
missing_refs = missing_reference_pointers(body, skill_dir)
|
||
for ref in missing_refs:
|
||
fail(f"SKILL.md body points at {ref}, which does not exist on disk — a dispatch "
|
||
f"table or \"read X\" trigger naming a missing file sends the agent nowhere")
|
||
if not missing_refs:
|
||
ok("all referenced references/ files exist")
|
||
|
||
# --- Gotchas discipline -----------------------------------------------------
|
||
# SUGGESTION on both counts: the measurement is deterministic, but whether a
|
||
# given gotcha earns its place in the body is the auditor's judgment.
|
||
gotchas = gotcha_stats(body)
|
||
if gotchas is not None:
|
||
gotcha_entries, gotcha_words = gotchas
|
||
if gotcha_entries > GOTCHA_MAX_ENTRIES:
|
||
suggest(f"Gotchas section has {gotcha_entries} entries — over the "
|
||
f"{GOTCHA_MAX_ENTRIES}-entry guideline. A list that long is usually a "
|
||
f"missing references/ file or a design problem written up as a warning")
|
||
if body_word_count and gotcha_words > body_word_count * GOTCHA_MAX_BODY_FRACTION:
|
||
suggest(f"Gotchas section is {gotcha_words} of {body_word_count} body words "
|
||
f"({round(100.0 * gotcha_words / body_word_count)}%) — over the "
|
||
f"{round(100.0 * GOTCHA_MAX_BODY_FRACTION)}% guideline. Move the durable "
|
||
f"parts to references/ and keep the section for live traps")
|
||
|
||
# --- ADR-0020: boundary clause present -------------------------------------
|
||
# SUGGESTION, not FAIL: detecting the absence is deterministic, but whether
|
||
# this particular skill warrants a boundary clause is judgment. Both accepted
|
||
# shapes count — the prose markers and the compressed `Not <thing> -> <name>`.
|
||
#
|
||
# THREE outcomes, not two: "no boundary clause" and "boundary clause I could not
|
||
# parse" are different findings, and reporting the first for the second sends
|
||
# the author hunting for a problem that is not there (issue #110).
|
||
#
|
||
# Skipped entirely for a hand-invoked skill — the contract gives it one plain
|
||
# sentence with no boundary clause, so the finding would be wrong and its remedy
|
||
# names a router that cannot see the skill (issue #108).
|
||
if desc and by_hand:
|
||
ok("hand-invoked (disable-model-invocation) — the boundary-clause and trigger "
|
||
"rules do not apply; audited as one plain human-facing sentence")
|
||
elif desc:
|
||
status = boundary_clause_status(desc)
|
||
if status == 'present':
|
||
ok("description has a boundary clause")
|
||
elif status == 'absent':
|
||
suggest("description has no boundary clause — add the prose form (\"Do not use "
|
||
"for X — use `y` instead\") or ADR-0020's compressed form (\"Not X -> y\") "
|
||
"so the router knows where NOT to send this skill")
|
||
else:
|
||
suggest("description has an arrow boundary clause (\"Not X -> y\") from which no "
|
||
"target could be read, so the dangling-target check did not run on it — "
|
||
"the clause is PRESENT and unparsed, not missing. Most often the target is "
|
||
"a single word, which is deliberately not matchable bare because "
|
||
"`research`, `triage` and `forge` are all ordinary English: write it as "
|
||
"`name` or /name")
|
||
# One arrow, one target. A second name after the same arrow is resolved by
|
||
# nothing and reported by nothing, so the clause claims coverage it does not
|
||
# have and this script printed "1 of 1 boundary target(s) resolve" on a
|
||
# clause naming two (issue #107).
|
||
for first, second in multi_target_arrow_clauses(desc):
|
||
suggest(f"an arrow boundary clause names more than one target ('{first}', then "
|
||
f"'{second}') and only the first is resolved — the second is checked by "
|
||
f"nothing. Split it into one arrow per target: \"Not X -> {first}. "
|
||
f"Not Y -> {second}.\"")
|
||
|
||
# --- ADR-0020: resolvable boundary targets ---------------------------------
|
||
# The resolution universe comes from the SKILL's own location: the authoring
|
||
# root above it (every sibling plugin in the monorepo), its own apm package, and
|
||
# the packages that package declares in apm.yml dependencies.apm. It is never
|
||
# derived from this script's own path, and — when an authoring root exists — it
|
||
# never reads a deployed .claude/ tree, so a fresh clone and a machine that has
|
||
# run `apm install` return the same verdict. See the shared resolver's header.
|
||
if desc:
|
||
routing_targets = boundary_targets(desc)
|
||
known = known_targets(skill_dir) if routing_targets else set()
|
||
if routing_targets and not known:
|
||
info(f"boundary-target resolution DID NOT RUN — no skill universe could be "
|
||
f"determined for this path (no authoring root above it, no apm package "
|
||
f"root, no declared apm dependencies, no deployed .claude/ or .agents/ "
|
||
f"tree). Unchecked target(s): {', '.join(routing_targets)}")
|
||
elif routing_targets:
|
||
# blocking vs reported: a target only earns a FAIL when it is written in
|
||
# route notation or its own sentence corroborates it by naming another
|
||
# target that resolves. See the shared resolver's CORROBORATION note.
|
||
unresolved, soft = unresolved_targets(desc, known)
|
||
for target in unresolved:
|
||
fail(f"description routes to '{target}', which resolves to no skill or agent "
|
||
f"in this monorepo, in this package, or in a package it declares in "
|
||
f"apm.yml dependencies.apm — a boundary clause naming a non-existent "
|
||
f"target sends the router nowhere")
|
||
for target in soft:
|
||
suggest(f"description routes to '{target}', which resolves to no skill or agent "
|
||
f"in this monorepo, in this package, or in a package it declares in "
|
||
f"apm.yml dependencies.apm — SUGGESTION rather than FAIL because nothing "
|
||
f"else in that sentence resolves, so it is equally likely to be a tool, a "
|
||
f"file format or an English compound. If it IS a route, write it as "
|
||
f"`/{target}` or `-> {target}` and it will be checked properly")
|
||
if not unresolved:
|
||
# Counts the targets that ACTUALLY resolve, not every target found:
|
||
# a confirm-only target (one used attributively — see the resolver's
|
||
# ATTRIBUTIVE USE note) is exempt from the failure above, so
|
||
# reporting it as resolved would be a false claim.
|
||
resolved = [t for t in routing_targets if normalize_target(t) in known]
|
||
ok(f"{len(resolved)} of {len(routing_targets)} boundary target(s) resolve: "
|
||
f"{', '.join(resolved) if resolved else '(none)'}")
|
||
|
||
# Body unfilled placeholders
|
||
fill_matches = PLACEHOLDER_RE.findall(body)
|
||
if fill_matches:
|
||
fail(f"SKILL.md body contains {len(fill_matches)} unfilled 'FILL IN:' placeholder(s)")
|
||
else:
|
||
ok("SKILL.md body has no unfilled placeholders")
|
||
|
||
# Interactive prompt heuristic.
|
||
#
|
||
# A line-initial `read` only blocks an agent when its stdin is the terminal.
|
||
# These forms never touch a TTY and are ordinary data plumbing, so flagging
|
||
# them is a false positive — one that has already cost two authors a
|
||
# contorted rewrite of working source:
|
||
#
|
||
# read -r MODE ROOT <<< "$WALK_OUTPUT" here-string
|
||
# read -r X <<EOF here-doc
|
||
# read -r line < "$file" redirect from a file
|
||
# printf '%s' "$v" | piped stdin — the pipe ends the
|
||
# read -r X PREVIOUS line, not this one
|
||
#
|
||
# So a `read` is reported only when it has neither a stdin redirection on its
|
||
# own line nor a pipe terminating the previous logical line. `read -r ANSWER`,
|
||
# `read -p "..." X` and a bare `read` still fail, which is the case the check
|
||
# exists for.
|
||
def stdin_redirected(line, prev_line):
|
||
# Quoted spans are stripped first so a `<` inside a prompt string is not
|
||
# mistaken for a redirect: `read -p "enter <name>: " X` is interactive and
|
||
# must still fail.
|
||
unquoted = re.sub(r'"[^"]*"|\'[^\']*\'', '', line)
|
||
return '<' in unquoted or prev_line.rstrip().endswith('|')
|
||
|
||
# A here-doc body is DATA, not command position. Every script in this corpus
|
||
# carries a `usage() { cat <<EOF ... EOF; }`, and prose wrapped inside one puts
|
||
# ordinary English at the start of a line — "read is reported as an INFO ..."
|
||
# in this skill's own validate-provenance.sh, which made skill-audit hard-FAIL
|
||
# on its own script. Reflowing that one sentence would have cleared the finding
|
||
# and left the cause: every future usage text is one wrap away from the same
|
||
# false positive, and the remedy an author reaches for is contorting working
|
||
# source, which the note above records has already happened twice.
|
||
#
|
||
# Detection is deliberately conservative in the direction that matters. A
|
||
# here-doc body is skipped only when its terminator is actually found further
|
||
# down the file; an opener with no terminator — the shape a stray `<<` inside a
|
||
# string would produce — is ignored rather than allowed to swallow the tail,
|
||
# because swallowing the tail is a false NEGATIVE and this check exists to fail
|
||
# closed. `<<<` here-strings open nothing and are excluded by the lookbehind.
|
||
HEREDOC_START_RE = re.compile(r'(?<!<)<<-?\s*(["\']?)([A-Za-z_][A-Za-z0-9_]*)\1')
|
||
|
||
|
||
def heredoc_delimiter(line):
|
||
"""The here-doc terminator this line opens, or None."""
|
||
m = HEREDOC_START_RE.search(line)
|
||
return m.group(2) if m else None
|
||
|
||
|
||
def heredoc_body_indices(lines):
|
||
"""Line indices that are here-doc BODY (plus its terminator), not code."""
|
||
skip = set()
|
||
i, n = 0, len(lines)
|
||
while i < n:
|
||
stripped = lines[i].strip()
|
||
delim = None if stripped.startswith('#') else heredoc_delimiter(lines[i])
|
||
if delim:
|
||
# `<<-` allows an indented terminator, so compare stripped.
|
||
for j in range(i + 1, n):
|
||
if lines[j].strip() == delim:
|
||
skip.update(range(i + 1, j + 1))
|
||
i = j
|
||
break
|
||
i += 1
|
||
return skip
|
||
|
||
|
||
# The here-doc exemption applies to the `read` heuristic ONLY, and the
|
||
# asymmetry is the point. `read` is an ordinary English verb, so any prose a
|
||
# script prints is one line-wrap away from opening with it. `input(` is not a
|
||
# word — a line beginning `input(` inside a here-doc is an embedded Python
|
||
# program pausing for a keypress, which is exactly what this check is for, and
|
||
# these scripts embed Python in a here-doc as a matter of course. Exempting the
|
||
# whole body would have disarmed the check across every script in the corpus.
|
||
def interactive_reads(source):
|
||
hits = []
|
||
prev_line = ''
|
||
lines = source.splitlines()
|
||
in_heredoc = heredoc_body_indices(lines)
|
||
for idx, line in enumerate(lines):
|
||
stripped = line.strip()
|
||
if idx in in_heredoc:
|
||
if re.match(r'input\(', stripped):
|
||
hits.append(stripped)
|
||
continue
|
||
if re.match(r'read(\s|$)', stripped):
|
||
if not stdin_redirected(line, prev_line):
|
||
hits.append(stripped)
|
||
elif re.match(r'input\(', stripped):
|
||
hits.append(stripped)
|
||
# Blank lines and comments cannot carry the pipe that feeds a
|
||
# following `read`, so they never displace the previous line.
|
||
if stripped and not stripped.startswith('#'):
|
||
prev_line = line
|
||
return hits
|
||
|
||
# Scripts checks
|
||
scripts_dir = os.path.join(skill_dir, "scripts")
|
||
if os.path.isdir(scripts_dir):
|
||
scripts = [f for f in os.listdir(scripts_dir)
|
||
if os.path.isfile(os.path.join(scripts_dir, f)) and not f.endswith('.md')]
|
||
for fname in scripts:
|
||
fpath = os.path.join(scripts_dir, fname)
|
||
try:
|
||
sc = read_text(fpath)
|
||
except EncodingError as exc:
|
||
# The executable-bit check below still runs — one unreadable byte
|
||
# must not silently drop a second, independent check.
|
||
sc = None
|
||
fail(f"scripts/{fname}: {exc} — it could not be scanned for "
|
||
f"interactive prompts")
|
||
interactive = interactive_reads(sc) if sc is not None else []
|
||
if interactive:
|
||
fail(f"scripts/{fname}: may use interactive input "
|
||
f"(read/input from a terminal detected): {interactive[0]}")
|
||
elif sc is not None:
|
||
ok(f"scripts/{fname}: no interactive prompts detected")
|
||
# Executable bit
|
||
if os.access(fpath, os.X_OK):
|
||
ok(f"scripts/{fname}: is executable")
|
||
else:
|
||
fail(f"scripts/{fname}: not executable — run: chmod +x {fpath}")
|
||
|
||
# Summary
|
||
print()
|
||
for s in suggestions:
|
||
print(f"SUGGESTION {s}")
|
||
if suggestions:
|
||
print()
|
||
if not failed:
|
||
if suggestions:
|
||
# Feeds skill-audit's Step 4 `PASS (N suggestions)` result line. A
|
||
# SUGGESTION never changes the exit code — only a FAIL does.
|
||
print(f"All checks passed ({len(suggestions)} suggestion(s)).")
|
||
else:
|
||
print("All checks passed.")
|
||
sys.exit(0)
|
||
else:
|
||
print("One or more checks failed.")
|
||
sys.exit(1)
|
||
PYTHON
|