blockwatch 0.3.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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

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

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

fn comments_parser() -> anyhow::Result<impl CommentsParser> {
    let tsx_language = tree_sitter_typescript::LANGUAGE_TSX.into();
    let parser = language_parsers::c_style_comments_parser(&tsx_language, "comment");
    Ok(parser)
}

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

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

        let blocks: Vec<Comment> = comments_parser
            .parse(
                r#"
                /**
                 * This is a TSX component with comments.
                 *
                 * @component TSXExample
                 */
                const TSXExample = () => {
                    // This is a single-line comment in TSX.
                    const [count, setCount] = useState(0);

                    /*
                     * This is a multi-line comment
                     * used in a functional component.
                     */
                    const increment = () => {
                        setCount(count + 1); /* Inline multi-line comment */
                    };

                    // Render the component
                    return (
                        <div>
                            {/* JSX single-line comment */}
                            <p>Current count: {count}</p>
                            {/* JSX multi-line 
                            comment */}
                            <button onClick={increment}>Increment</button>
                        </div>
                    );
                };
                "#,
            )
            .collect();

        assert_eq!(
            blocks,
            vec![
                Comment {
                    position_range: Position::new(2, 17)..Position::new(6, 20),
                    source_range: 17..158,
                    comment_text:
                        "   \n                   This is a TSX component with comments.\n                  \n                   @component TSXExample\n                   "
                            .to_string()
                },
                Comment {
                    position_range: Position::new(8, 21)..Position::new(8, 61),
                    source_range: 222..262,
                    comment_text: "   This is a single-line comment in TSX.".to_string()
                },
                Comment {
                    position_range: Position::new(11, 21)..Position::new(14, 24),
                    source_range: 343..476,
                    comment_text:
                        "  \n                       This is a multi-line comment\n                       used in a functional component.\n                       "
                            .to_string()
                },
                Comment {
                    position_range: Position::new(16, 46)..Position::new(16, 77),
                    source_range: 568..599,
                    comment_text: "   Inline multi-line comment   ".to_string()
                },
                Comment {
                    position_range: Position::new(19, 21)..Position::new(19, 44),
                    source_range: 644..667,
                    comment_text: "   Render the component".to_string()
                },
                Comment {
                    position_range: Position::new(22, 30)..Position::new(22, 59),
                    source_range: 756..785,
                    comment_text: "   JSX single-line comment   ".to_string()
                },
                Comment {
                    position_range: Position::new(24, 30)..Position::new(25, 39),
                    source_range: 874..931,
                    comment_text: "   JSX multi-line \n                            comment   ".to_string()
                }
            ]
        );

        Ok(())
    }
}