This project employs several formatters and linters to ensure code consistency and maintain high-quality standards.
Contributors are expected to adhere to these practices and use the tools provided.
| Language | Formatter / Linter | Command |
|---|---|---|
| Rust | rustfmt (F) clippy (L) |
cargo fmt --all cargo clippy --all |
| Go | gofmt (F) | go fmt |
| Shell | shfmt (F) | shfmt |
| Python | Ruff (F+L) | ruff format ruff check |
| Markdown | markdownlint (L) | markdownlint '**/*.md' |
Tip
These can be setup using VSCode as well
- Rust: rust-analyzer with settings.json:
"rust-analyzer.check.command": "clippy" - Go: Go
- Shell: Shell-format
- Python: Ruff
- Markdown: markdownlint