ZI
zig fmt
Zig's built-in formatter for consistent code style
Details
Language / Topic
ZigCategory
Linter / Formatter
Rules
balanced
- Run `zig fmt src/` to auto-format all Zig source files — `zig fmt` is the single authoritative formatter with no configuration options.
- Run `zig fmt --check src/` in CI to fail the build when files are not formatted — use `zig fmt` in a pre-commit hook to auto-fix before committing.
- Use `zig build` with a lint step that runs `zig fmt --check` and `zig ast-check` to catch both formatting and syntax errors.
- Integrate `zig fmt --check` as a required CI check that runs before compilation to catch formatting issues early.
- Use `zig ast-check file.zig` to validate syntax without compiling — it catches malformed AST nodes and incorrect language constructs faster than a full build.
- Configure editor integration (ZLS + LSP) to run `zig fmt` on save so developers never need to manually invoke the formatter.
- Run `zig build --prominent-compile-errors` in CI to display all errors without truncation for easier debugging of formatting check failures.