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
|
use std::path::{Path, PathBuf};
/// Normalize an input path string into a canonical, platform‑agnostic form.
///
/// This function removes ANSI escape sequences, unifies separators to `/`,
/// collapses duplicate slashes, strips unfriendly characters (`*`, `?`, `"`, `<`, `>`, `|`),
/// resolves simple `..` components, and preserves a trailing slash when present.
///
/// See examples below for the exact normalization behavior.
///
/// # Examples
///
/// ```
/// # use string_proc::format_path::format_path_str;
/// use std::io::Error;
///
/// # fn main() -> Result<(), Error> {
/// assert_eq!(format_path_str("C:\\Users\\\\test")?, "C:/Users/test");
/// assert_eq!(
/// format_path_str("/path/with/*unfriendly?chars")?,
/// "/path/with/unfriendlychars"
/// );
/// assert_eq!(format_path_str("\x1b[31m/path\x1b[0m")?, "/path");
/// assert_eq!(format_path_str("/home/user/dir/")?, "/home/user/dir/");
/// assert_eq!(
/// format_path_str("/home/user/file.txt")?,
/// "/home/user/file.txt"
/// );
/// assert_eq!(
/// format_path_str("/home/my_user/DOCS/JVCS_TEST/Workspace/../Vault/")?,
/// "/home/my_user/DOCS/JVCS_TEST/Vault/"
/// );
/// assert_eq!(format_path_str("./home/file.txt")?, "home/file.txt");
/// assert_eq!(format_path_str("./home/path/")?, "home/path/");
/// assert_eq!(format_path_str("./")?, "");
/// # Ok(())
/// # }
/// ```
pub fn format_path_str(path: impl Into<String>) -> Result<String, std::io::Error> {
let path_str = path.into();
let ends_with_slash = path_str.ends_with('/');
// ANSI Strip
let cleaned = strip_ansi_escapes::strip(&path_str);
let path_without_ansi = String::from_utf8(cleaned)
.map_err(|e| std::io::Error::new(std::io::ErrorKind::InvalidData, e))?;
let path_with_forward_slash = path_without_ansi.replace('\\', "/");
let mut result = String::new();
let mut prev_char = '\0';
for c in path_with_forward_slash.chars() {
if c == '/' && prev_char == '/' {
continue;
}
result.push(c);
prev_char = c;
}
let unfriendly_chars = ['*', '?', '"', '<', '>', '|'];
result = result
.chars()
.filter(|c| !unfriendly_chars.contains(c))
.collect();
// Handle ".." path components
let path_buf = PathBuf::from(&result);
let normalized_path = normalize_path(&path_buf);
result = normalized_path.to_string_lossy().replace('\\', "/");
// Restore trailing slash if original path had one
if ends_with_slash && !result.ends_with('/') {
result.push('/');
}
// Special case: when result is only "./", return ""
if result == "./" {
return Ok(String::new());
}
Ok(result)
}
/// Normalize path by resolving ".." components without requiring file system access
fn normalize_path(path: &Path) -> PathBuf {
let mut components = Vec::new();
for component in path.components() {
match component {
std::path::Component::ParentDir => {
if !components.is_empty() {
components.pop();
}
}
std::path::Component::CurDir => {
// Skip current directory components
}
_ => {
components.push(component);
}
}
}
if components.is_empty() {
PathBuf::from(".")
} else {
components.iter().collect()
}
}
/// Format a [`PathBuf`] into its canonical string form and convert it back.
///
/// This is a convenience wrapper around [`format_path_str`], preserving
/// the semantics of [`PathBuf`] while applying the same normalization rules:
/// - normalize separators to `/`
/// - remove duplicated separators
/// - strip ANSI escape sequences
/// - remove unfriendly characters (`*`, `?`, etc.)
/// - resolve simple `..` segments
pub fn format_path(path: impl Into<PathBuf>) -> Result<PathBuf, std::io::Error> {
let path_str = format_path_str(path.into().display().to_string())?;
Ok(PathBuf::from(path_str))
}
|
