mojo-format
Format Mojo code using mojo format command. Use when preparing code for commit or when formatting checks fail.
When & Why to Use This Skill
The Mojo Format skill is a specialized utility designed to automate the styling and standardization of Mojo source code. By leveraging the official 'mojo format' command, it ensures that codebases maintain consistent indentation, spacing, and structural integrity without altering logic. This tool is essential for developers looking to streamline their workflow, maintain high code quality, and ensure compliance with project-specific style guides.
Use Cases
- Pre-commit Optimization: Automatically format Mojo files before committing to a repository to prevent style-related build failures.
- Automated Code Reviews: Quickly resolve formatting feedback in pull requests by running the formatter on specific files or directories.
- Legacy Code Standardization: Bulk-process existing Mojo projects to align older codebases with modern indentation and spacing standards.
- CI/CD Integration: Use as a verification step in automated pipelines to check for formatting compliance without manual intervention.
| name | mojo-format |
|---|---|
| description | "Format Mojo code using mojo format command. Use when preparing code for commit or when formatting checks fail." |
| mcp_fallback | none |
| category | mojo |
| agent | test-engineer |
| user-invocable | false |
Mojo Format Skill
Format Mojo code files to ensure consistent style.
When to Use
- Preparing code for commit
- Pre-commit hook reports formatting issues
- Code review requests formatting fixes
- Verifying formatting compliance
Quick Reference
# Format single file
pixi run mojo format path/to/file.mojo
# Format directory
pixi run mojo format `find src/ -name "*.mojo"`
# Check without modifying
pixi run mojo format --check path/to/file.mojo
Workflow
- Identify files - Single file or directory
- Run formatter -
pixi run mojo format <path> - Verify changes - Review formatted output
- Commit - Stage and commit formatted code
Mojo-Specific Notes
- Formats indentation (4 spaces), line length, spacing around operators
- Does NOT change logic, variable names, or comment content
- Preserves all comments, only adjusts spacing
- Safe to run multiple times (idempotent)
Error Handling
| Error | Cause | Solution |
|---|---|---|
Syntax error |
Invalid Mojo syntax | Fix syntax before formatting |
File not found |
Wrong path | Verify file exists |
Permission denied |
File permissions | Check chmod settings |
Mojo not installed |
Missing Mojo | Install via pixi or Magic |
References
.claude/shared/mojo-guidelines.md- Mojo syntax standards.pre-commit-config.yaml- Pre-commit hook configuration