checkleft 0.1.0-alpha.8

Experimental repository convention checker; API and behavior may change without notice
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

use std::collections::BTreeMap;
use std::sync::Arc;

use anyhow::{Result, bail};
use async_trait::async_trait;

use crate::input::{ChangeSet, SourceTree};
use crate::output::CheckResult;

#[async_trait]
pub trait ConfiguredCheck: Send + Sync {
    async fn run(&self, changeset: &ChangeSet, tree: &dyn SourceTree) -> Result<CheckResult>;
}

#[async_trait]
pub trait Check: Send + Sync {
    fn id(&self) -> &str;

    fn description(&self) -> &str;

    fn configure(&self, config: &toml::Value) -> Result<Arc<dyn ConfiguredCheck>>;

    async fn run(
        &self,
        changeset: &ChangeSet,
        tree: &dyn SourceTree,
        config: &toml::Value,
    ) -> Result<CheckResult> {
        self.configure(config)?.run(changeset, tree).await
    }
}

#[derive(Default)]
pub struct CheckRegistry {
    checks: BTreeMap<String, Arc<dyn Check>>,
}

impl CheckRegistry {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn register<C>(&mut self, check: C) -> Result<()>
    where
        C: Check + 'static,
    {
        self.register_arc(Arc::new(check))
    }

    pub fn register_arc(&mut self, check: Arc<dyn Check>) -> Result<()> {
        let id = check.id().to_owned();
        if self.checks.contains_key(&id) {
            bail!("check already registered: {id}");
        }
        self.checks.insert(id, check);
        Ok(())
    }

    pub fn get(&self, id: &str) -> Option<Arc<dyn Check>> {
        self.checks.get(id).cloned()
    }

    pub fn list(&self) -> Vec<Arc<dyn Check>> {
        self.checks.values().cloned().collect()
    }
}