d4cec15b47
Behavior-neutral structural pass over tools/*: god-file extractions into sibling modules (file_operations_common/lint/search, file_tools_paths/ read_tracking/write, code_execution_env/rpc, tool_search_catalog/names/ validation, tts_command_provider, ...), duplicate helper unification, if/elif -> dispatch tables, dead-code removal, docstring compaction. Tool schemas (get_tool_definitions) verified byte-identical to base.
397 lines
14 KiB
Python
397 lines
14 KiB
Python
"""Structural + convention linter for SKILL.md files.
|
|
|
|
The hard *validator* (``tools/skill_manager_tool.py::_validate_frontmatter``)
|
|
blocks the non-negotiables (fence, YAML mapping, name/description, size caps).
|
|
This module is the softer companion encoding the CONTRIBUTING.md "Skill
|
|
authoring standards" that otherwise only a human reviewer catches: shell
|
|
utilities named instead of native tools, missing author/license/metadata,
|
|
``name`` != directory, dangling ``references/`` links, marketing words,
|
|
``platforms:`` gating vs POSIX-only scripts, forbidden scaffolding files.
|
|
|
|
Contract: findings are advisory — ``lint_skill`` returns ``LintFinding`` rows and
|
|
the caller decides what blocks. Pure functions (I/O limited to the files pointed
|
|
at) so CI, the ``skill_manage`` create path and local runs share one impl.
|
|
Frontmatter parsing is delegated to ``agent.skill_utils`` so BOM handling and
|
|
the prompt description budget stay in one place.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import re
|
|
from dataclasses import dataclass
|
|
from pathlib import Path
|
|
from typing import Any, Dict, List, Optional
|
|
|
|
from agent.skill_utils import (
|
|
SKILL_PROMPT_DESC_LIMIT,
|
|
parse_frontmatter,
|
|
)
|
|
|
|
# ── Rule data ────────────────────────────────────────────────────────────────
|
|
|
|
# Shell utilities already wrapped as native tools; naming them in prose steers
|
|
# the model to a raw shell call. banned token -> native tool to name instead.
|
|
_SHELL_UTIL_TO_TOOL: Dict[str, str] = {
|
|
"grep": "search_files",
|
|
"rg": "search_files",
|
|
"cat": "read_file",
|
|
"head": "read_file",
|
|
"tail": "read_file",
|
|
"sed": "patch",
|
|
"awk": "patch",
|
|
"find": "search_files (target='files')",
|
|
"ls": "search_files (target='files')",
|
|
}
|
|
|
|
# Marketing words the description must not contain.
|
|
_MARKETING_WORDS = (
|
|
"powerful",
|
|
"comprehensive",
|
|
"seamless",
|
|
"advanced",
|
|
"cutting-edge",
|
|
"state-of-the-art",
|
|
"revolutionary",
|
|
"robust",
|
|
)
|
|
|
|
# POSIX-only primitives that require ``platforms:`` when a bundled script uses
|
|
# them. Detected in scripts/, not in prose.
|
|
_POSIX_PRIMITIVES = (
|
|
"fcntl",
|
|
"termios",
|
|
"os.setsid", # windows-footgun: ok (search-pattern string, not a call)
|
|
"signal.SIGKILL", # windows-footgun: ok (search-pattern string, not a call)
|
|
"osascript",
|
|
"/proc/",
|
|
"apt-get",
|
|
"systemctl",
|
|
)
|
|
|
|
# Scaffolding files a skill should not ship (noise, not skill content).
|
|
_FORBIDDEN_FILES = (
|
|
"README.md",
|
|
"CHANGELOG.md",
|
|
"install.sh",
|
|
".env",
|
|
".env.example",
|
|
".gitignore",
|
|
)
|
|
|
|
# Presence of the load-bearing section is checked, not exact ordering, so the
|
|
# linter is not a change-detector.
|
|
_EXPECTED_SECTIONS = ("When to Use", "When to use")
|
|
|
|
ERROR = "error"
|
|
WARNING = "warning"
|
|
|
|
|
|
@dataclass
|
|
class LintFinding:
|
|
"""A single lint result. ``severity`` is advisory metadata for the caller."""
|
|
|
|
severity: str # ERROR | WARNING
|
|
rule: str
|
|
message: str
|
|
|
|
def format(self) -> str:
|
|
badge = "✗" if self.severity == ERROR else "⚠"
|
|
return f"{badge} [{self.rule}] {self.message}"
|
|
|
|
|
|
def _err(rule: str, message: str) -> LintFinding:
|
|
return LintFinding(ERROR, rule, message)
|
|
|
|
|
|
def _warn(rule: str, message: str) -> LintFinding:
|
|
return LintFinding(WARNING, rule, message)
|
|
|
|
|
|
# ── Individual checks ────────────────────────────────────────────────────────
|
|
|
|
|
|
def _check_name_matches_dir(
|
|
frontmatter: Dict[str, Any], skill_dir: Optional[Path]
|
|
) -> List[LintFinding]:
|
|
if skill_dir is None:
|
|
return []
|
|
name = str(frontmatter.get("name", "")).strip()
|
|
if name and name != skill_dir.name:
|
|
return [_err(
|
|
"name-dir-mismatch",
|
|
f"frontmatter name '{name}' does not match directory "
|
|
f"'{skill_dir.name}'; they must be identical.",
|
|
)]
|
|
return []
|
|
|
|
|
|
def _check_name_format(frontmatter: Dict[str, Any]) -> List[LintFinding]:
|
|
name = str(frontmatter.get("name", "")).strip()
|
|
if name and not re.fullmatch(r"[a-z0-9][a-z0-9_-]*", name):
|
|
return [_err(
|
|
"name-format",
|
|
f"name '{name}' must be lowercase letters, digits, hyphens, "
|
|
f"and underscores only.",
|
|
)]
|
|
return []
|
|
|
|
|
|
def _check_description(frontmatter: Dict[str, Any]) -> List[LintFinding]:
|
|
findings: List[LintFinding] = []
|
|
# Measure the raw authored value: extract_skill_description() already
|
|
# truncates to the prompt budget, so it can never exceed the limit.
|
|
desc = str(frontmatter.get("description", "")).strip().strip("'\"")
|
|
if not desc:
|
|
return findings
|
|
if len(desc) > SKILL_PROMPT_DESC_LIMIT:
|
|
findings.append(_warn(
|
|
"description-length",
|
|
f"description is {len(desc)} chars; the skill index truncates "
|
|
f"past {SKILL_PROMPT_DESC_LIMIT} chars + '...', losing routing "
|
|
f"signal. Keep it to one sentence.",
|
|
))
|
|
lower = desc.lower()
|
|
hits = [w for w in _MARKETING_WORDS if re.search(rf"\b{re.escape(w)}\b", lower)]
|
|
if hits:
|
|
findings.append(_warn(
|
|
"description-marketing",
|
|
f"description contains marketing words {hits}; state the "
|
|
f"capability, not adjectives.",
|
|
))
|
|
return findings
|
|
|
|
|
|
def _check_metadata_block(frontmatter: Dict[str, Any]) -> List[LintFinding]:
|
|
findings: List[LintFinding] = []
|
|
for key in ("version", "author", "license"):
|
|
if key not in frontmatter:
|
|
findings.append(_warn(
|
|
"missing-metadata",
|
|
f"frontmatter is missing '{key}'; every peer skill has it.",
|
|
))
|
|
meta = frontmatter.get("metadata")
|
|
hermes_meta = meta.get("hermes") if isinstance(meta, dict) else None
|
|
if not isinstance(hermes_meta, dict):
|
|
findings.append(_warn(
|
|
"missing-metadata",
|
|
"frontmatter is missing metadata.hermes.{tags, related_skills}.",
|
|
))
|
|
elif "tags" not in hermes_meta:
|
|
findings.append(_warn("missing-metadata", "metadata.hermes.tags is missing."))
|
|
author = str(frontmatter.get("author", ""))
|
|
if author and author.strip().lower() in ("hermes", "agent", "hermes agent") and (
|
|
author != "Hermes Agent"
|
|
):
|
|
findings.append(_warn(
|
|
"author-caps",
|
|
f"author '{author}' should be 'Hermes Agent' (proper caps) "
|
|
f"or a real contributor name.",
|
|
))
|
|
return findings
|
|
|
|
|
|
def _check_shell_utilities(body: str) -> List[LintFinding]:
|
|
"""Flag banned shell utilities named in PROSE (not fenced code blocks)."""
|
|
prose = _strip_code_blocks(body)
|
|
# Only backtick-wrapped mentions: bare words in sentences are too noisy.
|
|
return [
|
|
_warn(
|
|
"shell-utility-reference",
|
|
f"prose references `{util}`; name the native tool "
|
|
f"`{tool}` instead.",
|
|
)
|
|
for util, tool in _SHELL_UTIL_TO_TOOL.items()
|
|
if re.search(rf"`{re.escape(util)}`", prose)
|
|
]
|
|
|
|
|
|
def _check_sections(body: str) -> List[LintFinding]:
|
|
if not any(re.search(rf"^#+\s+{re.escape(s)}", body, re.M) for s in _EXPECTED_SECTIONS):
|
|
return [_warn(
|
|
"missing-section",
|
|
"no '## When to Use' section found; skills need explicit "
|
|
"trigger conditions near the top.",
|
|
)]
|
|
return []
|
|
|
|
|
|
def _check_reference_links(body: str, skill_dir: Optional[Path]) -> List[LintFinding]:
|
|
"""Flag references/ links in the body that don't resolve on disk."""
|
|
if skill_dir is None:
|
|
return []
|
|
findings: List[LintFinding] = []
|
|
seen: set[str] = set()
|
|
# Only references/, templates/, assets/ are reliably skill-owned; `scripts/`
|
|
# is excluded because dev skills legitimately cite repo-root scripts.
|
|
for match in re.finditer(r"(references|templates|assets)/[\w./-]+", body):
|
|
rel = match.group(0)
|
|
if rel in seen:
|
|
continue
|
|
seen.add(rel)
|
|
if "*" in rel or rel.endswith("/"): # placeholders / globs
|
|
continue
|
|
if not (skill_dir / rel).exists():
|
|
findings.append(_warn(
|
|
"dangling-reference",
|
|
f"body references '{rel}' but that file does not exist "
|
|
f"in the skill directory.",
|
|
))
|
|
return findings
|
|
|
|
|
|
def _check_platforms_gating(
|
|
frontmatter: Dict[str, Any], skill_dir: Optional[Path]
|
|
) -> List[LintFinding]:
|
|
"""If bundled scripts use POSIX-only primitives, require platforms:."""
|
|
if skill_dir is None or frontmatter.get("platforms"):
|
|
return []
|
|
scripts_dir = skill_dir / "scripts"
|
|
if not scripts_dir.is_dir():
|
|
return []
|
|
offenders: Dict[str, List[str]] = {}
|
|
for script in scripts_dir.rglob("*"):
|
|
if not script.is_file() or script.suffix not in (".py", ".sh", ".bash"):
|
|
continue
|
|
try:
|
|
text = script.read_text(encoding="utf-8", errors="ignore")
|
|
except OSError:
|
|
continue
|
|
hit = [p for p in _POSIX_PRIMITIVES if p in text]
|
|
if hit:
|
|
offenders[script.name] = hit
|
|
if offenders:
|
|
detail = "; ".join(f"{k}: {v}" for k, v in offenders.items())
|
|
return [_warn(
|
|
"platforms-gating",
|
|
f"scripts use POSIX-only primitives ({detail}) but no "
|
|
f"'platforms:' frontmatter is declared. Fix cross-platform or "
|
|
f"gate with platforms: [linux, macos].",
|
|
)]
|
|
return []
|
|
|
|
|
|
def _check_forbidden_files(skill_dir: Optional[Path]) -> List[LintFinding]:
|
|
if skill_dir is None:
|
|
return []
|
|
return [
|
|
_warn(
|
|
"forbidden-file",
|
|
f"skill ships '{fname}'; skills should not include "
|
|
f"scaffolding/config files.",
|
|
)
|
|
for fname in _FORBIDDEN_FILES
|
|
if (skill_dir / fname).exists()
|
|
]
|
|
|
|
|
|
def _check_platform_list_valid(frontmatter: Dict[str, Any]) -> List[LintFinding]:
|
|
platforms = frontmatter.get("platforms")
|
|
if not platforms:
|
|
return []
|
|
valid = {"linux", "macos", "windows", "darwin"}
|
|
items = platforms if isinstance(platforms, list) else [platforms]
|
|
bad = [p for p in items if str(p).lower() not in valid]
|
|
if bad:
|
|
return [_warn(
|
|
"platforms-value",
|
|
f"platforms contains unrecognized value(s) {bad}; expected a "
|
|
f"subset of {sorted(valid)}.",
|
|
)]
|
|
return []
|
|
|
|
|
|
def _strip_code_blocks(body: str) -> str:
|
|
"""Remove fenced code blocks so prose-only checks don't fire on examples."""
|
|
return re.sub(r"```.*?```", "", body, flags=re.S)
|
|
|
|
|
|
# ── Public API ───────────────────────────────────────────────────────────────
|
|
|
|
|
|
def lint_content(
|
|
content: str, *, skill_dir: Optional[Path] = None
|
|
) -> List[LintFinding]:
|
|
"""Lint raw SKILL.md *content*.
|
|
|
|
``skill_dir`` enables on-disk checks (name/dir match, dangling links,
|
|
POSIX gating, forbidden files); without it only content checks run,
|
|
which is what the create path needs before the file exists.
|
|
"""
|
|
frontmatter, body = parse_frontmatter(content)
|
|
findings: List[LintFinding] = []
|
|
findings += _check_name_format(frontmatter)
|
|
findings += _check_name_matches_dir(frontmatter, skill_dir)
|
|
findings += _check_description(frontmatter)
|
|
findings += _check_metadata_block(frontmatter)
|
|
findings += _check_platform_list_valid(frontmatter)
|
|
findings += _check_shell_utilities(body)
|
|
findings += _check_sections(body)
|
|
findings += _check_reference_links(body, skill_dir)
|
|
findings += _check_platforms_gating(frontmatter, skill_dir)
|
|
findings += _check_forbidden_files(skill_dir)
|
|
return findings
|
|
|
|
|
|
def lint_skill(skill_md_path: Path) -> List[LintFinding]:
|
|
"""Lint a SKILL.md file on disk, with all on-disk checks enabled."""
|
|
skill_md_path = Path(skill_md_path)
|
|
content = skill_md_path.read_text(encoding="utf-8", errors="ignore")
|
|
return lint_content(content, skill_dir=skill_md_path.parent)
|
|
|
|
|
|
def format_findings(findings: List[LintFinding]) -> str:
|
|
"""Render findings as a newline-joined human-readable block."""
|
|
return "\n".join(f.format() for f in findings)
|
|
|
|
|
|
def has_errors(findings: List[LintFinding]) -> bool:
|
|
return any(f.severity == ERROR for f in findings)
|
|
|
|
|
|
def _main(argv: Optional[List[str]] = None) -> int:
|
|
"""CLI: ``python -m tools.skill_linter <SKILL.md | skill-dir> ...``
|
|
|
|
Exit 1 only on ERROR-severity findings (WARNING-only exits 0) so CI can
|
|
gate on structural breakage without failing on advisory nits.
|
|
"""
|
|
import sys
|
|
|
|
args = argv if argv is not None else sys.argv[1:]
|
|
if not args:
|
|
print("usage: python -m tools.skill_linter <SKILL.md | skill-dir> ...")
|
|
return 2
|
|
|
|
targets: List[Path] = []
|
|
for arg in args:
|
|
p = Path(arg)
|
|
if p.is_dir():
|
|
targets.extend(sorted(p.rglob("SKILL.md")))
|
|
elif p.name == "SKILL.md" and p.is_file():
|
|
targets.append(p)
|
|
else:
|
|
print(f"skip (not a SKILL.md or dir): {arg}")
|
|
|
|
any_error = False
|
|
total = 0
|
|
for skill_md in targets:
|
|
findings = lint_skill(skill_md)
|
|
if not findings:
|
|
continue
|
|
total += len(findings)
|
|
if has_errors(findings):
|
|
any_error = True
|
|
print(f"\n{skill_md.parent.name} ({skill_md}):")
|
|
print(format_findings(findings))
|
|
|
|
if total == 0:
|
|
print(f"All {len(targets)} skill(s) clean.")
|
|
else:
|
|
print(f"\n{total} finding(s) across {len(targets)} skill(s).")
|
|
return 1 if any_error else 0
|
|
|
|
|
|
if __name__ == "__main__":
|
|
import sys
|
|
|
|
sys.exit(_main())
|