Introducing clap on tidy #151262

Shunpoco · 2026-01-17T17:25:58Z

Context

Currently tidy parses paths/flags from args_os manually, and the extraction is spreading multiple files. It may be a breeding ground for bugs.

ref: https://rust-lang.zulipchat.com/#narrow/channel/326414-t-infra.2Fbootstrap/topic/How.20--ci.3Dtrue.20interact.20with.20CiEnv.3F/near/543171560
(N.B. We've talked about introducing a ci flag in tidy in that thread, but I don't do it in this PR as I don't want to put multiple changes into a PR. I will introduce the flag in a coming PR.)

Changes

This PR replaces current parsing logic with clap. To confirm the new parser works fine, I introduce an unit test for it.

Build time

We've concerned about how clap increases the build time. In order to confirm the increment is acceptable, I did an experiment on CI:

Run cargo build without cache for tidy 50 times in each environment on CI
Calculate an average and a standard deviation from the result, and plot them

Here is the graph:

Clap tends to increase build time ~2s. We think this is not a big problem
Build time differs in each environment
In some cases standard deviation are high, I suppose that busyness of CI instances affect build time

Noratrieb · 2026-01-19T07:36:17Z

how does this affect the compile times of tidy?

rustbot · 2026-01-24T12:20:08Z

tidy extra checks were modified.

cc @lolbinarycat

rustbot · 2026-01-24T12:20:10Z

r? @Zalathar

rustbot has assigned @Zalathar.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

Zalathar · 2026-01-24T12:42:56Z

r? bootstrap

src/bootstrap/src/core/build_steps/test.rs

Zalathar · 2026-01-25T10:51:10Z

r? Zalathar

Zalathar · 2026-01-28T10:53:14Z

src/tools/tidy/src/parser.rs

+mod tests;
+
+#[derive(Debug, Clone)]
+pub struct TidyParser {


Please rename the module to arg_parser, and rename this struct to TidyArgParser.

The reason is that tidy parses a few different things, so it's good to be clear that this module and type are for parsing command-line arguments.

Zalathar · 2026-01-28T10:53:41Z

src/tools/tidy/src/parser.rs

+    pub verbose: bool,
+    pub bless: bool,
+    pub extra_checks: Option<Vec<String>>,
+    pub pos: Vec<String>,


Please name this pos_args, which I think is a bit clearer.

Zalathar · 2026-01-28T10:54:56Z

Hopefully that's all; sorry for the nitpicks. 😅

@rustbot author

rustbot · 2026-01-28T10:55:00Z

Reminder, once the PR becomes ready for a review, use @rustbot ready.

Shunpoco · 2026-01-28T21:09:22Z

@rustbot ready

Zalathar · 2026-01-29T01:08:09Z

Ah, could you please squash the renames into the main two commits?

It's a bit of extra work, but it really helps when looking back through history.

Current tidy parses paths and options manually, and parsing is spreading multple files. This commit introduces a parser using clap to clean and centralize it.

Currently some required arguments (like path of the root dir) are ordered, but it causes an user (mainly bootstrap) needs to remember the order. This commit introduces long arguments (e.g., --root-path) for required args.

Shunpoco · 2026-01-29T08:22:22Z

Sure thing, I squashed the commit 😄

Zalathar · 2026-01-31T04:10:32Z

Two things that I want to note, but that we can leave for a follow-up PR:

The --npm flag really should be called --yarn, but that is related to some internal identifiers in tidy that should be renamed too.
extra_checks doesn't need to be Option<Vec<String>>; it can just be Vec<String>, but again that would lead to more follow-on changes in tidy.

Zalathar · 2026-01-31T04:11:43Z

@bors r+

rust-bors · 2026-01-31T04:11:46Z

📌 Commit 1485873 has been approved by Zalathar

It is now in the queue for this repository.

Rollup of 4 pull requests Successful merges: - #151262 (Introducing clap on tidy) - #151896 (Revert enabling `outline-atomics` on various platforms) - #151849 (refactor: remove `Ty::pinned_ref` in favor of `Ty::maybe_pinned_ref`) - #151892 (Document enum types used as values for E0423)

Rollup merge of #151262 - Shunpoco:tidy-clap, r=Zalathar Introducing clap on tidy ### Context Currently tidy parses paths/flags from args_os manually, and the extraction is spreading multiple files. It may be a breeding ground for bugs. ref: https://rust-lang.zulipchat.com/#narrow/channel/326414-t-infra.2Fbootstrap/topic/How.20--ci.3Dtrue.20interact.20with.20CiEnv.3F/near/543171560 (N.B. We've talked about introducing a ci flag in tidy in that thread, but I don't do it in this PR as I don't want to put multiple changes into a PR. I will introduce the flag in a coming PR.) ### Changes This PR replaces current parsing logic with clap. To confirm the new parser works fine, I introduce an unit test for it. ### Build time We've concerned about how clap increases the build time. In order to confirm the increment is acceptable, I did an experiment on CI: - Run cargo build without cache for tidy 50 times in each environment on CI - Calculate an average and a standard deviation from the result, and plot them Here is the graph: <img width="943" height="530" alt="rust_tidy_build_time" src="https://github.com/user-attachments/assets/c7deee69-9f38-4044-87dc-76d6e7384f76" /> - Clap tends to increase build time ~2s. We think this is not a big problem - Build time differs in each environment - In some cases standard deviation are high, I suppose that busyness of CI instances affect build time

rustbot added A-tidy Area: The tidy tool S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) labels Jan 17, 2026

Shunpoco changed the title ~~Using clap on tidy~~ [WIP] Using clap on tidy Jan 17, 2026

This comment has been minimized.

Sign in to view

This comment was marked as outdated.

Sign in to view

This was referenced Jan 19, 2026

Check build time of tidy with clap on CI #151387

Closed

Check build time of tidy on CI #151388

Closed

This comment was marked as duplicate.

Sign in to view

This comment has been minimized.

Sign in to view

Shunpoco force-pushed the tidy-clap branch 7 times, most recently from 091ac48 to d0e3e42 Compare January 24, 2026 10:15

Shunpoco changed the title ~~[WIP] Using clap on tidy~~ Introducing clap on tidy Jan 24, 2026

Shunpoco force-pushed the tidy-clap branch 3 times, most recently from 0b2f709 to 95a20e6 Compare January 24, 2026 10:52

Shunpoco marked this pull request as ready for review January 24, 2026 12:20

rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jan 24, 2026

rustbot removed the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Jan 24, 2026

rustbot assigned Zalathar Jan 24, 2026

rustbot assigned jieyouxu Jan 24, 2026

Zalathar reviewed Jan 25, 2026

View reviewed changes

src/bootstrap/src/core/build_steps/test.rs Outdated Show resolved Hide resolved

Shunpoco force-pushed the tidy-clap branch from 4603e8b to 3907e4f Compare January 25, 2026 10:15

rustbot assigned Zalathar and unassigned clubby789 Jan 25, 2026

Zalathar reviewed Jan 28, 2026

View reviewed changes

rustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jan 28, 2026

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jan 28, 2026

Shunpoco added 2 commits January 29, 2026 08:11

use clap on tidy

59c77c4

Current tidy parses paths and options manually, and parsing is spreading multple files. This commit introduces a parser using clap to clean and centralize it.

set long variants for required args

1485873

Currently some required arguments (like path of the root dir) are ordered, but it causes an user (mainly bootstrap) needs to remember the order. This commit introduces long arguments (e.g., --root-path) for required args.

Shunpoco force-pushed the tidy-clap branch from bfffe27 to 1485873 Compare January 29, 2026 08:18

rust-bors bot added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jan 31, 2026

matthiaskrgr mentioned this pull request Jan 31, 2026

Rollup of 4 pull requests #151897

Merged

rust-bors bot merged commit df7d12a into rust-lang:main Jan 31, 2026
11 checks passed

rustbot added this to the 1.95.0 milestone Jan 31, 2026

Shunpoco deleted the tidy-clap branch January 31, 2026 16:30

Uh oh!

Introducing clap on tidy #151262

Introducing clap on tidy #151262

Uh oh!

Conversation

Shunpoco commented Jan 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Context

Changes

Build time

Uh oh!

This comment has been minimized.

Noratrieb commented Jan 19, 2026

Uh oh!

This comment was marked as outdated.

This comment was marked as duplicate.

This comment has been minimized.

rustbot commented Jan 24, 2026

Uh oh!

rustbot commented Jan 24, 2026

Uh oh!

Zalathar commented Jan 24, 2026

Uh oh!

Uh oh!

Zalathar commented Jan 25, 2026

Uh oh!

Zalathar Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Zalathar Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Zalathar commented Jan 28, 2026

Uh oh!

rustbot commented Jan 28, 2026

Uh oh!

Shunpoco commented Jan 28, 2026

Uh oh!

Zalathar commented Jan 29, 2026

Uh oh!

Shunpoco commented Jan 29, 2026

Uh oh!

Zalathar commented Jan 31, 2026

Uh oh!

Zalathar commented Jan 31, 2026

Uh oh!

rust-bors bot commented Jan 31, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Shunpoco commented Jan 17, 2026 •

edited

Loading