format

Format Calor source files to canonical style.

calor format <files...> [options]

Overview

The format command formats Calor source files according to the canonical Calor style guide. This ensures consistent formatting across your codebase.

Quick Start

# Format a single file (output to stdout)
calor format MyModule.calr

# Format and overwrite the file (explicitly acknowledge the experimental writer)
calor format MyModule.calr --write --experimental

# Check if files are formatted (for CI)
calor format src/*.calr --check

# Show diff of changes
calor format MyModule.calr --diff

Options

v0.12 release policy: the write path can rewrite identifiers and drop comments. format --write is refused with Calor1346 unless you pass --experimental or set CALOR_EXPERIMENTAL_FORMAT_WRITE=1. Read-only stdout, --check, and --diff remain available without acknowledgment.

Formatting Rules

The Calor formatter applies these rules:

• 2 spaces per indentation level
• Single space after structure tags
• Single space around operators in expressions
• No trailing whitespace
• One blank line between functions
• Newline at end of file

Check Mode

Use --check in CI/CD to verify formatting:

calor format src/*.calr --check

Exit codes:

• 0 - All files are formatted correctly
• 1 - One or more files need formatting

Exit Codes

See Also

• calor compile - Compile Calor to C#