blockwatch 0.5.3

Language agnostic linter that keeps your code and documentation in sync and valid
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

use crate::block_parser::{BlocksFromCommentsParser, BlocksParser};
use crate::language_parsers::{
    CommentsParser, TreeSitterCommentsParser, c_style_multiline_comment_processor, comment_visitor,
};

/// Returns a [`BlocksParser`] for CSS.
pub(super) fn parser() -> anyhow::Result<impl BlocksParser> {
    Ok(BlocksFromCommentsParser::new(comments_parser()?))
}

fn comments_parser() -> anyhow::Result<impl CommentsParser> {
    let css_language = tree_sitter_css::LANGUAGE.into();
    let parser = TreeSitterCommentsParser::new(
        &css_language,
        comment_visitor(|node, source_code| {
            if node.kind() == "comment" {
                Some(c_style_multiline_comment_processor(
                    &source_code[node.byte_range()],
                ))
            } else {
                None
            }
        }),
    );
    Ok(parser)
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{Position, language_parsers::Comment};

    #[test]
    fn parses_css_comments_correctly() -> anyhow::Result<()> {
        let mut comments_parser = comments_parser()?;

        let blocks: Vec<Comment> = comments_parser
            .parse(
                r#"
            body {
                color: black;
            }
    
            /* This is a CSS comment */
            .header {
                /* This is a multi-line
                 * CSS comment that spans
                 * multiple lines
                 */
                font-size: 16px;
            }
            
            /* Another multi-line
               CSS comment with
               different formatting */
            "#,
            )
            .collect();

        assert_eq!(
            blocks,
            vec![
                Comment {
                    position_range: Position::new(6, 13)..Position::new(6, 40),
                    source_range: 81..108,
                    comment_text: "   This is a CSS comment   ".to_string()
                },
                Comment {
                    position_range: Position::new(8, 17)..Position::new(11, 20),
                    source_range: 147..266,
                    comment_text: "   This is a multi-line\n                   CSS comment that spans\n                   multiple lines\n                   "
                        .to_string()
                },
                Comment {
                    position_range: Position::new(15, 13)..Position::new(17, 39),
                    source_range: 339..431,
                    comment_text: "   Another multi-line\n               CSS comment with\n               different formatting   "
                        .to_string()
                },
            ]
        );

        Ok(())
    }
}