recurse 0.3.0

Recursive directory traversal file management tool
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212

//! # recurse
//!
//! ## A cross-platform recursive directory traversal file management tool
//!
//! ![Version](https://img.shields.io/github/v/release/chrissimpkins/recurse?sort=semver)
//! [![GNU/Linux CI](https://github.com/chrissimpkins/recurse/workflows/GNU/Linux%20CI/badge.svg)](https://github.com/chrissimpkins/recurse/actions?query=workflow%3A%22GNU%2FLinux+CI%22)
//! [![macOS CI](https://github.com/chrissimpkins/recurse/workflows/macOS%20CI/badge.svg)](https://github.com/chrissimpkins/recurse/actions?query=workflow%3A%22macOS+CI%22)
//! [![Windows CI](https://github.com/chrissimpkins/recurse/workflows/Windows%20CI/badge.svg)](https://github.com/chrissimpkins/recurse/actions?query=workflow%3A%22Windows+CI%22)
//! [![codecov](https://codecov.io/gh/chrissimpkins/recurse/branch/master/graph/badge.svg)](https://codecov.io/gh/chrissimpkins/recurse)
//!
//! ## About
//!
//! The `recurse` executable is a cross-platform, command line file management tool with *default* recursive directory traversal and regular expression pattern matching support.  It is built in Rust and tested against the stable, beta, and nightly Rust toolchains on GNU/Linux, macOS, and Windows platforms.
//!
//! The project is at an early stage of development and should not be considered stable for general use at the moment.
//!
//! Detailed documentation is available on the [repository README page](https://github.com/chrissimpkins/recurse).
//!
//!
//! ## Installation
//!
//! ```notest
//! $ cargo install recurse
//! ```
//!
//! The `recurse` executable will be available on your system PATH after this install step.
//!
//! ## Usage
//!
//! `recurse` functionality is exposed through executable sub-commands.  Use `recurse --help` or see the [project README documentation](https://github.com/chrissimpkins/recurse) for additional details.
//!
//! ## Contributing
//!
//! Please file issue reports on the [GitHub repository issue tracker](https://github.com/chrissimpkins/recurse/issues).
//!
//! Source contributions under the Apache License, v2.0 are welcomed.  Please submit a pull request on the GitHub repository with your change proposal.
//!
//! ## License
//!
//! [Apache License, v2.0](https://github.com/chrissimpkins/recurse/blob/master/LICENSE.md)

use std::path::PathBuf;

use anyhow::Result;
use structopt::StructOpt;

pub(crate) mod command;
pub(crate) mod config;
pub(crate) mod ops;

