Agent RulesAgent Rules
JU

JuliaFormatter

Code formatting with JuliaFormatter.jl and static analysis with JET.jl

Julia
Linter / Formatter
Default
Use in BuilderAll Julia Options

Details

Language / Topic
juliaJulia
Category
Linter / Formatter

Rules

balanced
- Use `JuliaFormatter.format_file("src/")` with a `.JuliaFormatter.toml` config file committed to the repo for consistent formatting.
- Set `indent = 4` and `margin = 92` in `.JuliaFormatter.toml` — these match Julia community conventions.
- Run `using JET; @report_opt f(args...)` to detect type-instabilities and method ambiguities before committing.
- Add a CI step running `julia -e 'using JuliaFormatter; format(".", check=true)'` to block unformatted commits.
- Use `Aqua.jl` (`Aqua.test_all(MyPackage)`) to detect ambiguities, undefined exports, and broken dependencies in packages.
- Configure `.JuliaFormatter.toml` with `always_use_return = true` to make return statements explicit for clarity.
- Use `@code_warntype f(args...)` interactively to spot `Any`-typed variables that indicate type-instability.