commit-lsp 0.2.0

Language Server for commit messages
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

use std::{fs::File, io::Read as _};

use directories::ProjectDirs;
use serde::Deserialize;
use tracing::info;

use crate::{
    git::get_repo_root,
    healthcheck::{HealthReport, ResultExt},
    issue_tracker::IssueTrackerType,
};

#[derive(Deserialize, Debug, Clone, Default)]
pub struct User {
    pub remotes: Vec<Remote>,
}

#[derive(Deserialize, Debug, Clone)]
pub struct Remote {
    pub host: String,
    pub credentials_command: Option<Vec<String>>,

    pub issue_tracker_type: Option<IssueTrackerType>,
    pub issue_tracker_url: Option<String>,
}

#[derive(Deserialize, Debug, Clone, Default)]
pub struct Repository {
    #[serde(default)]
    pub types: Vec<CommitElementDefinition>,
    #[serde(default)]
    pub scopes: Vec<CommitElementDefinition>,

    pub issue_tracker_type: Option<IssueTrackerType>,
    pub issue_tracker_url: Option<String>,
}

#[derive(Deserialize, Debug, Clone, Default)]
pub struct CommitElementDefinition {
    pub name: String,
    pub summary: String,
    pub description: String,
}

impl User {
    pub fn load_default_file(health: &mut HealthReport) -> Self {
        health.set_context("User Configuration");

        let proj_dir = ProjectDirs::from("at", "texel", "commit-lsp").unwrap();
        let dir = proj_dir.config_dir();

        let config_path = dir.join("config.toml");

        let check = health.start(format!("open config file ('{}')", config_path.display()));
        if !config_path.exists() {
            info!("Using default config");
            check.info("File does not exist, using default config.");
            return Default::default();
        }
        let text = (|| {
            let mut config_file = File::open(&config_path)?;

            let mut text = String::new();
            config_file.read_to_string(&mut text)?;

            std::io::Result::Ok(text)
        })()
        .finish_check(check)
        .unwrap();

        info!("Loading config file '{path}'", path = config_path.display());
        toml::from_str(&text)
            .report(health, "parse config")
            .expect("Failed to parse config!")
    }

    /// Finds remote specific configuration for a given url, if it exists.
    ///
    /// Matching happens via a simple substring match of the `host` setting.
    /// The first host that is contained in the url is picked.
    pub fn remote_specific_configuration(&self, url: &str) -> Option<&Remote> {
        self.remotes.iter().find(|r| url.contains(&r.host))
    }
}

impl Repository {
    pub fn load_default_file(health: &mut HealthReport) -> Self {
        health.set_context("Repository Configuration");

        let root_folder = get_repo_root()
            .report(health, "is inside git repository")
            .unwrap();

        let config_path = root_folder.join(".commit-lsp.toml");

        let check = health.start(format!("open config file ('{}')", config_path.display()));
        if !config_path.exists() {
            info!("Using default config");
            check.info("File does not exist, using default config.");
            return Default::default();
        }
        let text = (|| {
            let mut config_file = File::open(&config_path)?;

            let mut text = String::new();
            config_file.read_to_string(&mut text)?;

            std::io::Result::Ok(text)
        })()
        .finish_check(check)
        .unwrap();

        info!("Loading config file '{path}'", path = config_path.display());
        toml::from_str(&text)
            .report(health, "parse config")
            .expect("Failed to parse config!")
    }
}