Support setting language and output directory in cargo xtask #2776
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
…serve commands. In addition to simplifying building locally (no need to set an environment variable), this makes it possible to use the `cargo xtask build` command in the CI and specify any output location, rather than relying on the build.sh script.
michael-kerscher
requested changes
Jun 16, 2025
xtask/src/main.rs
Outdated
|
|
||
| /// Directory to place the build. If not provided, defaults to the book/ directory (or the book/xx directory if a language is provided). | ||
| #[arg(short, long)] | ||
| output: Option<String>, |
There was a problem hiding this comment.
You could use an Option<PathBuf> for better semantics. If we want to do anything with the provided path we would get a lot of methods for free if we have the correct semantic type
There was a problem hiding this comment.
Done. Thanks didn't know Clap could accept PathBuf! This is much better.
xtask/src/main.rs
Outdated
| if let Some(d) = output { | ||
| command.arg(d); | ||
| } else { | ||
| command.arg(format!("book/{}", language.unwrap_or("".to_string()))); |
There was a problem hiding this comment.
This is a good candidate for a Path otherwise we have directory separator issues e.g. with Windows
xtask/src/main.rs
Outdated
| @@ -176,15 +204,29 @@ fn start_web_server() -> Result<()> { | |||
| Ok(()) | |||
| } | |||
|
|
|||
| fn build() -> Result<()> { | |||
| fn build(language: Option<String>, output: Option<String>) -> Result<()> { | |||
There was a problem hiding this comment.
PathBuf for consistency with the commandline args
xtask/src/main.rs
Outdated
| @@ -156,15 +170,29 @@ fn run_rust_tests() -> Result<()> { | |||
| Ok(()) | |||
| } | |||
|
|
|||
| fn start_web_server() -> Result<()> { | |||
| fn start_web_server(language: Option<String>, output: Option<String>) -> Result<()> { | |||
There was a problem hiding this comment.
output: Option<Pathbuf> for consistency with the PathBuf in the arguments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In addition to simplifying building locally (no need to set an environment variable), this makes it possible to use the
cargo xtask buildcommand in the CI and specify any output location, rather than relying on the build.sh script.