Skip to content

Create a config file for cargo aliases, so tool commands aren't so painful to type #21597

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 19, 2025
+41 −5
Merged

Create a config file for cargo aliases, so tool commands aren't so painful to type #21597

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions .cargo/config_aliases.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Copy this file to `config.toml` to enable several aliases to commonly-used tools.

[alias]
### Alias for the `build-easefunction-graphs` tool
build-easefunction-graphs = "run --package build-easefunction-graphs --"

### Aliases for the `build-templated-pages` tool
build-templated-pages = "run --package build-templated-pages --"

# Checks for missing data
check-missing-templated-pages = "build-templated-pages check-missing"
check-missing-example-metadata = "check-missing-templated-pages examples"
check-missing-feature-docs = "check-missing-templated-pages features"

# Updates certain templated data
update-templated-pages = "build-templated-pages update"
update-examples-readme = "update-templated-pages examples"
update-feature-docs = "update-templated-pages features"

### Alias for the `build-wasm-example` tool
build-wasm-example = "run --package build-wasm-example --"

### Aliases for the `ci` tool
ci = "run --package ci --"

# 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"
Comment on lines +26 to +41
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 for listing all

5 changes: 0 additions & 5 deletions .cargo/config_fast_builds.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,3 @@ rustflags = [
# In most cases the gains are negligible, but if you are on macOS and have slow compile times you should see significant gains.
# [profile.dev]
# debug = 1

# This enables you to run the CI tool using `cargo ci`.
# This is not enabled by default, you need to copy this file to `config.toml`.
[alias]
ci = "run --package ci --"