justfile-style

Community

Optimize Justfile documentation for clarity.

Authormotlin
Version1.0.0
Installs0

System Documentation

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.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: justfile-style
Download link: https://github.com/motlin/claude-code-plugins/archive/main.zip#justfile-style

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository