Struct CheckArgs 

pub struct CheckArgs {
    pub paths: Vec<PathBuf>,
    pub format: OutputFormat,
    pub fail_on: Vec<Category>,
    pub offline: bool,
    pub cooldown: Option<u64>,
    pub config: Option<PathBuf>,
    pub respect_gitignore: bool,
    pub follow_symlinks: bool,
}

Arguments for deps-cli check.

Fields

paths: Vec<PathBuf>

Paths to walk. Defaults to the current directory when empty.

format: OutputFormat

Output format.

fail_on: Vec<Category>

Comma-separated categories that make the run exit with code 1 (outdated,yanked,vulnerable,unsatisfiable,mutable-ref,license,deprecated). Defaults to vulnerable,yanked,unsatisfiable when omitted (FR-010). A finding that matches none of the seven categories (e.g. an unresolved/unknown package) is always reported but can never fail a run through this flag.

offline: bool

Serve only already-cached registry data; never make a new outbound request.

cooldown: Option<u64>

Overrides freshness.cooldown_secs for this run. Accepts a bare number of seconds or a suffixed duration (30m, 12h, 3d).

config: Option<PathBuf>

Path to a deps.toml config file. Defaults to ./deps.toml when present, and to built-in defaults otherwise.

respect_gitignore: bool

Restore .gitignore/.ignore awareness during the walk (git’s own default behavior). check does not respect either by default (issue #1109): as a CI security gate (git checkout && deps-cli check . against an untrusted fork PR), both files are attacker-controlled input, and a one-line addition to either would otherwise silently remove a manifest from the scan with no warning and exit code 0. Pass this flag only when scanning a target you trust as much as your own deps.toml.

follow_symlinks: bool

Follow symlinks during the directory walk and resolve a symlinked manifest’s target for scanning (issue #1112). A symlink whose resolved, canonicalized target falls outside the walked root is never followed regardless of this flag — see crate::walk::walk’s doc. When this flag is not passed (the default), a symlink to a manifest-shaped file is still detected and reported via a warning (non-zero exit code), it is simply not resolved and scanned.

Implementations

impl CheckArgs

pub fn walk_paths(&self) -> Vec<PathBuf>

The paths to walk: Self::paths verbatim, or the current directory when empty (FR-001).

Examples

use clap::Parser;
use deps_cli::cli::{Cli, Command};

let cli = Cli::parse_from(["deps-cli", "check"]);
let Command::Check(args) = cli.command else {
    unreachable!()
};
assert_eq!(args.walk_paths(), vec![std::path::PathBuf::from(".")]);

pub fn gitignore_policy(&self) -> GitignorePolicy

Self::respect_gitignore translated to GitignorePolicy — the transposition-proof type walk::walk and run_check take, so a bool never has to travel past this point.

pub fn symlink_policy(&self) -> SymlinkPolicy

Self::follow_symlinks translated to SymlinkPolicy — the transposition-proof type walk::walk and run_check take, so a bool never has to travel past this point.

Trait Implementations

impl Args for CheckArgs

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 CheckArgs

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 CheckArgs

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

Formats the value using the given formatter.

impl FromArgMatches for CheckArgs

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 CheckArgs

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.