colorls 1.0.11

A fast, production-ready Rust rewrite of colorls: a beautified ls with icons, colors, git status and tree view.
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

// File: src\cli.rs
// Author: Hadi Cahyadi <cumulus13@gmail.com>
// Date: 2026-08-20
// Description:
// License: MIT

use clap::{ArgAction, Parser, ValueEnum};
use clap_color_help::default_styles;
use std::path::PathBuf;

#[derive(Debug, Clone, Copy, PartialEq, Eq, ValueEnum)]
pub enum ColorWhen {
    Auto,
    Always,
    Never,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, ValueEnum)]
pub enum SortBy {
    Name,
    Time,
    Size,
    Extension,
    None,
}

/// A fast, production-ready rewrite of `colorls`: a beautified `ls` with
/// nerd-font icons, colors, git status and a tree view.
///
/// Deliberately no `name`/`bin_name` override here: this binary ships as
/// both `colorls` and `lls` (see Cargo.toml), and `--help`/`--version`
/// should reflect whichever one was actually invoked. `parse_cli()` in
/// main.rs sets both dynamically from argv[0] before parsing.
#[derive(Debug, Parser)]
#[command(version, about, long_about = None, styles=default_styles())]
pub struct Cli {
    /// Files and/or directories to list. Defaults to the current directory.
    pub paths: Vec<PathBuf>,

    /// Show hidden entries (dotfiles), including `.` and `..`.
    #[arg(short = 'a', long = "all")]
    pub all: bool,

    /// Show hidden entries, but omit `.` and `..`.
    #[arg(short = 'A', long = "almost-all")]
    pub almost_all: bool,

    /// Use the long listing format (permissions, owner, size, date).
    #[arg(short = 'l', long = "long")]
    pub long: bool,

    /// One entry per line.
    #[arg(short = '1', long = "oneline")]
    pub oneline: bool,

    /// Show a tree view. Optionally pass a max depth (default from
    /// config.yaml's `tree_depth`, or 3 if unset).
    #[arg(long = "tree", num_args = 0..=1, default_missing_value = "0")]
    pub tree: Option<usize>,

    /// Show per-entry git status (requires the entry to be inside a git
    /// repository; silently skipped otherwise).
    #[arg(long = "gs", visible_alias = "git-status")]
    pub git_status: bool,

    /// List directories before files.
    #[arg(long = "sd", visible_aliases = ["sort-dirs", "group-directories-first"])]
    pub group_directories_first: bool,

    /// List files before directories.
    #[arg(long = "sf", visible_alias = "sort-files")]
    pub sort_files_first: bool,

    /// Sort by modification time, newest first.
    #[arg(short = 't')]
    pub sort_time: bool,

    /// Sort by file size, largest first.
    #[arg(short = 'S', long = "sort-size")]
    pub sort_size: bool,

    /// Sort by file extension.
    #[arg(short = 'X', long = "sort-extension")]
    pub sort_extension: bool,

    /// Reverse whatever sort order is in effect.
    #[arg(short = 'r', long = "reverse")]
    pub reverse: bool,

    /// Use a light color scheme instead of the default dark one.
    #[arg(long = "light", conflicts_with = "dark")]
    pub light: bool,

    /// Force the dark color scheme (overrides config.yaml's `theme:`).
    #[arg(long = "dark")]
    pub dark: bool,

    /// Print a summary report (file/dir counts, total size) after listing.
    #[arg(long = "report")]
    pub report: bool,

    /// Disable nerd-font icons (plain text listing).
    #[arg(long = "no-icons")]
    pub no_icons: bool,

    /// Force-enable nerd-font icons even if config.yaml disables them.
    #[arg(long = "icons", conflicts_with = "no_icons")]
    pub icons: bool,

    /// Control when ANSI colors are used.
    #[arg(long = "color", value_enum, default_value_t = ColorWhen::Auto)]
    pub color: ColorWhen,

    /// Recurse into sub-directories (non-tree, flat long/grid listing).
    #[arg(short = 'R', long = "recursive")]
    pub recursive: bool,

    /// Path to a config directory (or a config.yaml file inside one) to use
    /// instead of the platform default.
    #[arg(long = "config", value_name = "PATH")]
    pub config_path: Option<PathBuf>,

    /// Write the default config files into the resolved config directory
    /// (without overwriting any that already exist) and exit.
    #[arg(long = "init-config")]
    pub init_config: bool,

    /// Print the resolved config directory and exit.
    #[arg(long = "print-config-dir")]
    pub print_config_dir: bool,

    /// Suppress non-fatal warnings (e.g. "git not found").
    #[arg(short = 'q', long = "quiet")]
    pub quiet: bool,

    /// Increase verbosity (repeatable: -v, -vv).
    #[arg(short = 'v', long = "verbose", action = ArgAction::Count)]
    pub verbose: u8,

    /// Page output through `$PAGER` (or `less -R` if unset), so long
    /// listings stay readable — and colored — instead of scrolling past.
    /// Implies color (as if `--color=always`) unless `--color=never` was
    /// also given, since the destination becomes the pager's input rather
    /// than the terminal directly, and the whole point is to preserve
    /// color through it. Falls back to printing directly if no usable
    /// pager is found on PATH.
    #[arg(short = 'p', long = "paginate")]
    pub paginate: bool,
}

impl Cli {
    pub fn show_hidden(&self) -> bool {
        self.all || self.almost_all
    }

    /// Whether synthetic `.` and `..` entries should be added (classic
    /// `ls -a` semantics; `-A` deliberately omits them).
    pub fn include_dot_entries(&self) -> bool {
        self.all && !self.almost_all
    }
}