Justfile Style
Documentsjustfile-styleJustfile Style is an Agent Skill for documents published in the majiayu000/claude-skill-registry repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Style guidelines for justfile recipe documentation. Use when writing or editing justfiles to ensure consistent and concise documentation.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/majiayu000/claude-skill-registry/blob/HEAD/skills/data/justfile-style/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/justfile-style, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Justfile Style Guidelines
This skill provides best practices for writing justfile recipe documentation comments.
Doc Comment Simplification
For very short justfile recipes, change the doc comment string to be the entire command instead of a descriptive phrase.
When to Simplify
- The cutoff for when to perform this refactoring should be approximately a single line of 120 characters
- If the recipe is a shebang recipe, don't shorten the doc comment
- If the recipe is multiple lines, or longer than 120 characters, don't shorten the doc comment
Example Transformation
❌ Before:
# Install dependencies
[group('setup')]
install:
npm install
✅ After:
# npm install
[group('setup')]
install:
npm install
Rationale
For simple, single-command recipes, the command itself is often more informative than a descriptive phrase. This approach:
- Reduces redundancy: "Install dependencies" vs "npm install" convey the same information
- Shows the actual command: Users can see exactly what will run
- Maintains consistency: All simple recipes follow the same pattern
- Improves scannability: The actual command is immediately visible
When NOT to Simplify
Keep descriptive doc comments for:
- Multi-line recipes:
# Set up development environment
[group('setup')]
dev-setup:
npm install
cp .env.example .env
just db-migrate
- Shebang recipes:
# Generate API documentation
[group('docs')]
gen-docs:
#!/usr/bin/env bash
set -euo pipefail
# ... multiple lines of bash script
- Long single-line commands (>120 characters):
# Build production bundle with optimizations
[group('build')]
build-prod:
webpack --mode production --config webpack.prod.js --optimization-minimize --output-path dist/
In these cases, a descriptive comment provides more value than repeating the complex command.