Struct FormatCommand 

pub struct FormatCommand {
    pub files: Vec<PathBuf>,
    pub check: bool,
    pub diff: bool,
    pub no_cache: bool,
    pub stdin_filename: Option<PathBuf>,
    pub file_selection: FileSelectionArgs,
    pub dialect: Option<FormatDialectArg>,
    pub indent_style: Option<FormatIndentStyleArg>,
    pub indent_width: Option<u8>,
    pub simplify: bool,
    pub minify: bool,
    /* private fields */
}

Arguments for shuck format.

Fields

files: Vec<PathBuf>

List of files or directories to format, or - to read from stdin.

check: bool

Avoid writing any formatted files back; instead, exit non-zero if any files would change.

diff: bool

Avoid writing any formatted files back; instead, print a diff for each changed file.

no_cache: bool

Disable cache reads and writes.

stdin_filename: Option<PathBuf>

The name of the file when reading the source from stdin.

file_selection: FileSelectionArgs

File discovery and exclusion settings.

dialect: Option<FormatDialectArg>

Override the auto-discovered shell dialect used for parsing and formatting.

indent_style: Option<FormatIndentStyleArg>

Choose the indentation style.

indent_width: Option<u8>

Set the indentation width for space indentation.

simplify: bool

Apply safe simplifications before formatting.

minify: bool

Emit a compact minified form and drop comments.

Implementations

impl FormatCommand

pub fn binary_next_line(&self) -> Option<bool>

Resolve the effective binary-next-line formatter option.

pub fn switch_case_indent(&self) -> Option<bool>

Resolve the effective switch-case-indent formatter option.

pub fn space_redirects(&self) -> Option<bool>

Resolve the effective space-redirects formatter option.

pub fn keep_padding(&self) -> Option<bool>

Resolve the effective keep-padding formatter option.

pub fn function_next_line(&self) -> Option<bool>

Resolve the effective function-next-line formatter option.

pub fn never_split(&self) -> Option<bool>

Resolve the effective never-split formatter option.

pub fn respect_gitignore(&self) -> bool

Whether standard ignore files such as .gitignore should be respected.

pub fn force_exclude(&self) -> bool

Whether excludes should also apply to explicitly passed paths.

Trait Implementations

impl Args for FormatCommand

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 Clone for FormatCommand

fn clone(&self) -> FormatCommand

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FormatCommand

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

Formats the value using the given formatter.

impl FromArgMatches for FormatCommand

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.