blockwatch 0.2.27

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

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

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

fn comments_parser() -> anyhow::Result<impl CommentsParser> {
    let bash_language = tree_sitter_bash::LANGUAGE.into();
    let parser = TreeSitterCommentsParser::new(
        &bash_language,
        Box::new(|node, source| {
            if node.kind() != "comment" {
                return None;
            }
            let comment = &source[node.byte_range()];
            if comment.starts_with("#!") {
                // Skip shebang.
                None
            } else {
                Some(comment.replacen("#", " ", 1))
            }
        }),
    );
    Ok(parser)
}

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

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

        let blocks: Vec<Comment> = comments_parser
            .parse(
                r#"#!/bin/bash
# This is a single line comment
echo "Hello"  # This is an inline comment

# This is a multi-line
# comment that spans
# several lines

VALUE=42  # Comment after code
"#,
            )
            .collect();

        assert_eq!(
            blocks,
            vec![
                Comment {
                    position_range: Position::new(2, 1)..Position::new(2, 32),
                    source_range: 12..43,
                    comment_text: "  This is a single line comment".to_string()
                },
                Comment {
                    position_range: Position::new(3, 15)..Position::new(3, 42),
                    source_range: 58..85,
                    comment_text: "  This is an inline comment".to_string()
                },
                Comment {
                    position_range: Position::new(5, 1)..Position::new(5, 23),
                    source_range: 87..109,
                    comment_text: "  This is a multi-line".to_string()
                },
                Comment {
                    position_range: Position::new(6, 1)..Position::new(6, 21),
                    source_range: 110..130,
                    comment_text: "  comment that spans".to_string()
                },
                Comment {
                    position_range: Position::new(7, 1)..Position::new(7, 16),
                    source_range: 131..146,
                    comment_text: "  several lines".to_string()
                },
                Comment {
                    position_range: Position::new(9, 11)..Position::new(9, 31),
                    source_range: 158..178,
                    comment_text: "  Comment after code".to_string()
                },
            ]
        );

        Ok(())
    }
}