use command::contains::ContainsCommand;
use command::find::FindCommand;
use command::replace::ReplaceCommand;
use command::walk::WalkCommand;
use command::Command;
use config::Config;
/// The command line argument implementation
#[derive(StructOpt, Debug)]
#[structopt(about = "Recursive directory traversal file management tool")]
enum Recurse {
    #[structopt(about = "Test for string in text files")]
    Contains {
        /// File extension filter
        #[structopt(short = "e", long = "ext", help = "File extension filter")]
        extension: Option<String>,

        /// Include hidden files under dot directory or dot file paths
        /// The default is to not include these files
        #[structopt(short = "a", long = "all", help = "Include hidden files")]
        hidden: bool,

        /// Define the minimum depth of the directory traversal
        #[structopt(long = "mindepth", help = "Minimum directory depth")]
        mindepth: Option<usize>,

        /// Define the maximum depth of the directory traversal
        #[structopt(long = "maxdepth", help = "Maximum directory depth")]
        maxdepth: Option<usize>,

        /// Follow symbolic links
        /// Default is to not follow symbolic links
        #[structopt(long = "symlinks", help = "Follow symbolic links")]
        symlinks: bool,

        /// Find string
        #[structopt(help = "Find regular expression pattern")]
        find: String,

        /// Input file
        #[structopt(parse(from_os_str), help = "Traversal start path")]
        inpath: PathBuf,
    },
    #[structopt(about = "Find strings in text files")]
    Find {
        /// File extension filter
        #[structopt(short = "e", long = "ext", help = "File extension filter")]
        extension: Option<String>,

        /// Include hidden files under dot directory or dot file paths
        /// The default is to not include these files
        #[structopt(short = "a", long = "all", help = "Include hidden files")]
        hidden: bool,

        /// Define the minimum depth of the directory traversal
        #[structopt(long = "mindepth", help = "Minimum directory depth")]
        mindepth: Option<usize>,

        /// Define the maximum depth of the directory traversal
        #[structopt(long = "maxdepth", help = "Maximum directory depth")]
        maxdepth: Option<usize>,

        /// Follow symbolic links
        /// Default is to not follow symbolic links
        #[structopt(long = "symlinks", help = "Follow symbolic links")]
        symlinks: bool,

        /// Find string
        #[structopt(help = "Find regular expression pattern")]
        find: String,

        /// Input file
        #[structopt(parse(from_os_str), help = "Traversal start path")]
        inpath: PathBuf,
    },
    #[structopt(about = "Replace strings in text files")]
    Replace {
        /// File extension filter
        #[structopt(short = "e", long = "ext", help = "File extension filter")]
        extension: Option<String>,

        /// Include hidden files under dot directory or dot file paths
        /// The default is to not include these files
        #[structopt(short = "a", long = "all", help = "Include hidden files")]
        hidden: bool,

        /// Skip backup write of original file
        #[structopt(long = "nobu", help = "Write inplace without backup")]
        nobu: bool,

        /// Define the minimum depth of the directory traversal
        #[structopt(long = "mindepth", help = "Minimum directory depth")]
        mindepth: Option<usize>,

        /// Define the maximum depth of the directory traversal
        #[structopt(long = "maxdepth", help = "Maximum directory depth")]
        maxdepth: Option<usize>,

        /// Follow symbolic links
        /// Default is to not follow symbolic links
        #[structopt(long = "symlinks", help = "Follow symbolic links")]
        symlinks: bool,

        /// Find string
        #[structopt(short = "f", long = "find", help = "Find regular expression pattern")]
        find: String,

        /// Replace string
        #[structopt(short = "r", long = "replace", help = "Replace string")]
        replace: String,

        /// Input file
        #[structopt(parse(from_os_str), help = "Traversal start path")]
        inpath: PathBuf,
    },
    #[structopt(about = "Walk the directory structure for paths")]
    Walk {
        /// File extension filter
        #[structopt(short = "e", long = "ext", help = "File path extension filter")]
        extension: Option<String>,

        /// Directory only filter
        #[structopt(short = "d", long = "dir", help = "Include directory paths only")]
        dir_only: bool,

        /// Include hidden files under dot directory or dot file paths
        /// The default is to not include these paths
        #[structopt(short = "a", long = "all", help = "Include hidden paths")]
        hidden: bool,

        /// Input file
        #[structopt(parse(from_os_str), help = "Traversal start path")]
        inpath: PathBuf,

        /// Define the minimum depth of the directory traversal
        #[structopt(long = "mindepth", help = "Minimum directory depth")]
        mindepth: Option<usize>,

        /// Define the maximum depth of the directory traversal
        #[structopt(long = "maxdepth", help = "Maximum directory depth")]
        maxdepth: Option<usize>,

        /// Follow symbolic links
        /// Default is to not follow symbolic links
        #[structopt(long = "symlinks", help = "Follow symbolic links")]
        symlinks: bool,
    },
}

/// `recurse` executable execution entry point
pub fn run() -> Result<()> {
    let config = Config::new(Recurse::from_args());
    match &config.subcmd {
        Recurse::Contains { .. } => {
            return ContainsCommand::execute(config.subcmd, &mut std::io::stdout())
        }
        Recurse::Find { .. } => return FindCommand::execute(config.subcmd, &mut std::io::stdout()),
        Recurse::Replace { .. } => {
            return ReplaceCommand::execute(config.subcmd, &mut std::io::stdout())
        }
        Recurse::Walk { .. } => return WalkCommand::execute(config.subcmd, &mut std::io::stdout()),
    }
}