ktrs-cli 0.5.0

Command-line front ends: `ktrs` and flag-compatible `ktfmt` and `ktlint` (binaries: the root `ktrs` package)
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

//! Which ktlint CLI the drop-in imitates: `--ktlint-version=<1.8|2.0>` (ktrs only, hidden), else
//! `ktrs_ktlint_version` of the `.editorconfig` that applies to the working directory, else 2.0. Chosen once
//! per run and passed to the engine as an `.editorconfig` override, so every file follows it. The engine and
//! rule switches: research/26-ktlint-18-mode.md.

use std::path::Path;

use ktrs_editorconfig::EnumValue;
use ktrs_lint::editorconfig::KtlintVersion;
pub use ktrs_lint::editorconfig::with_ktlint_version;
use ktrs_lint::engine::editor_config_loader::{EditorConfigLoader, EditorConfigLoaderEc4j};
use ktrs_lint::rule_provider::property_types;
use ktrs_lint::rules::standard_rule_providers;
use ktrs_lint::{EditorConfigDefaults, EditorConfigOverride};

use crate::ktlint::command_line::ExitCode;
use crate::ktlint::reporter::KTLINT_VERSION;

pub const KTLINT_VERSION_OPTION: &str = "--ktlint-version";

/// The `--ktlint-version` value among `tokens` (before `--`; the last one wins), else the working
/// directory's `.editorconfig`. `Err` is a Clikt-style usage error message.
pub fn resolve_ktlint_version(tokens: &[String], working_dir: &Path) -> Result<KtlintVersion, String> {
    match option_value(tokens)? {
        Some(value) => KtlintVersion::value_of(value)
            .ok_or_else(|| format!("invalid value for {KTLINT_VERSION_OPTION}: invalid choice: {value}. (choose from 1.8, 2.0)")),
        None => Ok(working_dir_ktlint_version(working_dir)),
    }
}

fn option_value(tokens: &[String]) -> Result<Option<&str>, String> {
    let mut value: Option<&str> = None;
    let mut tokens = tokens.iter().take_while(|t| *t != "--");
    while let Some(token) = tokens.next() {
        if let Some(attached) = token.strip_prefix(KTLINT_VERSION_OPTION).and_then(|rest| rest.strip_prefix('=')) {
            value = Some(attached);
        } else if token == KTLINT_VERSION_OPTION {
            value = Some(tokens.next().ok_or_else(|| format!("option {KTLINT_VERSION_OPTION} requires a value"))?);
        }
    }
    Ok(value)
}

/// Loaded with the engine's property types: the `.editorconfig` cache keeps the first parse of a file. An
/// unreadable `.editorconfig` counts as unset here; the engine reports it on the first file.
fn working_dir_ktlint_version(working_dir: &Path) -> KtlintVersion {
    let property_types = property_types(&standard_rule_providers());
    EditorConfigLoader::new(EditorConfigLoaderEc4j::new(&property_types), EditorConfigDefaults::empty(), EditorConfigOverride::empty())
        .load(Some(&working_dir.join(".kt")))
        .map_or(KtlintVersion::default(), |editor_config| KtlintVersion::of(&editor_config))
}

/// The release `--version` and the SARIF reporter show.
pub fn release(version: KtlintVersion) -> &'static str {
    match version {
        KtlintVersion::V1_8 => "1.8.0",
        KtlintVersion::V2_0 => KTLINT_VERSION,
    }
}

/// The JVM package prefix in logger and exception class names.
pub fn package(version: KtlintVersion) -> &'static str {
    match version {
        KtlintVersion::V1_8 => "com.pinterest.ktlint",
        KtlintVersion::V2_0 => "io.github.ktlint.core",
    }
}

/// The GitHub repository named in messages and git hooks.
pub fn repository(version: KtlintVersion) -> &'static str {
    match version {
        KtlintVersion::V1_8 => "https://github.com/pinterest/ktlint",
        KtlintVersion::V2_0 => "https://github.com/ktlint/ktlint",
    }
}

/// `exitKtLintProcess`: 1.8 exits 1 for every failure but an unparsable format result (123).
pub fn exit_value(version: KtlintVersion, code: ExitCode) -> i32 {
    match (version, code) {
        (KtlintVersion::V1_8, ExitCode::Ok | ExitCode::ParseExceptionAfterFormat) | (KtlintVersion::V2_0, _) => code as i32,
        (KtlintVersion::V1_8, _) => 1,
    }
}