comprehensive-rust/.cargo/config.toml

[alias]
# WARNING: Using the `xtask` alias is deprecated and will be unsupported in a
# future version of Cargo. See https://github.com/rust-lang/cargo/issues/10049.
xtask = "run --package xtask --"
install-tools = "run --package xtask -- install-tools"
web-tests = "run --package xtask -- web-tests"
rust-tests = "run --package xtask -- rust-tests"
serve = "run --package xtask -- serve"
build-book = "run --package xtask -- build"

[env]
# To provide an anchor to the root of the workspace when working with paths.
# See https://github.com/rust-lang/cargo/issues/3946#issuecomment-973132993
CARGO_WORKSPACE_DIR = { value = "", relative = true }
Xtask (#2688) ### Background Comprehensive Rust requires a number of tools to be installed (e.g. mdbook and mdbook-course). As mentioned in #2509 (and discussed in #2469) it would be nice to have a cross platform command for installing these dependencies. Currently these are installed using a shell script (`install-mdbook.sh`) but this isn't truly cross platform e.g. for Windows users. ### Xtask [xtask](https://github.com/matklad/cargo-xtask) outlines an approach for automating tasks in a Rust project. It involves using cargo's aliasing feature to allow us to run commands like `cargo xtask <some task>` to perform adhoc tasks via a Rust binary that we might otherwise need a shell script for. In this PR we add support for a `cargo xtask install-tools` command that will replace the `install-mdbook.sh` script and install the dependent tools. We can potentially extend it to support for other tasks e.g. `cargo xtask fmt`. --------- Co-authored-by: Eric Githinji <egithinji@google.com> 2025-03-14 14:24:08 +03:00			`[alias]`
Provide shorter Cargo aliases for xtool subcommands (#2804) This change deprecates the use of `cargo xtask <tool>` in favor of dedicated aliases for each tool. \| Proposed \| Current \| \|----------\|---------\| \| `cargo install-tools` \| `cargo xtask install-tools` \| \| `cargo web-tests` \| `cargo xtask web-tests` \| \| `cargo rust-tests` \| `cargo xtask rust-tests` \| \| `cargo serve` \| `cargo xtask serve` \| \| `cargo build-book` \| `cargo xtask build` \| _Note_: Because `build` is a pre-existing Cargo sub-command, I've proposed `cargo build-book` as a strawman. Fixes #2803 2025-07-06 05:44:47 +12:00			# WARNING: Using the `xtask` alias is deprecated and will be unsupported in a
			`# future version of Cargo. See https://github.com/rust-lang/cargo/issues/10049.`
Xtask (#2688) ### Background Comprehensive Rust requires a number of tools to be installed (e.g. mdbook and mdbook-course). As mentioned in #2509 (and discussed in #2469) it would be nice to have a cross platform command for installing these dependencies. Currently these are installed using a shell script (`install-mdbook.sh`) but this isn't truly cross platform e.g. for Windows users. ### Xtask [xtask](https://github.com/matklad/cargo-xtask) outlines an approach for automating tasks in a Rust project. It involves using cargo's aliasing feature to allow us to run commands like `cargo xtask <some task>` to perform adhoc tasks via a Rust binary that we might otherwise need a shell script for. In this PR we add support for a `cargo xtask install-tools` command that will replace the `install-mdbook.sh` script and install the dependent tools. We can potentially extend it to support for other tasks e.g. `cargo xtask fmt`. --------- Co-authored-by: Eric Githinji <egithinji@google.com> 2025-03-14 14:24:08 +03:00			`xtask = "run --package xtask --"`
Provide shorter Cargo aliases for xtool subcommands (#2804) This change deprecates the use of `cargo xtask <tool>` in favor of dedicated aliases for each tool. \| Proposed \| Current \| \|----------\|---------\| \| `cargo install-tools` \| `cargo xtask install-tools` \| \| `cargo web-tests` \| `cargo xtask web-tests` \| \| `cargo rust-tests` \| `cargo xtask rust-tests` \| \| `cargo serve` \| `cargo xtask serve` \| \| `cargo build-book` \| `cargo xtask build` \| _Note_: Because `build` is a pre-existing Cargo sub-command, I've proposed `cargo build-book` as a strawman. Fixes #2803 2025-07-06 05:44:47 +12:00			`install-tools = "run --package xtask -- install-tools"`
			`web-tests = "run --package xtask -- web-tests"`
			`rust-tests = "run --package xtask -- rust-tests"`
			`serve = "run --package xtask -- serve"`
			`build-book = "run --package xtask -- build"`
Make install-tools command work from any directory in the workspace. (#2725) This fixes #2708 by creating a CARGO_WORKSPACE_DIR env variable to act as an anchor path, allowing the installation of mdbook-exerciser and mdbook-course to succeed from any directory within the repository. Based on the approach mentioned here: https://github.com/rust-lang/cargo/issues/3946#issuecomment-973132993 --------- Co-authored-by: Eric Githinji <egithinji@google.com> 2025-05-06 09:55:55 +03:00
			`[env]`
			`# To provide an anchor to the root of the workspace when working with paths.`
			`# See https://github.com/rust-lang/cargo/issues/3946#issuecomment-973132993`
			`CARGO_WORKSPACE_DIR = { value = "", relative = true }`