wdl-lint 0.26.0

Lint rules for Workflow Description Language (WDL) documents
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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

//! A lint rule that ensures structs are defined with pascal case names.

use convert_case::Boundary;
use convert_case::Case;
use convert_case::Converter;
use wdl_analysis::Diagnostics;
use wdl_analysis::Example;
use wdl_analysis::LabeledSnippet;
use wdl_analysis::VisitReason;
use wdl_analysis::Visitor;
use wdl_ast::AstNode;
use wdl_ast::AstToken;
use wdl_ast::Diagnostic;
use wdl_ast::Span;
use wdl_ast::SyntaxKind;
use wdl_ast::SyntaxNode;
use wdl_ast::v1::StructDefinition;

use crate::Rule;
use crate::Tag;
use crate::TagSet;

/// The identifier for the pascal case rule.
const ID: &str = "PascalCase";

/// Creates a "use pascal case" diagnostic.
fn use_pascal_case(name: &str, properly_cased_name: &str, span: Span) -> Diagnostic {
    Diagnostic::warning(format!("struct name `{name}` is not PascalCase"))
        .with_rule(ID)
        .with_label("this name must be PascalCase", span)
        .with_fix(format!("replace `{name}` with `{properly_cased_name}`"))
}

/// Detects structs defined without a pascal case name.
#[derive(Default, Debug, Clone, Copy)]
pub struct PascalCaseRule;

impl Rule for PascalCaseRule {
    fn id(&self) -> &'static str {
        ID
    }

    fn description(&self) -> &'static str {
        "Ensures that structs are defined with PascalCase names."
    }

    fn explanation(&self) -> &'static str {
        "Struct names should be in PascalCase. Maintaining a consistent naming convention makes \
         the code easier to read and understand."
    }

    fn examples(&self) -> &'static [Example] {
        &[Example {
            negative: LabeledSnippet {
                label: Some("Struct names should be in PascalCase"),
                snippet: r#"version 1.2

struct registered_user {
    String name
}
"#,
            },
            revised: Some(LabeledSnippet {
                label: None,
                snippet: r#"version 1.2

struct RegisteredUser {
    String name
}
"#,
            }),
        }]
    }

    fn tags(&self) -> TagSet {
        TagSet::new(&[Tag::Naming, Tag::Style, Tag::Clarity])
    }

    fn exceptable_nodes(&self) -> Option<&'static [SyntaxKind]> {
        Some(&[
            SyntaxKind::VersionStatementNode,
            SyntaxKind::StructDefinitionNode,
        ])
    }

    fn related_rules(&self) -> &'static [&'static str] {
        &["SnakeCase"]
    }
}

/// Checks if the given name is pascal case, and if not adds a warning to the
/// diagnostics.
fn check_name(
    name: &str,
    span: Span,
    diagnostics: &mut Diagnostics,
    node: &SyntaxNode,
    exceptable_nodes: &Option<&'static [SyntaxKind]>,
) {
    let converter = Converter::new()
        .remove_boundaries(&[Boundary::DigitLower, Boundary::LowerDigit])
        .to_case(Case::Pascal);
    let properly_cased_name = converter.convert(name);
    if name != properly_cased_name {
        diagnostics.exceptable_add(
            use_pascal_case(name, &properly_cased_name, span),
            node,
            exceptable_nodes,
        );
    }
}

impl Visitor for PascalCaseRule {
    fn reset(&mut self) {
        *self = Self;
    }

    fn struct_definition(
        &mut self,
        diagnostics: &mut Diagnostics,
        reason: VisitReason,
        def: &StructDefinition,
    ) {
        if reason == VisitReason::Exit {
            return;
        }

        let name = def.name();
        check_name(
            name.text(),
            name.span(),
            diagnostics,
            def.inner(),
            &self.exceptable_nodes(),
        );
    }
}