Create a config file for cargo aliases, so tool commands aren't so painful to type #21597
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
LikeLakers2
commented
Oct 18, 2025
Comment on lines
+26
to
+41
| # Check each file under `tools/ci/src/commands/` to see what each individual command does | ||
| ci-bench-check = "ci bench-check" | ||
| ci-clippy = "ci clippy" | ||
| ci-compile = "ci compile" | ||
| ci-compile-check = "ci compile-check" | ||
| ci-compile-fail = "ci compile-fail" | ||
| ci-doc = "ci doc" | ||
| ci-doc-check = "ci doc-check" | ||
| ci-doc-test = "ci doc-test" | ||
| ci-example-check = "ci example-check" | ||
| ci-format = "ci format" | ||
| ci-integration-test-check = "ci integration-test-check" | ||
| ci-integration-test-clean = "ci integration-test-clean" | ||
| ci-integration-test-run = "ci integration-test" | ||
| ci-lints = "ci lints" | ||
| ci-test = "ci test" |
There was a problem hiding this comment.
I'm not 100% on whether every single ci command should have its own alias.
On the one hand, this allows them to show up as valid commands in cargo --list. This alone makes me want to include them, such that people know they exist without needing to check the source code of the ci tool.
On the other, it doesn't save any time compared to, say, cargo ci doc.
Zeophlite
approved these changes
Oct 19, 2025
Zeophlite
added
A-Build-System
mockersf
approved these changes
Oct 19, 2025
|
I'm not sure they will be easy to keep in sync with the actual commands, but they don't change that much and people who cares about the alias will update them |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Objective
To be honest, typing tool commands suck due to just how long the commands are.
Also, what is a
cialias doing in a config file meant for fast builds...?Solution
Create a config file for cargo aliases, under
.cargo/config_aliases.toml, with many short aliases to useful commands.Now instead of typing
cargo run -p build-templated-pages -- update features, you can just runcargo update-feature-docs. :DTesting
This change was tested by copying
.cargo/config_aliases.tomlto.cargo/config.toml, and runningcargo --listto confirm that they showed up.I also ran a few (but not all) of these aliases to ensure they work.