warrah 0.1.0

Warrah: A command-line utility and Rust library that sloppily removes code comments from a text file, supporting 60+ programming languages.
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

use super::generated::{EXTENSION_TO_MARKERS, FILENAME_TO_MARKERS};

/// Returns comment markers for a given file extension.
///
/// # Arguments
///
/// * `extension` - The file extension (must be lowercase, e.g. "rs", "py", "js")
///
/// # Returns
///
/// * `Option<&'static [(&'static str, Option<&'static str>)]>` - Array of comment markers if found:
///   - `Some(markers)` - Array of tuples containing (start_marker, end_marker)
///   - `None` - If extension is not recognized or not lowercase
///
/// # Examples
///
/// ```
/// use warrah::languages::language_maps::get_markers_by_extension;
///
/// // Get Rust comment markers
/// let markers = get_markers_by_extension("rs").unwrap();
/// assert!(markers.contains(&("//", None))); // Single-line comments
/// assert!(markers.contains(&("/*", Some("*/")))); // Multi-line comments
/// ```
pub fn get_markers_by_extension(
    extension: &str,
) -> Option<&'static [(&'static str, Option<&'static str>)]> {
    EXTENSION_TO_MARKERS
        .binary_search_by_key(&extension, |&(ext, _)| ext)
        .ok()
        .map(|idx| EXTENSION_TO_MARKERS[idx].1)
}

/// Returns comment markers for a given filename.
///
/// # Arguments
///
/// * `filename` - The filename (must be lowercase, e.g. "dockerfile", "makefile")
///
/// # Returns
///
/// * `Option<&'static [(&'static str, Option<&'static str>)]>` - Array of comment markers if found:
///   - `Some(markers)` - Array of tuples containing (start_marker, end_marker)
///   - `None` - If filename is not recognized or not lowercase
///
/// # Examples
///
/// ```
/// use warrah::languages::language_maps::get_markers_by_filename;
///
/// // Get Dockerfile comment markers
/// let markers = get_markers_by_filename("dockerfile").unwrap();
/// assert!(markers.contains(&("#", None))); // Single-line comments
/// ```
pub fn get_markers_by_filename(
    filename: &str,
) -> Option<&'static [(&'static str, Option<&'static str>)]> {
    FILENAME_TO_MARKERS
        .binary_search_by_key(&filename, |&(name, _)| name)
        .ok()
        .map(|idx| FILENAME_TO_MARKERS[idx].1)
}

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

    #[test]
    fn test_get_markers_by_extension() {
        // Test known extensions
        let rust_markers = get_markers_by_extension("rs").unwrap();
        assert_eq!(rust_markers.len(), 2);
        assert!(rust_markers.contains(&("//", None)));
        assert!(rust_markers.contains(&("/*", Some("*/"))));

        let python_markers = get_markers_by_extension("py").unwrap();
        assert_eq!(python_markers.len(), 3);
        assert!(python_markers.contains(&("#", None)));
        assert!(python_markers.contains(&("\"\"\"", Some("\"\"\""))));
        assert!(python_markers.contains(&("'''", Some("'''"))));

        // Test case sensitivity
        assert_eq!(get_markers_by_extension("RS"), None);

        // Test unknown extension
        assert_eq!(get_markers_by_extension("xyz"), None);
    }

    #[test]
    fn test_get_markers_by_filename() {
        // Test known filenames
        let dockerfile_markers = get_markers_by_filename("dockerfile").unwrap();
        assert_eq!(dockerfile_markers.len(), 1);
        assert!(dockerfile_markers.contains(&("#", None)));

        let makefile_markers = get_markers_by_filename("makefile").unwrap();
        assert_eq!(makefile_markers.len(), 1);
        assert!(makefile_markers.contains(&("#", None)));

        // Test case sensitivity
        assert_eq!(get_markers_by_filename("DOCKERFILE"), None);

        // Test unknown filename
        assert_eq!(get_markers_by_filename("unknown.txt"), None);
    }
}