mirror of
https://github.com/openai/codex.git
synced 2026-05-04 13:21:54 +03:00
Apply argument comment lint across codex-rs (#14652)
## 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
This commit is contained in:
@@ -41,7 +41,7 @@ pub fn merge_base_with_head(
|
||||
OsString::from(head),
|
||||
OsString::from(preferred_ref),
|
||||
],
|
||||
None,
|
||||
/*env*/ None,
|
||||
)?;
|
||||
|
||||
Ok(Some(merge_base))
|
||||
@@ -55,7 +55,7 @@ fn resolve_branch_ref(repo_root: &Path, branch: &str) -> Result<Option<String>,
|
||||
OsString::from("--verify"),
|
||||
OsString::from(branch),
|
||||
],
|
||||
None,
|
||||
/*env*/ None,
|
||||
);
|
||||
|
||||
match rev {
|
||||
@@ -77,7 +77,7 @@ fn resolve_upstream_if_remote_ahead(
|
||||
OsString::from("--symbolic-full-name"),
|
||||
OsString::from(format!("{branch}@{{upstream}}")),
|
||||
],
|
||||
None,
|
||||
/*env*/ None,
|
||||
) {
|
||||
Ok(name) => {
|
||||
let trimmed = name.trim();
|
||||
@@ -98,7 +98,7 @@ fn resolve_upstream_if_remote_ahead(
|
||||
OsString::from("--count"),
|
||||
OsString::from(format!("{branch}...{upstream}")),
|
||||
],
|
||||
None,
|
||||
/*env*/ None,
|
||||
) {
|
||||
Ok(counts) => counts,
|
||||
Err(GitToolingError::GitCommand { .. }) => return Ok(None),
|
||||
|
||||
@@ -489,7 +489,7 @@ fn restore_to_commit_inner(
|
||||
restore_args.push(OsString::from("."));
|
||||
}
|
||||
|
||||
run_git_for_status(repo_root, restore_args, None)?;
|
||||
run_git_for_status(repo_root, restore_args, /*env*/ None)?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
@@ -532,7 +532,7 @@ fn capture_status_snapshot(
|
||||
args.push(prefix.as_os_str().to_os_string());
|
||||
}
|
||||
|
||||
let output = run_git_for_stdout_all(repo_root, args, None)?;
|
||||
let output = run_git_for_stdout_all(repo_root, args, /*env*/ None)?;
|
||||
if output.is_empty() {
|
||||
return Ok(StatusSnapshot::default());
|
||||
}
|
||||
@@ -599,20 +599,26 @@ fn capture_status_snapshot(
|
||||
}
|
||||
}
|
||||
b'1' => {
|
||||
if let Some(path) = extract_status_path_after_fields(entry, 8) {
|
||||
if let Some(path) =
|
||||
extract_status_path_after_fields(entry, /*fields_before_path*/ 8)
|
||||
{
|
||||
let normalized = normalize_relative_path(Path::new(path))?;
|
||||
snapshot.tracked_paths.push(normalized);
|
||||
}
|
||||
}
|
||||
b'2' => {
|
||||
if let Some(path) = extract_status_path_after_fields(entry, 9) {
|
||||
if let Some(path) =
|
||||
extract_status_path_after_fields(entry, /*fields_before_path*/ 9)
|
||||
{
|
||||
let normalized = normalize_relative_path(Path::new(path))?;
|
||||
snapshot.tracked_paths.push(normalized);
|
||||
}
|
||||
expect_rename_source = true;
|
||||
}
|
||||
b'u' => {
|
||||
if let Some(path) = extract_status_path_after_fields(entry, 10) {
|
||||
if let Some(path) =
|
||||
extract_status_path_after_fields(entry, /*fields_before_path*/ 10)
|
||||
{
|
||||
let normalized = normalize_relative_path(Path::new(path))?;
|
||||
snapshot.tracked_paths.push(normalized);
|
||||
}
|
||||
|
||||
@@ -14,7 +14,7 @@ pub(crate) fn ensure_git_repository(path: &Path) -> Result<(), GitToolingError>
|
||||
OsString::from("rev-parse"),
|
||||
OsString::from("--is-inside-work-tree"),
|
||||
],
|
||||
None,
|
||||
/*env*/ None,
|
||||
) {
|
||||
Ok(output) if output.trim() == "true" => Ok(()),
|
||||
Ok(_) => Err(GitToolingError::NotAGitRepository {
|
||||
@@ -37,7 +37,7 @@ pub(crate) fn resolve_head(path: &Path) -> Result<Option<String>, GitToolingErro
|
||||
OsString::from("--verify"),
|
||||
OsString::from("HEAD"),
|
||||
],
|
||||
None,
|
||||
/*env*/ None,
|
||||
) {
|
||||
Ok(sha) => Ok(Some(sha)),
|
||||
Err(GitToolingError::GitCommand { status, .. }) if status.code() == Some(128) => Ok(None),
|
||||
@@ -84,7 +84,7 @@ pub(crate) fn resolve_repository_root(path: &Path) -> Result<PathBuf, GitTooling
|
||||
OsString::from("rev-parse"),
|
||||
OsString::from("--show-toplevel"),
|
||||
],
|
||||
None,
|
||||
/*env*/ None,
|
||||
)?;
|
||||
Ok(PathBuf::from(root))
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user