docs(skills): add build style skill
This commit was merged in pull request #67.
This commit is contained in:
9
src/skills/style/build/SKILL.md
Normal file
9
src/skills/style/build/SKILL.md
Normal file
@@ -0,0 +1,9 @@
|
||||
---
|
||||
name: build-style
|
||||
description: Use when creating, editing, or reviewing Bazel `BUILD` files or Rust `Cargo.toml` package manifests in this repository.
|
||||
---
|
||||
|
||||
# build-style
|
||||
|
||||
Use this skill for Bazel `BUILD` files and Rust `Cargo.toml` package manifests.
|
||||
Follow the shared style skill instructions in `src/skills/style/STYLE.md`.
|
||||
30
src/skills/style/build/rules/dependencies.md
Normal file
30
src/skills/style/build/rules/dependencies.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Dependency rules
|
||||
|
||||
## Use workspace dependency versions
|
||||
|
||||
### Rule
|
||||
|
||||
Declare Rust dependency versions in the repository root `Cargo.toml` under `[workspace.dependencies]`.
|
||||
Reference workspace dependencies from package `Cargo.toml` files with `workspace = true`.
|
||||
Do not declare dependency versions in package `Cargo.toml` files unless the operator explicitly requests a package-local version.
|
||||
Add package-local dependency features only when the feature set is specific to that package.
|
||||
|
||||
### Rationale
|
||||
|
||||
The repository has one Cargo workspace and one `Cargo.lock`.
|
||||
Centralized versions keep package manifests consistent with the workspace lockfile.
|
||||
|
||||
## Declare Rust dependencies in each build system
|
||||
|
||||
### Rule
|
||||
|
||||
Declare each direct crate dependency in each build system that builds the Rust target.
|
||||
For Cargo, declare the crate in the package `Cargo.toml` file.
|
||||
Use `workspace = true` for workspace-managed dependencies.
|
||||
For Bazel, add the crate label to the `deps` of the target that uses it.
|
||||
Apply this rule to `rust_library`, `rust_binary`, and `rust_test` targets.
|
||||
|
||||
### Rationale
|
||||
|
||||
Cargo and Bazel resolve Rust dependencies independently.
|
||||
Complete declarations keep Cargo, Rust Analyzer, and Bazel builds consistent.
|
||||
25
src/skills/style/build/rules/tests.md
Normal file
25
src/skills/style/build/rules/tests.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# Test rules
|
||||
|
||||
## Declare Rust tests in Bazel
|
||||
|
||||
### Rule
|
||||
|
||||
Declare Rust test files in the nearest Bazel `BUILD` file with `rust_test`.
|
||||
Do not add `[[test]]` entries to `Cargo.toml` unless the operator explicitly requests Cargo test declarations.
|
||||
|
||||
### Rationale
|
||||
|
||||
This repository declares Rust test targets in Bazel.
|
||||
Keeping test declarations in Bazel avoids duplicate test target lists.
|
||||
|
||||
## Use one source input style per `rust_test`
|
||||
|
||||
### Rule
|
||||
|
||||
Do not set both `crate` and `srcs` on a `rust_test` target.
|
||||
Use exactly one input style for each Rust test target.
|
||||
|
||||
### Rationale
|
||||
|
||||
`rules_rust` rejects `rust_test` targets that set both `crate` and `srcs`.
|
||||
Keeping one input style per target makes the test declaration valid and unambiguous.
|
||||
Reference in New Issue
Block a user