rule

Rule

Purpose

Explain a ruff lint rule by code. When the user provides a rule identifier (e.g. F401, E501, B006, UP007), surface the rule name, explanation, and examples. When no code is provided, run a statistics pass first to discover which rules are firing in the project, then offer to explain any of them.

Procedure

1. Determine the rule code(s) from the user's request.

   • If the user provided one or more rule codes (e.g. F401, E501, B006, UP007), proceed to step 2.
   • If no rule code was provided, jump to step 4 (discovery mode).

2. For each provided rule code, run:

   ruff rule <code>
   

3. Display the full output for each: rule name, explanation, and examples. When multiple codes are supplied, present them sequentially in the order the user listed them.

4. Discovery mode (no code provided). Run a statistics pass on the current directory to surface what is actually firing:

   ruff check --statistics .
   

   Summarize the violation counts and offer to explain any of the reported rules. Wait for the user to pick before invoking ruff rule <code>.

Composition

This skill currently inlines its procedure (a direct ruff rule invocation). The forward-looking design per the v3 toolkit spec and the Path B decision is for this skill to invoke the shared diagnostic-review pipeline via:

Skill(skill: "python-toolkit:diagnostic-review", pass: "rule CODE")

The shared diagnostic-review skill already ships at skills/diagnostic-review/SKILL.md and documents the pass: rule CODE selector. The per-pass invocation wiring lands in a separate chore — until then, this skill body matches the legacy /rule command behavior.