colorls 1.0.7

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
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
213
214
215
216
217
218
219
220
221
222
223
224
225

use std::fs;
use std::path::{Path, PathBuf};
use std::time::SystemTime;

#[derive(Debug, Clone)]
pub struct FileEntry {
    pub path: PathBuf,
    pub name: String,
    pub is_dir: bool,
    pub is_symlink: bool,
    pub symlink_target: Option<PathBuf>,
    pub is_broken_symlink: bool,
    pub size: u64,
    pub modified: Option<SystemTime>,
    pub readonly: bool,
    #[cfg(unix)]
    pub mode: u32,
    #[cfg(unix)]
    pub uid: u32,
    #[cfg(unix)]
    pub gid: u32,
}

impl FileEntry {
    /// Build a `FileEntry` from a directory-listing path. `symlink_metadata`
    /// is used first so that broken symlinks are still listed instead of
    /// causing an error.
    pub fn from_path(path: &Path) -> std::io::Result<FileEntry> {
        let name = path
            .file_name()
            .map(|n| n.to_string_lossy().to_string())
            .unwrap_or_else(|| path.to_string_lossy().to_string());

        let lstat = fs::symlink_metadata(path)?;
        let is_symlink = lstat.file_type().is_symlink();

        let (target, broken) = if is_symlink {
            match fs::read_link(path) {
                Ok(target) => {
                    let resolved = if target.is_relative() {
                        path.parent()
                            .unwrap_or_else(|| Path::new("."))
                            .join(&target)
                    } else {
                        target.clone()
                    };
                    let broken = fs::metadata(resolved).is_err();
                    (Some(target), broken)
                }
                Err(_) => (None, true),
            }
        } else {
            (None, false)
        };

        // Prefer metadata following the symlink (so directories-that-are-
        // symlinks are recognised as such); fall back to lstat if the link
        // is broken.
        let stat = fs::metadata(path).unwrap_or(lstat.clone());

        #[cfg(unix)]
        {
            use std::os::unix::fs::MetadataExt;
            use std::os::unix::fs::PermissionsExt;
            Ok(FileEntry {
                path: path.to_path_buf(),
                name,
                is_dir: stat.is_dir(),
                is_symlink,
                symlink_target: target,
                is_broken_symlink: broken,
                size: stat.len(),
                modified: stat.modified().ok(),
                readonly: stat.permissions().readonly(),
                mode: lstat.permissions().mode(),
                uid: stat.uid(),
                gid: stat.gid(),
            })
        }

        #[cfg(not(unix))]
        {
            Ok(FileEntry {
                path: path.to_path_buf(),
                name,
                is_dir: stat.is_dir(),
                is_symlink,
                symlink_target: target,
                is_broken_symlink: broken,
                size: stat.len(),
                modified: stat.modified().ok(),
                readonly: stat.permissions().readonly(),
            })
        }
    }

    pub fn extension(&self) -> Option<String> {
        self.path
            .extension()
            .map(|e| e.to_string_lossy().to_lowercase())
    }

    pub fn is_hidden(&self) -> bool {
        self.name.starts_with('.')
    }

    pub fn is_executable(&self) -> bool {
        #[cfg(unix)]
        {
            self.mode & 0o111 != 0
        }
        #[cfg(not(unix))]
        {
            matches!(
                self.extension().as_deref(),
                Some("exe") | Some("bat") | Some("cmd") | Some("msi") | Some("ps1")
            )
        }
    }
}

/// Build the synthetic `.` and `..` entries shown by `-a` (but not `-A`),
/// mirroring classic `ls -a` semantics.
pub fn dot_entries(dir: &Path) -> std::io::Result<[FileEntry; 2]> {
    let mut here = FileEntry::from_path(dir)?;
    here.name = ".".to_string();

    // `Path::parent()` on "." yields `Some("")` (an empty, unusable path)
    // rather than `None`, so resolve via the absolute path instead of
    // relying on `parent()` directly on a possibly-relative `dir`.
    let parent = std::fs::canonicalize(dir)
        .ok()
        .and_then(|abs| abs.parent().map(Path::to_path_buf))
        .unwrap_or_else(|| dir.to_path_buf());
    let mut up = FileEntry::from_path(&parent)?;
    up.name = "..".to_string();

    Ok([here, up])
}

/// Read a directory's immediate children as `FileEntry`s, silently skipping
/// entries that vanish between the readdir and the stat call (a normal race
/// on any real filesystem) but surfacing every other I/O error.
pub fn read_dir_entries(dir: &Path) -> std::io::Result<Vec<FileEntry>> {
    let mut out = Vec::new();
    for item in fs::read_dir(dir)? {
        let item = item?;
        match FileEntry::from_path(&item.path()) {
            Ok(entry) => out.push(entry),
            Err(e) if e.kind() == std::io::ErrorKind::NotFound => continue,
            Err(e) => return Err(e),
        }
    }
    Ok(out)
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::io::Write;

    #[test]
    fn extension_lowercased() {
        let dir = std::env::temp_dir().join(format!("colorls_test_{}", std::process::id()));
        std::fs::create_dir_all(&dir).unwrap();
        let file_path = dir.join("Example.RS");
        std::fs::File::create(&file_path)
            .unwrap()
            .write_all(b"fn main(){}")
            .unwrap();

        let entry = FileEntry::from_path(&file_path).unwrap();
        assert_eq!(entry.extension().as_deref(), Some("rs"));
        assert!(!entry.is_dir);
        assert!(!entry.is_hidden());

        std::fs::remove_dir_all(&dir).ok();
    }

    #[test]
    fn hidden_file_detected() {
        let dir = std::env::temp_dir().join(format!("colorls_test_hidden_{}", std::process::id()));
        std::fs::create_dir_all(&dir).unwrap();
        let file_path = dir.join(".env");
        std::fs::File::create(&file_path).unwrap();

        let entry = FileEntry::from_path(&file_path).unwrap();
        assert!(entry.is_hidden());

        std::fs::remove_dir_all(&dir).ok();
    }

    #[test]
    fn dot_entries_resolve_from_relative_dot() {
        // Regression test: `Path::new(".").parent()` returns `Some("")`
        // (not `None`), which previously made `..` resolution fail.
        let original_dir = std::env::current_dir().unwrap();
        std::env::set_current_dir(std::env::temp_dir()).unwrap();

        let result = dot_entries(Path::new("."));
        std::env::set_current_dir(original_dir).unwrap();

        let dots = result.unwrap();
        assert_eq!(dots[0].name, ".");
        assert_eq!(dots[1].name, "..");
    }

    #[test]
    fn broken_symlink_detected() {
        #[cfg(unix)]
        {
            let dir =
                std::env::temp_dir().join(format!("colorls_test_link_{}", std::process::id()));
            std::fs::create_dir_all(&dir).unwrap();
            let link_path = dir.join("broken_link");
            std::os::unix::fs::symlink(dir.join("does_not_exist"), &link_path).unwrap();

            let entry = FileEntry::from_path(&link_path).unwrap();
            assert!(entry.is_symlink);
            assert!(entry.is_broken_symlink);

            std::fs::remove_dir_all(&dir).ok();
        }
    }
}