scraps 1.0.1

Scraps is a portable CLI knowledge hub for managing interconnected Markdown documentation with Wiki-link notation.
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

use scraps_libs::model::{scrap::Scrap, tags::Tags};

use crate::usecase::build::model::backlinks_map::BacklinksMap;

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum LintRuleName {
    DeadEnd,
    Lonely,
    SelfLink,
    Overlinking,
    BrokenLink,
    BrokenHeadingRef,
    StaleByGit,
}

impl LintRuleName {
    pub fn as_str(&self) -> &str {
        match self {
            Self::DeadEnd => "dead-end",
            Self::Lonely => "lonely",
            Self::SelfLink => "self-link",
            Self::Overlinking => "overlinking",
            Self::BrokenLink => "broken-link",
            Self::BrokenHeadingRef => "broken-heading-ref",
            Self::StaleByGit => "stale-by-git",
        }
    }

    /// Rules selected when `scraps lint` is invoked without `--rule` or `--all`.
    /// Excludes opt-in rules with external dependencies (e.g. `_by_git`).
    pub fn default_rules() -> Vec<LintRuleName> {
        vec![
            Self::DeadEnd,
            Self::Lonely,
            Self::SelfLink,
            Self::Overlinking,
            Self::BrokenLink,
            Self::BrokenHeadingRef,
        ]
    }

    /// All rules including opt-in ones. Used by `scraps lint --all`.
    pub fn all_rules() -> Vec<LintRuleName> {
        let mut rules = Self::default_rules();
        rules.push(Self::StaleByGit);
        rules
    }
}

pub struct LintWarning {
    pub rule_name: LintRuleName,
    pub scrap_path: String,
    pub message: String,
    pub source: Option<String>,
    pub span: Option<(usize, usize)>,
}

pub fn scrap_relative_path(scrap: &Scrap) -> String {
    match scrap.ctx() {
        Some(ctx) => format!("{}/{}.md", ctx, scrap.title()),
        None => format!("{}.md", scrap.title()),
    }
}

pub trait LintRule: Send + Sync {
    fn name(&self) -> LintRuleName;
    fn check(
        &self,
        scraps: &[Scrap],
        backlinks_map: &BacklinksMap,
        tags: &Tags,
    ) -> Vec<LintWarning>;
}