style: reformat imports granularity to module

Choosing module granularity over item granularity is based on a similar
choice made in the standard library to balance readabilty, with easy to
read diffs.

This saves 2098 lines or about 33% of the lines spent writing imports.
This is beneficial to both human readers who have to scroll past large
import blocks when reading a file as well as codex which shouldn't have
to add as many tokens to its context.

Manual changes to rustfmt.toml, rust-ci.yml, justfile, docs/contributing
and docs/install. The actual format commit is intentionally in a second
commit to make it easier to rebase this PR as main moves (drop the
next commit and re-run cargo +nightly fmt).

Added cargo nightly to the ci and justfile. In theory this is unstable,
but in real world use this tends to hit a problems perhaps once every
6 months. The fix is usually fairly easy (pin a version briefly), and
the problems tend to be fixed pretty quickly.
This commit is contained in:
Josh McKinney
2025-11-05 17:33:16 -08:00
parent 229d18f4d2
commit c67908ba17
5 changed files with 18 additions and 8 deletions
+2 -2
View File
@@ -57,11 +57,11 @@ jobs:
working-directory: codex-rs
steps:
- uses: actions/checkout@v5
- uses: dtolnay/rust-toolchain@1.90
- uses: dtolnay/rust-toolchain@nightly
with:
components: rustfmt
- name: cargo fmt
run: cargo fmt -- --config imports_granularity=Item --check
run: cargo +nightly fmt --check # nightly for unstable options in rustfmt.toml
- name: Verify codegen for mcp-types
run: ./mcp-types/check_lib_rs.py
+2 -1
View File
@@ -23,7 +23,8 @@ file-search *args:
# format code
fmt:
cargo fmt -- --config imports_granularity=Item
# Use nightly to enable unstable options in rustfmt.toml
cargo +nightly fmt
fix *args:
cargo clippy --fix --all-features --tests --allow-dirty "$@"
+11 -3
View File
@@ -1,4 +1,12 @@
edition = "2024"
# The warnings caused by this setting can be ignored.
# See https://github.com/openai/openai/pull/298039 for details.
imports_granularity = "Item"
# The following settings are unstable. Generally, to use these settings, you can either use a
# nightly toolchain, or add each args to the cargo fmt command. If using stable, these will emit a
# warning when running cargo fmt.
# Grouping imports by module is a reasonable compromise between readability and conciseness that
# saves about 2000 lines (33%) compared to grouping by item, while still keeping related imports
# together in a way that works well with diffs and code navigation.
group_imports = "StdExternalCrate"
imports_granularity = "Module"
reorder_imports = true
+1 -1
View File
@@ -24,7 +24,7 @@ If you want to add a new feature or change the behavior of an existing one, plea
### Opening a pull request
- Fill in the PR template (or include similar information) - **What? Why? How?**
- Run **all** checks locally (`cargo test && cargo clippy --tests && cargo fmt -- --config imports_granularity=Item`). CI failures that could have been caught locally slow down the process.
- Run **all** checks locally (`cargo test && cargo clippy --tests && cargo +nightly fmt`). CI failures that could have been caught locally slow down the process.
- Make sure your branch is up-to-date with `main` and that you have resolved merge conflicts.
- Mark the PR as **Ready for review** only when you believe it is in a merge-able state.
+2 -1
View File
@@ -24,6 +24,7 @@ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
source "$HOME/.cargo/env"
rustup component add rustfmt
rustup component add clippy
rustup install nightly # For rustfmt with unstable options.
# Build Codex.
cargo build
@@ -32,7 +33,7 @@ cargo build
cargo run --bin codex -- "explain this codebase to me"
# After making changes, ensure the code is clean.
cargo fmt -- --config imports_granularity=Item
cargo +nightly fmt
cargo clippy --tests
# Run the tests.