Skip to content

Commit 43ccea9

Browse files
docs(standards): update README with Rust and missing targets (#3)
Add Rust to description, tools table, config example, and architecture section. Add missing make targets (fix, changelog, docs, install-hooks) to the Usage section. Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 504da08 commit 43ccea9

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
> DevRail `v1` is stable. See [STABILITY.md](STABILITY.md) for component status.
44
5-
DevRail developer toolchain container image — a single Docker image containing all linters, formatters, security scanners, and test runners for Python, Bash, Terraform, Ansible, Ruby, Go, and JavaScript/TypeScript projects.
5+
DevRail developer toolchain container image — a single Docker image containing all linters, formatters, security scanners, and test runners for Python, Bash, Terraform, Ansible, Ruby, Go, JavaScript/TypeScript, and Rust projects.
66

77
[![Build](https://github.com/devrail-dev/dev-toolchain/actions/workflows/build.yml/badge.svg)](https://github.com/devrail-dev/dev-toolchain/actions/workflows/build.yml)
88
[![CI](https://github.com/devrail-dev/dev-toolchain/actions/workflows/ci.yml/badge.svg)](https://github.com/devrail-dev/dev-toolchain/actions/workflows/ci.yml)
@@ -30,14 +30,18 @@ Run `make help` to see all available targets:
3030

3131
```
3232
build Build the container image locally
33-
check Run all checks (lint, format, security, scan, test)
34-
format Run formatters for declared languages
33+
changelog Generate CHANGELOG.md from conventional commits
34+
check Run all checks (lint, format, test, security, scan, docs)
35+
docs Generate documentation
36+
fix Auto-fix formatting issues in-place
37+
format Run all formatters
3538
help Show this help
3639
init Scaffold config files for declared languages
37-
lint Run linters for declared languages
38-
scan Run universal scanning (trivy, gitleaks)
40+
install-hooks Install pre-commit hooks
41+
lint Run all linters
42+
scan Run universal scanners (trivy, gitleaks)
3943
security Run language-specific security scanners
40-
test Run project test suite
44+
test Run validation tests
4145
```
4246

4347
## Included Tools
@@ -51,6 +55,7 @@ test Run project test suite
5155
| Ruby | rubocop, reek, brakeman, bundler-audit, rspec, sorbet |
5256
| Go | golangci-lint, gofumpt, govulncheck, go test |
5357
| JavaScript/TS | eslint, prettier, typescript, vitest, npm audit |
58+
| Rust | clippy, rustfmt, cargo-audit, cargo-deny, cargo test |
5459
| Security | trivy, gitleaks |
5560

5661
## Configuration
@@ -66,12 +71,14 @@ languages:
6671
- ruby
6772
- go
6873
- javascript
74+
- rust
6975
```
7076
7177
## Architecture
7278
7379
- **Base image:** Debian bookworm-slim (multi-arch: amd64 + arm64)
7480
- **Go builder stage:** Compiles Go-based tools (tflint, terraform-docs, etc.)
81+
- **Rust builder stage:** Provides Rust toolchain and cargo-audit/cargo-deny via cargo-binstall
7582
- **Modular install scripts:** One script per language ecosystem
7683
- **Shared libraries:** `lib/log.sh` (logging) and `lib/platform.sh` (platform detection)
7784

0 commit comments

Comments
 (0)