https://github.com/eclipse-score/score_rust_policies
Centralized Rust linting and formatting policies for S-CORE, including safety-critical guidelines.
https://github.com/eclipse-score/score_rust_policies
formatting linting policy rust score
Last synced: 5 months ago
JSON representation
Centralized Rust linting and formatting policies for S-CORE, including safety-critical guidelines.
- Host: GitHub
- URL: https://github.com/eclipse-score/score_rust_policies
- Owner: eclipse-score
- License: other
- Created: 2025-12-02T12:45:20.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-12-16T09:34:53.000Z (7 months ago)
- Last Synced: 2025-12-19T22:40:45.411Z (6 months ago)
- Topics: formatting, linting, policy, rust, score
- Language: Starlark
- Homepage: https://eclipse-score.github.io/score_rust_policies
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# score_rust_policies
Centralized Rust linting and formatting policies for the Eclipse Safe Open Vehicle Core (S-CORE). This repository packages shared Rust lint/format defaults so every S-CORE crate can use the same safety-focused rules.
## Goals
- Provide one set of vetted Rust linting and formatting defaults for S-CORE projects.
- Distribute those policies as a Bazel module (`score_rust_policies`) so bzlmod users can depend on them directly.
- Keep tooling configurations (e.g., Clippy, rustfmt) versioned and auditable in one place.
## Clippy policy levels
- `clippy/strict/clippy.toml`: ASIL-B–oriented settings for safety-critical code (enables `pedantic`/`nursery`, disallows `panic`/`unwrap`/`expect`, forbids debug/print macros, and enforces size/complexity thresholds).
- `clippy/relaxed/clippy.toml`: For tooling, generators, and tests where controlled panics/unwraps and debug printing are acceptable. Still forbids `todo` and `unimplemented`.
## How to use Clippy in consumers
- Wire configs in your repo’s `.bazelrc` (mirrors `tests/.bazelrc`):
```
build:clippy-strict --@rules_rust//rust/settings:clippy.toml=@score_rust_policies//clippy/strict:clippy.toml
build:clippy-relaxed --@rules_rust//rust/settings:clippy.toml=@score_rust_policies//clippy/relaxed:clippy.toml
```
- Exclude targets that shouldn’t be linted (e.g., generated code, some tests) by tagging them `no-clippy`:
```
rust_test(
name = "my_test",
srcs = [...],
tags = ["no-clippy"],
)
```
- Add a dedicated lint target (pattern from `rules_rust`):
```
load("@rules_rust//rust:defs.bzl", "rust_clippy")
rust_clippy(
name = "clippy",
deps = ["//src/rust/..."],
tags = ["manual"],
testonly = True,
visibility = ["//visibility:public"],
)
```
Then run `bazel build --config=clippy-strict //:clippy` (or `--config=clippy-relaxed`).
## Local validation
- From `tests/` (consumer workspace with a local_path_override) run:
- `bazel build --config=strict //:sample_clippy`
- `bazel build --config=relaxed //:sample_clippy`
- The `tests/.bazelrc` sets the strict/relaxed Clippy configs to `@score_rust_policies//clippy/{strict,relaxed}:clippy.toml` via `@rules_rust//rust/settings:clippy.toml`.
## Using with Bazel (bzlmod)
- Add to your `MODULE.bazel`:
```
bazel_dep(name = "score_rust_policies", version = "0.0.4")
```
- During local development you can pin a checkout with:
```
local_path_override(
module_name = "score_rust_policies",
path = "",
)
```
- Reference policy files in Bazel targets with:
- `@score_rust_policies//clippy:clippy.toml` for safety components.
- `@score_rust_policies//clippy:clippy_relaxed.toml` for tooling/tests.
- When running Clippy directly, pass the config you need: `cargo clippy --config-path path/to/clippy/clippy.toml`.
## Repository layout
- `MODULE.bazel`: Bazel module metadata for `score_rust_policies`.
- `BUILD.bazel`: repo root package (tooling configs live in subpackages).
- `LICENSE.md`: Apache License 2.0.
- `CONTRIBUTION.md`: contribution process and links to S-CORE guidelines.
- `.gitignore`: common ignores for Bazel and development tooling.
- `clippy/`: Clippy configs exported as `@score_rust_policies//clippy/{strict,relaxed}:clippy.toml`.
- `tests/`: consumer workspace that depends on this module via `local_path_override` and runs Clippy with strict/relaxed configs.
- (planned) `rustfmt/`: rustfmt defaults when added.
## Contributing
See `CONTRIBUTION.md` for how to propose and review policy changes. All contributions require ECA/DCO sign-off and follow the Eclipse Foundation project handbook.
## License
Apache License 2.0. See `LICENSE.md`.