ktrs-lint 0.3.0

Port of the ktlint 2.0 rule engine and standard rules over the ktrs mutable AST
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

//! Port of ktlint-ruleset-standard `ValueParameterCommentRule.kt`.

use ktrs_ast::{Ast, NodeId};
use ktrs_syntax::SyntaxKind::VALUE_PARAMETER;

use crate::ast_node_extension::AstNodeExtension;
use crate::element_type::KDOC;
use crate::rule::{About, Emit, RuleId, RuleV2, TokenSet};
use crate::rules::STANDARD_RULE_ABOUT;
use crate::token_sets::COMMENTS;

/// Disallows comments inside a value parameter, except a leading KDoc. One of the rules split from
/// `DiscouragedCommentLocationRule`.
pub struct ValueParameterCommentRule;

impl RuleV2 for ValueParameterCommentRule {
    fn rule_id(&self) -> RuleId {
        RuleId("standard:value-parameter-comment")
    }

    // A part-of-comment node whose parent is a VALUE_PARAMETER is itself a COMMENTS node.
    fn visited_types(&self) -> Option<TokenSet> {
        Some(COMMENTS)
    }

    fn about(&self) -> About {
        STANDARD_RULE_ABOUT
    }

    fn before_visit_child_nodes(&mut self, ast: &mut Ast, node: NodeId, emit: &mut Emit<'_>) {
        let parent = ast.parent(node);
        if parent.map(|it| ast.element_type(it)) == Some(VALUE_PARAMETER) && ast.is_part_of_comment(node) {
            // EOL and block comments before a value parameter are children of the list, so only a KDoc can start one.
            if ast.element_type(node) == KDOC && parent.and_then(|it| ast.first_child_node(it)) == Some(node) {
                return;
            }
            emit(
                ast,
                ast.start_offset(node),
                "A comment inside or on same line after a 'value_parameter' is not allowed. It may be placed on a separate line above.",
                false,
            );
        }
    }
}