rusty-detox 0.1.0

Sanitize messy filenames — a Rust port of Doug Harple's `detox(1)` with the filter pipeline (uncgi, iso8859_1, utf_8, safe, wipeup, max_length), `detoxrc` config grammar, recursive collision-safe batch rename, EXDEV cross-device fallback, and a typed library API.
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

//! Default-mode CLI (clap-derive) (FR-014..FR-022).

use clap::{Parser, Subcommand};

/// Sanitize filenames through the configured filter pipeline. A Rust port of
/// Doug Harple's `detox(1)`.
#[derive(Parser, Debug)]
#[command(name = "rusty-detox", about, version, arg_required_else_help = false)]
pub struct Cli {
    /// Dry-run: plan and report renames without issuing any rename syscalls.
    #[arg(short = 'n', long = "dry-run")]
    pub dry_run: bool,

    /// Recursive: descend into directories depth-first leaves-up.
    #[arg(short = 'r', long = "recursive")]
    pub recursive: bool,

    /// Sequence to apply (default: `default`).
    #[arg(short = 's', long = "sequence", value_name = "NAME")]
    pub sequence: Option<String>,

    /// Override config-file resolution with an explicit path.
    #[arg(short = 'f', long = "config-file", value_name = "PATH")]
    pub config_file: Option<String>,

    /// List all loaded sequence names to stdout, one per line.
    #[arg(short = 'L', long = "list-sequences")]
    pub list_sequences: bool,

    /// Verbose: emit one rename line per change to stdout (FR-019).
    #[arg(short = 'v', long = "verbose")]
    pub verbose: bool,

    /// Activate Strict-compat mode (byte-equal upstream stderr, last-wins flag resolution).
    #[arg(long = "strict")]
    pub strict: bool,

    /// Disable Strict-compat mode even when argv[0] or env would activate it.
    #[arg(long = "no-strict", conflicts_with = "strict")]
    pub no_strict: bool,

    /// Optional subcommand.
    #[command(subcommand)]
    pub subcommand: Option<DetoxSubcommand>,

    /// Paths to detox (zero or more).
    pub paths: Vec<String>,
}

/// Subcommands exposed in Default mode only (FR-021/FR-034).
#[derive(Subcommand, Debug)]
pub enum DetoxSubcommand {
    /// Emit a shell-completion script to stdout.
    Completions {
        /// Target shell.
        #[arg(value_enum)]
        shell: clap_complete::Shell,
    },
}