.skillsaw.yaml

# skillsaw configuration
# See https://github.com/stbenjam/skillsaw for more information

# Pin to the skillsaw version this config targets so rules added in later
# versions are enabled (see CI: .github/workflows/skillsaw.yml).
version: "0.16.0"

# Enable/disable rules with configurable severity levels
rules:
  # Plugin Structure
  plugin-json-required:
    enabled: true
    severity: error

  plugin-json-valid:
    enabled: true
    severity: error

  plugin-naming:
    enabled: true
    severity: warning

  plugin-readme:
    enabled: true
    severity: warning

  # Command Format
  command-naming:
    enabled: true
    severity: warning

  command-frontmatter:
    enabled: true
    severity: error

  # Checks for Name, Synopsis, Description, Implementation sections
  command-sections:
    enabled: true
    severity: warning

  # Enforce "plugin:command" format
  command-name-format:
    enabled: true
    severity: warning

  # Marketplace (auto on marketplace repos)
  marketplace-json-valid:
    enabled: auto
    severity: error

  marketplace-registration:
    enabled: auto
    severity: error

  # Skills
  skill-frontmatter:
    enabled: true
    severity: warning

  # Custom: Enforce Agent Skills specification directory structure
  skill-directory-structure:
    enabled: true
    severity: error

  # Custom: Enforce that all skills are documented in plugin README.md
  skill-readme-documentation:
    enabled: true
    severity: error

  # Custom: Enforce kebab-case naming for markdown files in skills/
  skill-markdown-naming:
    enabled: true
    severity: error

  # Custom: Enforce license and metadata.author in SKILL.md frontmatter
  skill-required-metadata:
    enabled: true
    severity: error

  # Custom: presence check only — require the openclaw block plus emoji and
  # homepage in SKILL.md frontmatter. Field *shape* validation (os, requires,
  # install, ...) is delegated to the built-in openclaw-metadata rule below, so
  # this rule intentionally does not re-validate those fields.
  skill-openclaw-metadata:
    enabled: true
    severity: error

  # Built-in: validate the shape of every metadata.openclaw field (os values,
  # requires/install structure, install kinds, archive types, ...). Ships with
  # skillsaw and defaults to warning; promote to error so a malformed field
  # fails CI the same way the presence check above does.
  openclaw-metadata:
    enabled: true
    severity: error

  # This repo's single skill is a router: SKILL.md is a detection/dispatch table
  # (frameworks, intents, tooling) locked down by scripts/check_routing_evals.py
  # and check_router_reachability.py, so its token budget is intentionally large
  # and can't be trimmed without dropping routes. Raise the skill body warn limit
  # to 4000 (still catches real bloat) while keeping the 6000 error ceiling. The
  # skill-description budget (200) is unchanged and enforced separately.
  context-budget:
    limits:
      skill:
        warn: 4000
        error: 6000

  # validate-skill.sh is a CI-only structural gate (invoked from
  # .github/workflows/skillsaw.yml), not agent-facing behavior the router should
  # point at — same class as the rule's built-in tests/ exemption. Exempt it so
  # it isn't flagged as an unreferenced/shadow file.
  #
  # framework-*.md / tooling-*.md are routed from SKILL.md ONLY through the
  # `references/framework-{framework}.md` and `references/tooling-{tooling}.md`
  # placeholder templates in Step 4. This rule does literal substring matching
  # and can't resolve `{framework}`/`{tooling}`, so it can't see these files as
  # referenced. Their reachability IS enforced — deterministically and offline —
  # by scripts/check_router_reachability.py, which expands the templates over the
  # real slug universes and fails on any orphan or broken route. Exempt the two
  # template-routed families here so the literal scan doesn't false-positive;
  # feature-*.md and pattern-*.md are still subject to orphan detection.
  agentskill-unreferenced-files:
    exclude:
      - "scripts/validate-skill.sh"
      - "references/framework-*.md"
      - "references/tooling-*.md"

# Custom rules for marketplace-specific validation
custom-rules:
  - ./.skillsaw/rules.py

# Exclusions
exclude:
- "**/node_modules/**"
- "**/.git/**"
- "**/dist/**"
- "**/build/**"
- "**/.venv/**"
- "**/__pycache__/**"
- "**/*.min.*"
- "**/*.lock"
- "**/.DS_Store"
- "**/.idea/**"
- "**/.vscode/**"
- "**/coverage/**"
- "**/tmp/**"
- "**/tests/fixtures/**"    # allow test data to be messy
- "**/examples/**"          # sample code often incomplete

# Strict mode
strict: true