From 9d5e36c3dc201ca3bbc3833a9953f5b79b264a80 Mon Sep 17 00:00:00 2001 From: Michael Bolin Date: Thu, 19 Mar 2026 17:08:47 -0700 Subject: [PATCH] Use released DotSlash package for argument-comment lint --- .github/workflows/rust-ci.yml | 61 ++++++++++---- AGENTS.md | 2 + justfile | 6 +- tools/argument-comment-lint/README.md | 54 +++++++++++- .../argument-comment-lint | 79 ++++++++++++++++++ .../run-prebuilt-linter.sh | 82 +++++++++++++++++++ tools/argument-comment-lint/run.sh | 74 ++++++++++++----- 7 files changed, 318 insertions(+), 40 deletions(-) create mode 100755 tools/argument-comment-lint/argument-comment-lint create mode 100755 tools/argument-comment-lint/run-prebuilt-linter.sh diff --git a/.github/workflows/rust-ci.yml b/.github/workflows/rust-ci.yml index 287e7e540f..ba55c609ef 100644 --- a/.github/workflows/rust-ci.yml +++ b/.github/workflows/rust-ci.yml @@ -91,17 +91,13 @@ jobs: - name: cargo shear run: cargo shear - argument_comment_lint: - name: Argument comment lint + argument_comment_lint_package: + name: Argument comment lint package runs-on: ubuntu-24.04 needs: changed - if: ${{ needs.changed.outputs.argument_comment_lint == 'true' || needs.changed.outputs.workflows == 'true' || github.event_name == 'push' }} + if: ${{ needs.changed.outputs.argument_comment_lint_package == 'true' || github.event_name == 'push' }} steps: - uses: actions/checkout@v6 - - name: Install Linux sandbox build dependencies - run: | - sudo DEBIAN_FRONTEND=noninteractive apt-get update - sudo DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends pkg-config libcap-dev - uses: dtolnay/rust-toolchain@1.93.0 with: toolchain: nightly-2025-09-18 @@ -120,14 +116,46 @@ jobs: - name: Install cargo-dylint tooling if: ${{ steps.cargo_dylint_cache.outputs.cache-hit != 'true' }} run: cargo install --locked cargo-dylint dylint-link + - name: Check source wrapper syntax + run: bash -n tools/argument-comment-lint/run.sh - name: Test argument comment lint package - if: ${{ needs.changed.outputs.argument_comment_lint_package == 'true' || github.event_name == 'push' }} working-directory: tools/argument-comment-lint run: cargo test - - name: Run argument comment lint on codex-rs + + argument_comment_lint_prebuilt: + name: Argument comment lint - ${{ matrix.name }} + runs-on: ${{ matrix.runs_on || matrix.runner }} + needs: changed + if: ${{ needs.changed.outputs.argument_comment_lint == 'true' || needs.changed.outputs.workflows == 'true' || github.event_name == 'push' }} + strategy: + fail-fast: false + matrix: + include: + - name: Linux + runner: ubuntu-24.04 + - name: macOS + runner: macos-15-xlarge + - name: Windows + runner: windows-x64 + runs_on: + group: codex-runners + labels: codex-windows-x64 + steps: + - uses: actions/checkout@v6 + - name: Install Linux sandbox build dependencies + if: ${{ runner.os == 'Linux' }} + shell: bash run: | - bash -n tools/argument-comment-lint/run.sh - ./tools/argument-comment-lint/run.sh + sudo DEBIAN_FRONTEND=noninteractive apt-get update + sudo DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends pkg-config libcap-dev + - uses: dtolnay/rust-toolchain@1.93.0 + with: + toolchain: nightly-2025-09-18 + components: llvm-tools-preview, rustc-dev, rust-src + - uses: facebook/install-dotslash@v2 + - name: Run argument comment lint on codex-rs + shell: bash + run: ./tools/argument-comment-lint/run-prebuilt-linter.sh # --- CI to validate on different os/targets -------------------------------- lint_build: @@ -708,14 +736,15 @@ jobs: results: name: CI results (required) needs: - [changed, general, cargo_shear, argument_comment_lint, lint_build, tests] + [changed, general, cargo_shear, argument_comment_lint_package, argument_comment_lint_prebuilt, lint_build, tests] if: always() runs-on: ubuntu-24.04 steps: - name: Summarize shell: bash run: | - echo "arglint: ${{ needs.argument_comment_lint.result }}" + echo "argpkg : ${{ needs.argument_comment_lint_package.result }}" + echo "arglint: ${{ needs.argument_comment_lint_prebuilt.result }}" echo "general: ${{ needs.general.result }}" echo "shear : ${{ needs.cargo_shear.result }}" echo "lint : ${{ needs.lint_build.result }}" @@ -728,8 +757,12 @@ jobs: exit 0 fi + if [[ '${{ needs.changed.outputs.argument_comment_lint_package }}' == 'true' || '${{ github.event_name }}' == 'push' ]]; then + [[ '${{ needs.argument_comment_lint_package.result }}' == 'success' ]] || { echo 'argument_comment_lint_package failed'; exit 1; } + fi + if [[ '${{ needs.changed.outputs.argument_comment_lint }}' == 'true' || '${{ needs.changed.outputs.workflows }}' == 'true' || '${{ github.event_name }}' == 'push' ]]; then - [[ '${{ needs.argument_comment_lint.result }}' == 'success' ]] || { echo 'argument_comment_lint failed'; exit 1; } + [[ '${{ needs.argument_comment_lint_prebuilt.result }}' == 'success' ]] || { echo 'argument_comment_lint_prebuilt failed'; exit 1; } fi if [[ '${{ needs.changed.outputs.codex }}' == 'true' || '${{ needs.changed.outputs.workflows }}' == 'true' || '${{ github.event_name }}' == 'push' ]]; then diff --git a/AGENTS.md b/AGENTS.md index 8c45532dda..3a287a5991 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -48,6 +48,8 @@ Run `just fmt` (in `codex-rs` directory) automatically after you have finished m Before finalizing a large change to `codex-rs`, run `just fix -p ` (in `codex-rs` directory) to fix any linter issues in the code. Prefer scoping with `-p` to avoid slow workspace‑wide Clippy builds; only run `just fix` without `-p` if you changed shared crates. Do not re-run tests after running `fix` or `fmt`. +Also run `just argument-comment-lint` to ensure the codebase is clean of comment lint errors. + ## TUI style conventions See `codex-rs/tui/styles.md`. diff --git a/justfile b/justfile index e32a96181e..768b714073 100644 --- a/justfile +++ b/justfile @@ -30,7 +30,7 @@ fmt: fix *args: cargo clippy --fix --tests --allow-dirty "$@" -clippy: +clippy *args: cargo clippy --tests "$@" install: @@ -89,6 +89,10 @@ write-hooks-schema: # Run the argument-comment Dylint checks across codex-rs. [no-cd] argument-comment-lint *args: + ./tools/argument-comment-lint/run-prebuilt-linter.sh "$@" + +[no-cd] +argument-comment-lint-from-source *args: ./tools/argument-comment-lint/run.sh "$@" # Tail logs from the state SQLite database diff --git a/tools/argument-comment-lint/README.md b/tools/argument-comment-lint/README.md index 91c1fdecc8..1ce8bd88c2 100644 --- a/tools/argument-comment-lint/README.md +++ b/tools/argument-comment-lint/README.md @@ -73,21 +73,67 @@ GitHub releases also publish a DotSlash file named x64. The published package contains a small runner executable, a bundled `cargo-dylint`, and the prebuilt lint library. -Run the lint against `codex-rs` from the repo root: +The package is not a full Rust toolchain. Running the prebuilt path still +requires the pinned nightly toolchain to be installed via `rustup`: + +```bash +rustup toolchain install nightly-2025-09-18 \ + --component llvm-tools-preview \ + --component rustc-dev \ + --component rust-src +``` + +The checked-in DotSlash file lives at `tools/argument-comment-lint/argument-comment-lint`. +`run-prebuilt-linter.sh` resolves that file via `dotslash` and is the path used by +`just clippy`, `just argument-comment-lint`, and the Rust CI job. The +source-build path remains available in `run.sh` for people +iterating on the lint crate itself. + +The Unix archive layout is: + +```text +argument-comment-lint/ + bin/ + argument-comment-lint + cargo-dylint + lib/ + libargument_comment_lint@nightly-2025-09-18-.dylib|so +``` + +On Windows the same layout is published as a `.zip`, with `.exe` and `.dll` +filenames instead. + +DotSlash resolves the package entrypoint to `argument-comment-lint/bin/argument-comment-lint` +(or `.exe` on Windows). That runner then finds the sibling bundled +`cargo-dylint` binary and the single packaged Dylint library under `lib/`, and +invokes `cargo-dylint dylint --lib-path ` with the repo's default +`DYLINT_RUSTFLAGS` and `CARGO_INCREMENTAL=0` settings. + +`run-prebuilt-linter.sh` also makes sure the `rustup` shims stay ahead of any +direct toolchain `cargo` binary on `PATH`, because `cargo-dylint` needs a +`cargo` that can dispatch `+nightly-2025-09-18-` correctly. + +If you are changing the lint crate itself, use the source-build wrapper: ```bash ./tools/argument-comment-lint/run.sh -p codex-core +``` + +Run the lint against `codex-rs` from the repo root: + +```bash +./tools/argument-comment-lint/run-prebuilt-linter.sh -p codex-core just argument-comment-lint -p codex-core ``` -If no package selection is provided, `run.sh` defaults to checking the +If no package selection is provided, `run-prebuilt-linter.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: ```bash -./tools/argument-comment-lint/run.sh -p codex-core +./tools/argument-comment-lint/run-prebuilt-linter.sh -p codex-core ``` The wrapper does that by setting `DYLINT_RUSTFLAGS`, and it leaves an explicit @@ -105,5 +151,5 @@ CARGO_INCREMENTAL=1 \ To expand target coverage for an ad hoc run: ```bash -./tools/argument-comment-lint/run.sh -p codex-core -- --all-targets +./tools/argument-comment-lint/run-prebuilt-linter.sh -p codex-core -- --all-targets ``` diff --git a/tools/argument-comment-lint/argument-comment-lint b/tools/argument-comment-lint/argument-comment-lint new file mode 100755 index 0000000000..602117e3ce --- /dev/null +++ b/tools/argument-comment-lint/argument-comment-lint @@ -0,0 +1,79 @@ +#!/usr/bin/env dotslash + +{ + "name": "argument-comment-lint", + "platforms": { + "macos-aarch64": { + "size": 3402747, + "hash": "blake3", + "digest": "a11669d2f184a2c6f226cedce1bf10d1ec478d53413c42fe80d17dd873fdb2d7", + "format": "tar.gz", + "path": "argument-comment-lint/bin/argument-comment-lint", + "providers": [ + { + "url": "https://github.com/openai/codex/releases/download/rust-v0.117.0-alpha.2/argument-comment-lint-aarch64-apple-darwin.tar.gz" + }, + { + "type": "github-release", + "repo": "https://github.com/openai/codex", + "tag": "rust-v0.117.0-alpha.2", + "name": "argument-comment-lint-aarch64-apple-darwin.tar.gz" + } + ] + }, + "linux-x86_64": { + "size": 3869711, + "hash": "blake3", + "digest": "1015f4ba07d57edc5ec79c8f6709ddc1516f64c903e909820437a4b89d8d853a", + "format": "tar.gz", + "path": "argument-comment-lint/bin/argument-comment-lint", + "providers": [ + { + "url": "https://github.com/openai/codex/releases/download/rust-v0.117.0-alpha.2/argument-comment-lint-x86_64-unknown-linux-gnu.tar.gz" + }, + { + "type": "github-release", + "repo": "https://github.com/openai/codex", + "tag": "rust-v0.117.0-alpha.2", + "name": "argument-comment-lint-x86_64-unknown-linux-gnu.tar.gz" + } + ] + }, + "linux-aarch64": { + "size": 3759446, + "hash": "blake3", + "digest": "91f2a31e6390ca728ad09ae1aa6b6f379c67d996efcc22956001df89f068af5b", + "format": "tar.gz", + "path": "argument-comment-lint/bin/argument-comment-lint", + "providers": [ + { + "url": "https://github.com/openai/codex/releases/download/rust-v0.117.0-alpha.2/argument-comment-lint-aarch64-unknown-linux-gnu.tar.gz" + }, + { + "type": "github-release", + "repo": "https://github.com/openai/codex", + "tag": "rust-v0.117.0-alpha.2", + "name": "argument-comment-lint-aarch64-unknown-linux-gnu.tar.gz" + } + ] + }, + "windows-x86_64": { + "size": 3244599, + "hash": "blake3", + "digest": "dc711c6d85b1cabbe52447dda3872deb20c2e64b155da8be0ecb207c7c391683", + "format": "zip", + "path": "argument-comment-lint/bin/argument-comment-lint.exe", + "providers": [ + { + "url": "https://github.com/openai/codex/releases/download/rust-v0.117.0-alpha.2/argument-comment-lint-x86_64-pc-windows-msvc.zip" + }, + { + "type": "github-release", + "repo": "https://github.com/openai/codex", + "tag": "rust-v0.117.0-alpha.2", + "name": "argument-comment-lint-x86_64-pc-windows-msvc.zip" + } + ] + } + } +} diff --git a/tools/argument-comment-lint/run-prebuilt-linter.sh b/tools/argument-comment-lint/run-prebuilt-linter.sh new file mode 100755 index 0000000000..47085cc04d --- /dev/null +++ b/tools/argument-comment-lint/run-prebuilt-linter.sh @@ -0,0 +1,82 @@ +#!/usr/bin/env bash + +set -euo pipefail + +repo_root="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)" +manifest_path="$repo_root/codex-rs/Cargo.toml" +dotslash_manifest="$repo_root/tools/argument-comment-lint/argument-comment-lint" + +has_manifest_path=false +has_package_selection=false +has_no_deps=false +expect_value="" + +for arg in "$@"; do + if [[ -n "$expect_value" ]]; then + case "$expect_value" in + manifest_path) + has_manifest_path=true + ;; + package_selection) + has_package_selection=true + ;; + esac + expect_value="" + continue + fi + + case "$arg" in + --) + break + ;; + --manifest-path) + expect_value="manifest_path" + ;; + --manifest-path=*) + has_manifest_path=true + ;; + -p|--package) + expect_value="package_selection" + ;; + --package=*) + has_package_selection=true + ;; + --workspace) + has_package_selection=true + ;; + --no-deps) + has_no_deps=true + ;; + esac +done + +lint_args=() +if [[ "$has_manifest_path" == false ]]; then + lint_args+=(--manifest-path "$manifest_path") +fi +if [[ "$has_package_selection" == false ]]; then + lint_args+=(--workspace) +fi +if [[ "$has_no_deps" == false ]]; then + lint_args+=(--no-deps) +fi +lint_args+=("$@") + +if ! command -v dotslash >/dev/null 2>&1; then + cat >&2 </dev/null 2>&1; then + rustup_bin_dir="$(dirname "$(command -v rustup)")" + case ":$PATH:" in + *":$rustup_bin_dir:"*) ;; + *) export PATH="$rustup_bin_dir:$PATH" ;; + esac +fi + +exec "$dotslash_manifest" "${lint_args[@]}" diff --git a/tools/argument-comment-lint/run.sh b/tools/argument-comment-lint/run.sh index 8e3c59714f..26cc3c73f0 100755 --- a/tools/argument-comment-lint/run.sh +++ b/tools/argument-comment-lint/run.sh @@ -5,6 +5,7 @@ set -euo pipefail repo_root="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)" lint_path="$repo_root/tools/argument-comment-lint" manifest_path="$repo_root/codex-rs/Cargo.toml" +toolchain_channel="nightly-2025-09-18" strict_lint="uncommented-anonymous-literal-argument" noise_lint="unknown_lints" @@ -14,6 +15,42 @@ has_no_deps=false has_library_selection=false expect_value="" +ensure_local_prerequisites() { + if ! command -v cargo-dylint >/dev/null 2>&1 || ! command -v dylint-link >/dev/null 2>&1; then + cat >&2 <&2 <