abbaa3943e
# Objective - Many of the items in the `ci` tool use `pub(crate)`, which is functionally equivalent to `pub` when the crate is not a library. - A few items are missing documentation. ## Solution - Make all `pub(crate)` items just `pub`. - `pub` is easier to type and less obscure, and there's not harm from this change. - Add / modify documentation on `CI`, `Prepare`, and `PreparedCommand`.
18 lines
510 B
Rust
18 lines
510 B
Rust
use crate::{Flag, Prepare, PreparedCommand};
|
|
use argh::FromArgs;
|
|
use xshell::cmd;
|
|
|
|
/// Check code formatting.
|
|
#[derive(FromArgs, Default)]
|
|
#[argh(subcommand, name = "format")]
|
|
pub struct FormatCommand {}
|
|
|
|
impl Prepare for FormatCommand {
|
|
fn prepare<'a>(&self, sh: &'a xshell::Shell, _flags: Flag) -> Vec<PreparedCommand<'a>> {
|
|
vec![PreparedCommand::new::<Self>(
|
|
cmd!(sh, "cargo fmt --all -- --check"),
|
|
"Please run 'cargo fmt --all' to format your code.",
|
|
)]
|
|
}
|
|
}
|