b77fe8fefe
## Why Once the repo-local lint exists, `codex-rs` needs to follow the checked-in convention and CI needs to keep it from drifting. This commit applies the fallback `/*param*/` style consistently across existing positional literal call sites without changing those APIs. The longer-term preference is still to avoid APIs that require comments by choosing clearer parameter types and call shapes. This PR is intentionally the mechanical follow-through for the places where the existing signatures stay in place. After rebasing onto newer `main`, the rollout also had to cover newly introduced `tui_app_server` call sites. That made it clear the first cut of the CI job was too expensive for the common path: it was spending almost as much time installing `cargo-dylint` and re-testing the lint crate as a representative test job spends running product tests. The CI update keeps the full workspace enforcement but trims that extra overhead from ordinary `codex-rs` PRs. ## What changed - keep a dedicated `argument_comment_lint` job in `rust-ci` - mechanically annotate remaining opaque positional literals across `codex-rs` with exact `/*param*/` comments, including the rebased `tui_app_server` call sites that now fall under the lint - keep the checked-in style aligned with the lint policy by using `/*param*/` and leaving string and char literals uncommented - cache `cargo-dylint`, `dylint-link`, and the relevant Cargo registry/git metadata in the lint job - split changed-path detection so the lint crate's own `cargo test` step runs only when `tools/argument-comment-lint/*` or `rust-ci.yml` changes - continue to run the repo wrapper over the `codex-rs` workspace, so product-code enforcement is unchanged Most of the code changes in this commit are intentionally mechanical comment rewrites or insertions driven by the lint itself. ## Verification - `./tools/argument-comment-lint/run.sh --workspace` - `cargo test -p codex-tui-app-server -p codex-tui` - parsed `.github/workflows/rust-ci.yml` locally with PyYAML --- * -> #14652 * #14651 |
||
|---|---|---|
| .. | ||
| .cargo | ||
| src | ||
| ui | ||
| .gitignore | ||
| Cargo.lock | ||
| Cargo.toml | ||
| README.md | ||
| run.sh | ||
| rust-toolchain | ||
argument-comment-lint
Isolated Dylint library for enforcing
Rust argument comments in the exact /*param*/ shape.
Prefer self-documenting APIs over comment-heavy call sites when possible. If a
call site would otherwise read like foo(false) or bar(None), consider an
enum, named helper, newtype, or another idiomatic Rust API shape first, and
use an argument comment only when a smaller compatibility-preserving change is
more appropriate.
It provides two lints:
argument_comment_mismatch(warnby default): validates that a present/*param*/comment matches the resolved callee parameter name.uncommented_anonymous_literal_argument(allowby default): flags anonymous literal-like arguments such asNone,true,false, and numeric literals when they do not have a preceding/*param*/comment.
String and char literals are exempt because they are often already self-descriptive at the callsite.
Behavior
Given:
fn create_openai_url(base_url: Option<String>, retry_count: usize) -> String {
let _ = (base_url, retry_count);
String::new()
}
This is accepted:
create_openai_url(/*base_url*/ None, /*retry_count*/ 3);
This is warned on by argument_comment_mismatch:
create_openai_url(/*api_base*/ None, 3);
This is only warned on when uncommented_anonymous_literal_argument is enabled:
create_openai_url(None, 3);
Development
Install the required tooling once:
cargo install cargo-dylint dylint-link
rustup toolchain install nightly-2025-09-18 \
--component llvm-tools-preview \
--component rustc-dev \
--component rust-src
Run the lint crate tests:
cd tools/argument-comment-lint
cargo test
Run the lint against codex-rs from the repo root:
./tools/argument-comment-lint/run.sh -p codex-core
just argument-comment-lint -p codex-core
If no package selection is provided, run.sh defaults to checking the
codex-rs workspace with --workspace --no-deps.
Repo runs also promote uncommented_anonymous_literal_argument to an error by
default:
./tools/argument-comment-lint/run.sh -p codex-core
The wrapper does that by setting DYLINT_RUSTFLAGS, and it leaves an explicit
existing setting alone. It also defaults CARGO_INCREMENTAL=0 unless you have
already set it, because the current nightly Dylint flow can otherwise hit a
rustc incremental compilation ICE locally. To override that behavior for an ad
hoc run:
DYLINT_RUSTFLAGS="-A uncommented-anonymous-literal-argument" \
CARGO_INCREMENTAL=1 \
./tools/argument-comment-lint/run.sh -p codex-core
To expand target coverage for an ad hoc run:
./tools/argument-comment-lint/run.sh -p codex-core -- --all-targets