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
86
87

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

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

fn comments_parser() -> anyhow::Result<impl CommentsParser> {
    let graphql_language = tree_sitter_graphql::LANGUAGE.into();
    let parser = python_style_comments_parser(&graphql_language, "comment");
    Ok(parser)
}

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

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

        let comments: Vec<Comment> = comments_parser
            .parse(
                r#"
# This is a line comment
type Query {
  # Indented comment
  hello: String # inline comment
}
"#,
            )
            .collect();

        assert_eq!(
            comments,
            vec![
                Comment {
                    position_range: Position::new(2, 1)..Position::new(2, 25),
                    source_range: 1..25,
                    comment_text: "  This is a line comment".to_string()
                },
                Comment {
                    position_range: Position::new(4, 3)..Position::new(4, 21),
                    source_range: 41..59,
                    comment_text: "  Indented comment".to_string()
                },
                Comment {
                    position_range: Position::new(5, 17)..Position::new(5, 33),
                    source_range: 76..92,
                    comment_text: "  inline comment".to_string()
                },
            ]
        );

        Ok(())
    }

    #[test]
    fn real_block_is_parsed_while_string_markers_are_ignored() -> anyhow::Result<()> {
        let contents = r##"# <block name="real">
type Query {
  hello: String
}
# </block>

"""
# <block name="fake_description">
this text lives inside a block string
# </block>
"""
type Other {
  field(message: "# <block name='fake_string'> x # </block>"): String
}
"##;
        let blocks = parser()?
            .parse(contents)
            .collect::<anyhow::Result<Vec<_>>>()?;
        let names: Vec<&str> = blocks
            .iter()
            .map(|block| block.attributes["name"].as_str())
            .collect();
        assert_eq!(names, ["real"]);
        Ok(())
    }
}