rep-grep 0.0.8

wgrep/write-grep CLI
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

use clap::Parser;

#[derive(Debug, Parser)]
// Specify `#[allow(dead_code)]` because the build script (`build.rs`) includes `cli.rs` but doesn't
// use these options which emits a warning.
#[allow(dead_code)]
#[clap(
    version,
    about = "Find and replace on grep output, or edit grep output to apply changes",
    long_about = "Find and replace on grep output, or edit grep output to apply changes.\n\n\
        rep takes grep-formatted lines (e.g., from ripgrep) and applies find and\n\
        replace on the matches.\n\n\
        EXAMPLES:\n  \
          grep -n foo * | rep foo bar       Show diff replacing foo with bar\n  \
          grep -n foo * | rep foo bar -w    Write the replacements to files\n\n\
        EDITING STANDARD INPUT:\n  \
          Changes can also be made by editing the grep output directly, without\n  \
          passing find and replace arguments:\n    \
            1. grep -n foo * > tmp           Save grep matches to a file\n    \
            2. Edit tmp in a text editor     Make changes to the matched lines\n    \
            3. rep < tmp                     Preview the diff\n    \
            4. rep -w < tmp                  Write the changes\n  \
          Editing standard input and applying a find and replace can also be\n  \
          combined (e.g., rep bar baz < tmp).\n\n\
        INPUT FORMAT:\n  \
          Each input line has the format: <file>:<line>:[<column>:]<text>\n  \
          The -n (--line-number) grep flag is required for correct line numbers.\n\n\
        SPECIAL CHARACTERS:\n  \
          Use -- to separate options from arguments when the pattern starts\n  \
          with a hyphen (e.g., rep -- '--foo' '--bar').\n\n\
        PAGER:\n  \
          The default pager is less. Set the REP_PAGER environment variable to\n  \
          override (e.g., export REP_PAGER=delta).",
    disable_help_subcommand = true,
    next_line_help = true,
)]
pub(crate) struct Options {
    #[clap(short = 'w', long = "write")]
    /// Write the output to files directly (instead of outputting a patch). If this flag is not present, and a patch is output, then the default pager is 'less'. The environment variable REP_PAGER can be used to override the pager
    pub write: bool,

    #[clap(short = 'd', long = "delete-lines")]
    /// Delete matching lines
    pub delete: bool,

    #[clap(short = 's', long = "string-mode")]
    /// Treat expressions as non-regex strings
    pub literal_mode: bool,

    #[clap(short = 'n')]
    /// Limit the number of replacements per line
    pub replacements: Option<usize>,

    #[clap(long = "color")]
    /// Enable color (the default if the output is a TTY)
    pub color: bool,

    #[clap(long = "no-color")]
    /// Disable color
    pub no_color: bool,

    #[clap(long = "stdout")]
    /// Force printing to standard output without using a pager
    pub stdout: bool,

    #[clap(short = 'f', long = "flags")]
    /// Regex flags, may be combined (like '-f mc'). 'c': case-sensitive, 'e': disable multi-line matching, 'i': case-insensitive, 'm': multi-line matching, 's': make '.' match newlines, 'w': match full words only
    pub flags: Option<String>,

    /// The regexp or string (if -s) to search for
    pub find: Option<String>,

    /// What to replace each match with. Unless in string mode, you may use captured values like $1, $2, etc
    pub replace_with: Option<String>,
}