Struct Cli

pub struct Cli {

    pub filename: String,
    pub minlen: usize,
    pub noop: bool,
    pub only_list_typos: bool,
    pub details: bool,
    pub message: String,
    pub exclude_file: Option<Vec<String>>,
    pub exclude_typo: Option<Vec<String>>,
    pub exclude_correction: Option<Vec<String>>,
    pub debug: bool,
    pub contributors: bool,
    pub changelog: bool,
    pub completion: Option<Shell>,
}

This program analyzes a json file produced with typos and makes commits for each correction.

Fields

filename: String

typos file filename to analyze

minlen: usize

minimum length of the typo correction to be considered as correctable automatically.

noop: bool

Prints what it will do without doing it

only_list_typos: bool

Lists typos found in a brief way (does not modify anything)

details: bool

Details output of –only-list-typos option

message: String

Message to be used in commits. It may use ‘{typo}’ and ‘{correction}’.

exclude_file: Option<Vec<String>>

Excludes file from being included in corrections.

exclude_typo: Option<Vec<String>>

Excludes typo from being corrected.

exclude_correction: Option<Vec<String>>

Excludes a correction from being correctable.

debug: bool

Debug options that prints information to know what is going on

contributors: bool

prints typos-git-commit contributor’s list

changelog: bool

prints typos-git-commit changelog

completion: Option<Shell>

prints typos-git-commit bash completion’s shell script

Implementations

impl Cli

pub fn analyze() -> Self

Trait Implementations

impl Args for Cli

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl CommandFactory for Cli

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Cli

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for Cli

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Cli

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.