markdownlint-rs 0.2.0

A fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files
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

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

#[derive(Debug, Clone, Default, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct Config {
    #[serde(default)]
    pub config: HashMap<String, RuleConfig>,

    #[serde(default)]
    pub custom_rules: Vec<String>,

    #[serde(default)]
    pub fix: bool,

    #[serde(default)]
    pub front_matter: Option<String>,

    #[serde(default = "default_gitignore")]
    pub gitignore: bool,

    #[serde(default)]
    pub globs: Vec<String>,

    #[serde(default)]
    pub ignores: Vec<String>,

    #[serde(default)]
    pub markdown_it_plugins: Vec<String>,

    #[serde(default)]
    pub no_banner: bool,

    #[serde(default)]
    pub no_progress: bool,

    #[serde(default)]
    pub no_inline_config: bool,

    #[serde(default)]
    pub output_formatters: Vec<FormatterConfig>,
}

fn default_gitignore() -> bool {
    true
}

#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(untagged)]
pub enum RuleConfig {
    Enabled(bool),
    Config(HashMap<String, serde_json::Value>),
}

#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct FormatterConfig {
    pub name: String,
    #[serde(default)]
    pub options: HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum OutputFormat {
    Default,
    Json,
    Junit,
    Sarif,
    GitHub,
}