blockwatch 0.4.0

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

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

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

fn comments_parser() -> anyhow::Result<impl CommentsParser> {
    let scala_language = tree_sitter_scala::LANGUAGE.into();
    let parser = language_parsers::c_style_line_and_block_comments_parser(
        &scala_language,
        "comment",
        "block_comment",
    );
    Ok(parser)
}

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

    #[test]
    fn block_marker_inside_nested_comment_is_read_once() -> anyhow::Result<()> {
        // A marker in a nested Scala block comment must be read once, not once per nesting level.
        let contents = r#"/* wrapper
   /* <block name="only_once"> */
*/
val value = 1
// </block>
"#;
        let blocks = parser()?
            .parse(contents)
            .collect::<anyhow::Result<Vec<_>>>()?;
        assert_eq!(blocks.len(), 1);
        assert_eq!(blocks[0].attributes["name"], "only_once");
        Ok(())
    }

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

        let comments: Vec<Comment> = comments_parser
            .parse(
                r#"
// This is a single line comment
object Main {
  val x = 42 // inline comment

  /* This is a block comment
  spanning multiple lines
  */
}
/// Triple slash comment.
"#,
            )
            .collect();

        assert_eq!(
            comments,
            vec![
                Comment {
                    position_range: Position::new(2, 1)..Position::new(2, 33),
                    source_range: 1..33,
                    comment_text: "   This is a single line comment".to_string()
                },
                Comment {
                    position_range: Position::new(4, 14)..Position::new(4, 31),
                    source_range: 61..78,
                    comment_text: "   inline comment".to_string()
                },
                Comment {
                    position_range: Position::new(6, 3)..Position::new(8, 5),
                    source_range: 82..139,
                    comment_text: "   This is a block comment\n  spanning multiple lines\n    "
                        .to_string()
                },
                Comment {
                    position_range: Position::new(10, 1)..Position::new(10, 26),
                    source_range: 142..167,
                    comment_text: "  / Triple slash comment.".to_string()
                },
            ]
        );

        Ok(())
    }
}