gitwrap 0.11.0

GitWrap is a simple wrapper around `git` command
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

// Warning!! Code generated automatically: this file must not be edited by hand
use crate::option_arg;
use crate::wrap_command::FnOptionArg;

pub const RECURSE_DIRECTORIES: &str = "-d";
pub const FORCE: &str = "--force";
pub const INTERACTIVE: &str = "--interactive";
pub const DRY_RUN: &str = "--dry-run";
pub const QUIET: &str = "--quiet";
pub const EXCLUDE: &str = "--exclude";
pub const NO_GITIGNORE: &str = "-x";
pub const GITIGNORE: &str = "-X";
pub const HYPHEN_HYPHEN: &str = "--";

/// Normally, when no <pathspec> is specified, git clean will not recurse into untracked directories to avoid removing too much.
/// Specify -d to have it recurse into such directories as well.
/// If a <pathspec> is specified, -d is irrelevant; all untracked files matching the specified paths (with exceptions for nested git directories mentioned under --force) will be removed
/// -d
pub fn recurse_directories() -> FnOptionArg {
    option_arg::simple(RECURSE_DIRECTORIES)
}

/// If the Git configuration variable clean.requireForce is not set to false, git clean will refuse to delete files or directories unless given -f.
/// Git will refuse to modify untracked nested git repositories (directories with a .git subdirectory) unless a second -f is given
/// -f, --force
pub fn force() -> FnOptionArg {
    option_arg::simple(FORCE)
}

/// Show what would be done and clean files interactively.
/// See “Interactive mode” for details.
/// Configuration variable clean.requireForce is ignored, as this mode gives its own safety protection by going interactive
/// -i, --interactive
pub fn interactive() -> FnOptionArg {
    option_arg::simple(INTERACTIVE)
}

/// Don’t actually remove anything, just show what would be done.
/// Configuration variable clean.requireForce is ignored, as nothing will be deleted anyway
/// -n, --dry-run
pub fn dry_run() -> FnOptionArg {
    option_arg::simple(DRY_RUN)
}

/// Be quiet, only report errors, but not the files that are successfully removed
/// -q, --quiet
pub fn quiet() -> FnOptionArg {
    option_arg::simple(QUIET)
}

/// Use the given exclude pattern in addition to the standard ignore rules.
/// -e=<pattern>, --exclude=<pattern>
pub fn exclude(pattern_arg: &str) -> FnOptionArg {
    option_arg::equal_no_optional(EXCLUDE, pattern_arg)
}

/// Don’t use the standard ignore rules, but still use the ignore rules given with -e options from the command line.
/// This allows removing all untracked files, including build products.
/// This can be used (possibly in conjunction with git restore or git reset) to create a pristine working directory to test a clean build
/// -x
pub fn no_gitignore() -> FnOptionArg {
    option_arg::simple(NO_GITIGNORE)
}

/// Remove only files ignored by Git.
/// This may be useful to rebuild everything from scratch, but keep manually created files
/// -X
pub fn gitignore() -> FnOptionArg {
    option_arg::simple(GITIGNORE)
}

/// Should appear just before any pathspec option
/// --
pub fn hyphen_hyphen() -> FnOptionArg {
    option_arg::simple(HYPHEN_HYPHEN)
}

/// If any optional <pathspec>... arguments are given,
/// only those paths that match the pathspec are affected
/// <pathspec>
pub fn pathspec(pathspec: &str) -> FnOptionArg {
    option_arg::value_parameter(pathspec)
}