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
46
47
48

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

use ktrs_ast::psi::KtFile;
use ktrs_ast::{Ast, NodeId};
use ktrs_syntax::SyntaxKind::{FILE, IMPORT_LIST, PACKAGE_DIRECTIVE, SCRIPT};

use crate::ast_node_extension::AstNodeExtension;
use crate::rule::{About, Emit, RuleId, RuleV2, TokenSet};
use crate::rules::STANDARD_RULE_ABOUT;
use crate::rules::internal::kotlin_string::{is_blank, substring_after_last};

const VISITED_TYPES: TokenSet = TokenSet::create(&[FILE]);

pub struct NoEmptyFileRule;

impl RuleV2 for NoEmptyFileRule {
    fn rule_id(&self) -> RuleId {
        RuleId("standard:no-empty-file")
    }

    fn visited_types(&self) -> Option<TokenSet> {
        Some(VISITED_TYPES)
    }

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

    fn before_visit_child_nodes(&mut self, ast: &mut Ast, node: NodeId, emit: &mut Emit<'_>) {
        if ast.is_root(node) && is_empty_file(ast, node) {
            emit(ast, 0, &format!("File '{}' should not be empty", get_file_name(ast, node)), false);
        }
    }
}

fn get_file_name(ast: &Ast, node: NodeId) -> String {
    let name = KtFile::of(ast, node).virtual_file_name(ast).replace('\\', "/"); // Ensure compatibility with Windows OS
    substring_after_last(&name, "/").to_owned()
}

fn is_empty_file(ast: &Ast, node: NodeId) -> bool {
    !ast.children(node).any(|it| {
        ast.is_code(it)
            && ast.element_type(it) != PACKAGE_DIRECTIVE
            && ast.element_type(it) != IMPORT_LIST
            && !(ast.element_type(it) == SCRIPT && is_blank(&ast.text(it)))
    })
}