Documentation
README
Code Formatter
Format source code files using the codeformat tool to ensure all files comply with the team's coding style.
Procedures
Step 1: Identify Files to Format
- List files with style violations:
codeformat check . - Review the output to identify which files need formatting.
Step 2: Apply Formatting
- Format all files:
codeformat fix . - Or format a specific file:
codeformat fix --target <filename>
Step 3: Verify Results
- Run
codeformat verifyto confirm all files are properly formatted. - The tool generates a
.format-passedmetadata file on success.
Error Handling
- If
codeformat verifyfails, re-runcodeformat fix .and try again. - If formatting introduces syntax errors, revert the file and report the issue.