Update arg parsing to clap v3 #1717
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,102 +1,86 @@ | ||
| use std::path::PathBuf; | ||
|
|
||
| use clap::{Parser, Subcommand}; | ||
|
|
||
| #[derive(Parser)] | ||
| #[clap(version, author, about)] | ||
| pub struct Cli { | ||
| /// Directory to use as root of project | ||
| #[clap(short = 'r', long, default_value = ".")] | ||
| pub root: PathBuf, | ||
|
|
||
| /// Path to a config file other than config.toml in the root of project | ||
| #[clap(short = 'c', long)] | ||
| pub config: Option<PathBuf>, | ||
|
|
||
| #[clap(subcommand)] | ||
| pub command: Command, | ||
| } | ||
|
|
||
| #[derive(Subcommand)] | ||
| pub enum Command { | ||
| /// Create a new Zola project | ||
| Init { | ||
| /// Name of the project. Will create a new directory with that name in the current directory | ||
| #[clap(default_value = ".")] | ||
| name: String, | ||
|
|
||
| /// Force creation of project even if directory is non-empty | ||
| #[clap(short = 'f', long)] | ||
| force: bool, | ||
| }, | ||
|
|
||
| /// Deletes the output directory if there is one and builds the site | ||
| Build { | ||
| /// Force the base URL to be that value (defaults to the one in config.toml) | ||
| #[clap(short = 'u', long)] | ||
| base_url: Option<String>, | ||
|
|
||
| /// Outputs the generated site in the given path (by default 'public' dir in project root) | ||
| #[clap(short = 'o', long)] | ||
| output_dir: Option<PathBuf>, | ||
|
|
||
| /// Include drafts when loading the site | ||
| #[clap(long)] | ||
| drafts: bool, | ||
| }, | ||
|
|
||
| /// Serve the site. Rebuild and reload on change automatically | ||
| Serve { | ||
| /// Interface to bind on | ||
| #[clap(short = 'i', long, default_value = "127.0.0.1")] | ||
| interface: String, | ||
|
|
||
| /// Which port to use | ||
| #[clap(short = 'p', long, default_value_t = 1111)] | ||
| port: u16, | ||
|
|
||
| /// Outputs assets of the generated site in the given path (by default 'public' dir in project root). | ||
| /// HTML/XML will be stored in memory. | ||
| #[clap(short = 'o', long)] | ||
| output_dir: Option<PathBuf>, | ||
|
|
||
| /// Changes the base_url | ||
| #[clap(short = 'u', long, default_value = "127.0.0.1")] | ||
| base_url: String, | ||
|
|
||
| /// Include drafts when loading the site | ||
| #[clap(long)] | ||
| drafts: bool, | ||
|
|
||
| /// Open site in the default browser | ||
| #[clap(short = 'O', long)] | ||
| open: bool, | ||
|
|
||
| /// Only rebuild the minimum on change - useful when working on a specific page/section | ||
Keats marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| #[clap(short = 'f', long)] | ||
| fast: bool, | ||
| }, | ||
|
|
||
| /// Try to build the project without rendering it. Checks links | ||
| Check { | ||
| /// Include drafts when loading the site | ||
| #[clap(long)] | ||
| drafts: bool, | ||
| }, | ||
|
There was a problem hiding this comment. can we be explicit with all the default values as well? eg set There was a problem hiding this comment. I've looked at the documentation, but especially for bool flags this is neither elegant to write nor widely accepted style to specify the default explicitly. There was a problem hiding this comment. oh :( There was a problem hiding this comment. Did a quick check and clap protests with a "default value is meaningless for bool" error. I'm guessing the rationale is that bool flags are simple on-off switches and don't require any special handling. |
||
| } | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what does this do and where is it used?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In v3 the completion functionality has been split off to the separate
clap_completepackage, I noticed that there is some completion code in build.rs that is commented out, so admittedly this is a bit preemptive.I guess we could instead add it in a separate PR focused on bringing back completion