yact 2.3.3

Yet Another Commit Transformer: a tool for formatting staged files with minimal disturbance to developer workflow.
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

/*
 * Copyright 2023, 2024, 2025 Nelson Penn
 *
 * This file is part of Yet Another Commit Transformer.
 *
 * Yet Another Commit Transformer is free software: you can redistribute it
 * and/or modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 *
 * Yet Another Commit Transformer is distributed in the hope that it will be
 * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
 * Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * Yet Another Commit Transformer. If not, see <https://www.gnu.org/licenses/>.
 */
use crate::{
    BuiltinTransformer, Error, ShellCommandTransformer, Transformer, builtin_transformers,
    create_shell_transformer,
};
use git2::Repository;
use glob::Pattern;
use semver::VersionReq;
use serde::{Deserialize, Serialize};
use std::path::Path;

#[derive(Debug, Serialize, Deserialize)]
pub enum TransformerOptions {
    Builtin(BuiltinTransformer),
    External(ShellCommandTransformer),
}

impl TransformerOptions {
    pub fn transformer(&self, repository_path: &Path) -> Box<dyn Transformer> {
        match self {
            Self::Builtin(BuiltinTransformer::TrailingWhitespace) => {
                Box::new(builtin_transformers::trailing_whitespace)
            }
            Self::External(command_type) => {
                let command_type = command_type.clone();
                let repository_path = repository_path.to_path_buf();
                Box::new(create_shell_transformer(move |extension: Option<&str>| {
                    command_type.get_command(&repository_path, extension)
                }))
            }
        }
    }
}

#[derive(Debug, Serialize, Deserialize)]
pub struct ConfigurationItem {
    pub glob: String,
    pub transformers: Vec<TransformerOptions>,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct Configuration {
    pub requires_yact_version: Option<VersionReq>,
    pub items: Vec<ConfigurationItem>,
}

pub fn load_configuration(repository: &Repository) -> Result<Configuration, Error> {
    let path = repository.workdir().ok_or(Error::RepositoryIsBare)?;

    let file = std::fs::read(path.join("yactrc.toml")).map_err(|_| Error::ConfigurationNotFound)?;
    let config_str = std::str::from_utf8(&file)?;
    let configuration: Configuration = toml::from_str(config_str)?;
    for item in &configuration.items {
        if Pattern::new(&item.glob).is_err() {
            return Err(Error::InvalidGlob(item.glob.clone()));
        }
    }

    Ok(configuration)
}