ecformat 0.1.1

command line tool to keep files correct in respect of your EditorConfig
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

// SPDX-FileCopyrightText: Contributors to ecformat project <https://codeberg.org/BaumiCoder/ecformat>
//
// SPDX-License-Identifier: BlueOak-1.0.0

use anyhow::Result;
use log::error;
use snafu::ensure;

pub mod cli;

mod editorconfig;

mod files;

#[cfg(test)]
pub(crate) mod test_utils;

use cli::{CommandArgs, LibCommands};

pub use crate::editorconfig::errors;

/// Execute one of the CLI lib commands.
/// (The other CLI commands are not supported by the lib crate.)
/// See also [`check`] and [`fix`].
pub fn execute(cmd: &LibCommands) -> Result<()> {
    match cmd {
        LibCommands::Check(args) => check(args),
        LibCommands::Fix(args) => fix(args),
    }
}

/// Execute the check command.
/// The error in the Result is a [`errors::CheckErrorList`]
/// if the check found violations against your EditorConfig.
/// Use a downcast method to check if it is the case and access the errors list.
pub fn check(args: &CommandArgs) -> Result<()> {
    let mut errors = Vec::new();

    for entry in files::get_target_files(&args.targets()?, &args.ignore_args)? {
        let path = entry?;
        if let Err(e) = editorconfig::check_file(&path, &args.editorconfig_args) {
            let check_error = errors::CheckSnafu {
                path,
                error_type: e.downcast::<editorconfig::errors::CheckErrorType>()?,
            }
            .build();

            error!("{check_error}");
            errors.push(check_error);
        }
    }
    ensure!(
        errors.is_empty(),
        editorconfig::errors::CheckErrorListSnafu { errors }
    );
    Ok(())
}

/// Execute the fix command.
pub fn fix(args: &CommandArgs) -> Result<()> {
    for entry in files::get_target_files(&args.targets()?, &args.ignore_args)? {
        editorconfig::fix_file(&entry?, &args.editorconfig_args)?
    }

    Ok(())
}