basefmt 0.1.0

A formatter that applies universal formatting rules to any text file
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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273

use ignore::Walk;
use std::io;
use std::path::Path;
use std::path::PathBuf;

/// Finds all files in the specified paths, respecting .gitignore patterns.
///
/// Recursively searches through directories and returns a list of all files found.
/// Hidden files and files specified in .gitignore are automatically excluded
/// by the `ignore` crate.
///
/// # Arguments
///
/// * `paths` - A slice of paths (files or directories) to search
///
/// # Returns
///
/// Returns `Ok(Vec<PathBuf>)` containing all files found, or an error if:
/// - Any path cannot be accessed or read
/// - Errors occurred during directory traversal
///
/// # Examples
///
/// ```no_run
/// use basefmt::find::find_files;
/// use std::path::Path;
///
/// let files = find_files(&[Path::new("src")]).unwrap();
/// println!("Found {} files", files.len());
/// ```
pub fn find_files(paths: &[impl AsRef<Path>]) -> io::Result<Vec<PathBuf>> {
    let mut files: Vec<PathBuf> = Vec::new();
    let mut error_paths: Vec<String> = Vec::new();

    for path in paths {
        let path = path.as_ref();

        match path.metadata() {
            Ok(_) => {
                for result in Walk::new(path) {
                    match result {
                        Ok(entry) => {
                            if entry.file_type().is_some_and(|ft| ft.is_file()) {
                                files.push(entry.into_path());
                            }
                        }
                        Err(err) => {
                            eprintln!("{}: {}", path.display(), err);
                            error_paths.push(path.display().to_string());
                        }
                    }
                }
            }
            Err(err) => {
                eprintln!("{}: {}", path.display(), err);
                error_paths.push(path.display().to_string());
            }
        }
    }

    if !error_paths.is_empty() {
        Err(io::Error::other(format!(
            "errors occurred while processing files: {}",
            error_paths.join(", ")
        )))
    } else {
        Ok(files)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::fs;
    use tempfile::TempDir;

    #[test]
    fn test_find_single_file() {
        let temp_dir = TempDir::new().unwrap();
        let file_path = temp_dir.path().join("test.txt");
        fs::write(&file_path, "content").unwrap();

        let result = find_files(&[&file_path]).unwrap();

        assert_eq!(result.len(), 1);
        assert_eq!(result[0], file_path);
    }

    #[test]
    fn test_find_files_in_directory() {
        let temp_dir = TempDir::new().unwrap();
        let file1 = temp_dir.path().join("file1.txt");
        let file2 = temp_dir.path().join("file2.txt");
        fs::write(&file1, "content1").unwrap();
        fs::write(&file2, "content2").unwrap();

        let result = find_files(&[temp_dir.path()]).unwrap();

        assert_eq!(result.len(), 2);
        assert!(result.contains(&file1));
        assert!(result.contains(&file2));
    }

    #[test]
    fn test_find_files_in_nested_directory() {
        let temp_dir = TempDir::new().unwrap();
        let subdir = temp_dir.path().join("subdir");
        fs::create_dir(&subdir).unwrap();

        let file1 = temp_dir.path().join("file1.txt");
        let file2 = subdir.join("file2.txt");
        fs::write(&file1, "content1").unwrap();
        fs::write(&file2, "content2").unwrap();

        let result = find_files(&[temp_dir.path()]).unwrap();

        assert_eq!(result.len(), 2);
        assert!(result.contains(&file1));
        assert!(result.contains(&file2));
    }

    #[test]
    fn test_find_files_from_multiple_paths() {
        let temp_dir1 = TempDir::new().unwrap();
        let temp_dir2 = TempDir::new().unwrap();

        let file1 = temp_dir1.path().join("file1.txt");
        let file2 = temp_dir2.path().join("file2.txt");
        fs::write(&file1, "content1").unwrap();
        fs::write(&file2, "content2").unwrap();

        let result = find_files(&[&file1, &file2]).unwrap();

        assert_eq!(result.len(), 2);
        assert!(result.contains(&file1));
        assert!(result.contains(&file2));
    }

    #[test]
    fn test_find_files_mixed_file_and_directory() {
        let temp_dir = TempDir::new().unwrap();
        let file1 = temp_dir.path().join("file1.txt");
        let subdir = temp_dir.path().join("subdir");
        fs::create_dir(&subdir).unwrap();
        let file2 = subdir.join("file2.txt");

        fs::write(&file1, "content1").unwrap();
        fs::write(&file2, "content2").unwrap();

        let result = find_files(&[&file1, &subdir]).unwrap();

        assert_eq!(result.len(), 2);
        assert!(result.contains(&file1));
        assert!(result.contains(&file2));
    }

    #[test]
    fn test_find_files_nonexistent_path() {
        let nonexistent = PathBuf::from("/nonexistent/path/file.txt");

        let result = find_files(&[&nonexistent]);

        assert!(result.is_err());
    }

    #[test]
    fn test_find_files_ignores_directories_in_results() {
        let temp_dir = TempDir::new().unwrap();
        let subdir = temp_dir.path().join("subdir");
        fs::create_dir(&subdir).unwrap();
        let file = subdir.join("file.txt");
        fs::write(&file, "content").unwrap();

        let result = find_files(&[temp_dir.path()]).unwrap();

        // Should only include the file, not the directory itself
        assert_eq!(result.len(), 1);
        assert_eq!(result[0], file);
    }

    #[test]
    fn test_find_files_empty_directory() {
        let temp_dir = TempDir::new().unwrap();

        let result = find_files(&[temp_dir.path()]).unwrap();

        assert_eq!(result.len(), 0);
    }

    #[test]
    fn test_find_files_respects_gitignore() {
        let temp_dir = TempDir::new().unwrap();

        // Create .git directory to make ignore crate recognize .gitignore
        let git_dir = temp_dir.path().join(".git");
        fs::create_dir(&git_dir).unwrap();

        // Create a .gitignore file
        let gitignore_path = temp_dir.path().join(".gitignore");
        fs::write(&gitignore_path, "ignored.txt\n").unwrap();

        // Create both ignored and non-ignored files
        let ignored_file = temp_dir.path().join("ignored.txt");
        let normal_file = temp_dir.path().join("normal.txt");
        fs::write(&ignored_file, "ignored content").unwrap();
        fs::write(&normal_file, "normal content").unwrap();

        let result = find_files(&[temp_dir.path()]).unwrap();

        // The ignore crate automatically ignores .git directories and .gitignore files
        // So we should only see the normal.txt file
        assert_eq!(result.len(), 1, "Found files: {result:?}");
        assert!(!result.contains(&ignored_file));
        assert!(result.contains(&normal_file));
    }

    #[test]
    #[cfg(unix)]
    fn test_find_files_follows_symlinks_to_files() {
        use std::os::unix::fs as unix_fs;

        let temp_dir = TempDir::new().unwrap();
        let real_file = temp_dir.path().join("real.txt");
        let symlink_file = temp_dir.path().join("link.txt");

        fs::write(&real_file, "content").unwrap();
        unix_fs::symlink(&real_file, &symlink_file).unwrap();

        let result = find_files(&[&symlink_file]).unwrap();

        // Should find the symlink (or the target, depending on ignore crate behavior)
        assert_eq!(result.len(), 1);
    }

    #[test]
    #[cfg(unix)]
    fn test_find_files_handles_broken_symlinks() {
        use std::os::unix::fs as unix_fs;

        let temp_dir = TempDir::new().unwrap();
        let broken_symlink = temp_dir.path().join("broken_link.txt");

        // Create a symlink to a non-existent file
        unix_fs::symlink("/nonexistent/file.txt", &broken_symlink).unwrap();

        let result = find_files(&[&broken_symlink]);

        // Should handle broken symlinks gracefully (error or skip)
        // The exact behavior depends on the ignore crate
        assert!(result.is_ok() || result.is_err());
    }

    #[test]
    #[cfg(unix)]
    fn test_find_files_follows_symlinks_to_directories() {
        use std::os::unix::fs as unix_fs;

        let temp_dir = TempDir::new().unwrap();
        let real_dir = temp_dir.path().join("real_dir");
        let symlink_dir = temp_dir.path().join("link_dir");

        fs::create_dir(&real_dir).unwrap();
        let file_in_dir = real_dir.join("file.txt");
        fs::write(&file_in_dir, "content").unwrap();

        unix_fs::symlink(&real_dir, &symlink_dir).unwrap();

        let result = find_files(&[&symlink_dir]).unwrap();

        // Should find files inside the symlinked directory
        assert_eq!(result.len(), 1);
    }
}