ktrs-lint 0.5.1

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
49
50
51

//! Ports of ktlint-rule-engine `internal/VisitorProvider.kt` and `internal/RuleProviderSorter.kt`.

use crate::editorconfig::KtlintVersion;
use crate::engine::rule_provider_sorter_1_8::get_sorted_rule_providers_1_8;
use crate::rule::{RuleSetId, RuleV2};
use crate::rule_provider::RuleV2Provider;

/// `RuleProviderSorter.getSortedRuleProviders`: the standard rule set first, then by rule id.
pub fn get_sorted_rule_providers(rule_providers: &[RuleV2Provider]) -> Vec<RuleV2Provider> {
    let mut sorted = rule_providers.to_vec();
    sorted.sort_by_key(|p| {
        (
            p.rule_id().rule_set_id() != RuleSetId::STANDARD,
            p.rule_id().value(),
        )
    });
    sorted
}

/// `VisitorProvider(ruleProviders).rules`: fresh instances in execution order.
pub struct VisitorProvider {
    rule_providers_sorted: Vec<RuleV2Provider>,
}

impl VisitorProvider {
    pub fn new(rule_providers: &[RuleV2Provider]) -> VisitorProvider {
        VisitorProvider::for_version(rule_providers, KtlintVersion::V2_0)
    }

    /// With that release's sorter (1.8 honours the rules' `VisitorModifier`s).
    pub fn for_version(rule_providers: &[RuleV2Provider], ktlint_version: KtlintVersion) -> VisitorProvider {
        VisitorProvider {
            rule_providers_sorted: if ktlint_version.is_1_8() {
                get_sorted_rule_providers_1_8(rule_providers)
            } else {
                get_sorted_rule_providers(rule_providers)
            },
        }
    }

    pub fn rules(&self) -> Vec<Box<dyn RuleV2>> {
        self.rule_providers_sorted
            .iter()
            .map(RuleV2Provider::create_new_rule_instance)
            .collect()
    }

    pub fn rule_ids(&self) -> impl Iterator<Item = &'static str> + '_ {
        self.rule_providers_sorted.iter().map(|p| p.rule_id().value())
    }
}