command-frontmatter¶

Command files must have valid frontmatter with description


Severity	error
Autofix	auto
Since	v0.1.0
Category	Command Format

Why¶

Command files need YAML frontmatter with a description field so the host application can display help text and decide when to offer the command. Without it, the command exists but is undiscoverable.

Examples¶

Bad:

## Name

my-plugin:deploy

## Description
...

Good:

---
description: Deploy the application to production
---

## Name

my-plugin:deploy
...

How to fix¶

Add a YAML frontmatter block at the top of the command file with a description field. skillsaw fix can add the missing frontmatter automatically.

Configuration¶

rules:
  command-frontmatter:
    enabled: true  # true | false | auto
    severity: error

Run skillsaw explain command-frontmatter to see this documentation and the rule's effective configuration in your terminal.