justfile-style

Replace descriptive doc comments with exact commands in simple justfile recipes.

14|4|Updated Oct 20, 2025
One-click install
npx skills add https://github.com/motlin/claude-code-plugins --skill justfile-style
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: justfile-style
Source: https://github.com/motlin/claude-code-plugins/tree/main/plugins/justfile/skills/justfile-style
Command: npx skills add https://github.com/motlin/claude-code-plugins --skill justfile-style

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Redundant or overly descriptive doc comments in simple Justfile recipes can add unnecessary verbosity, making the just --list output less scannable and informative. This Skill streamlines your Justfile documentation.

Core Features & Use Cases

  • Doc Comment Simplification: Guides on refactoring doc comments for very short, single-line Justfile recipes to be the command itself, reducing redundancy.
  • Contextual Application: Clearly defines criteria for when to simplify (single line, under 120 chars, not a shebang recipe) and when to retain descriptive comments.
  • Improved Readability: Enhances the scannability of just --list output by showing the actual command for simple recipes, making it more informative.
  • Use Case: Automatically review and refactor your Justfile doc comments to be more concise and informative, improving readability and consistency for simple commands and making your task runner more user-friendly.

Quick Start

Review the justfile in the current directory and apply the doc comment simplification rules.

Frequently Asked Questions about justfile-style

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I simplify doc comments in my Justfile recipes?

Simplify doc comments by replacing descriptive text with the actual command for single-line recipes under 120 characters. This makes `just --list` output more scannable and shows users exactly what each recipe does without redundancy.

When should I use the command itself as the doc comment instead of a description?

Use the command as the doc comment only for single-line, non-shebang recipes where the command is under 120 characters. For multi-line recipes, shebangs, or longer commands, keep descriptive doc comments to maintain clarity.

Can I automatically refactor doc comments in my Justfile?

Yes, you can review and apply doc comment simplification rules to your Justfile. The process identifies eligible recipes—single-line, non-shebang commands under 120 characters—and replaces verbose comments with the actual command for consistency.

Why does Justfile documentation matter for task runners?

Clear Justfile documentation improves the usability of `just --list` output, helping developers quickly understand what each recipe does. Consistent, concise doc comments make your task runner more user-friendly and reduce cognitive load.

What are the limitations of doc comment simplification for Justfile recipes?

Doc comment simplification applies only to simple, single-command recipes under 120 characters. It does not apply to shebang recipes, multi-line recipes, or longer commands, where descriptive comments remain necessary for clarity and context.