rumdl 0.0.149

A fast Markdown linter written in Rust (Ru(st) MarkDown Linter)
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
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Config",
  "description": "rumdl configuration for linting Markdown files. Rules can be configured individually using [MD###] sections with rule-specific options.",
  "type": "object",
  "properties": {
    "global": {
      "description": "Global configuration options",
      "default": {
        "disable": [],
        "enable": [],
        "exclude": [],
        "fixable": [],
        "flavor": "standard",
        "force_exclude": false,
        "include": [],
        "line_length": 80,
        "respect_gitignore": true,
        "unfixable": []
      },
      "allOf": [
        {
          "$ref": "#/definitions/GlobalConfig"
        }
      ]
    },
    "per-file-ignores": {
      "description": "Per-file rule ignores: maps file patterns to lists of rules to ignore Example: { \"README.md\": [\"MD033\"], \"docs/**/*.md\": [\"MD013\"] }",
      "default": {},
      "type": "object",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    }
  },
  "definitions": {
    "GlobalConfig": {
      "description": "Global configuration options",
      "type": "object",
      "properties": {
        "disable": {
          "description": "Disabled rules",
          "default": [],
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "enable": {
          "description": "Enabled rules",
          "default": [],
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclude": {
          "description": "Files to exclude",
          "default": [],
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "fixable": {
          "description": "Rules that are allowed to be fixed when --fix is used If specified, only these rules will be fixed",
          "default": [],
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "flavor": {
          "description": "Markdown flavor/dialect to use (mkdocs, gfm, commonmark, etc.) When set, adjusts parsing and validation rules for that specific Markdown variant",
          "default": "standard",
          "allOf": [
            {
              "$ref": "#/definitions/MarkdownFlavor"
            }
          ]
        },
        "force_exclude": {
          "description": "Whether to enforce exclude and extend-exclude patterns even for paths that are passed explicitly. By default (false), rumdl will lint any paths passed in directly, even if they would typically be excluded. Setting this to true will cause rumdl to respect exclusions unequivocally. This is useful for pre-commit, which explicitly passes all changed files.",
          "default": false,
          "type": "boolean"
        },
        "include": {
          "description": "Files to include",
          "default": [],
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "line_length": {
          "description": "Global line length setting (used by MD013 and other rules if not overridden)",
          "default": 80,
          "type": "integer",
          "format": "uint64",
          "minimum": 0.0
        },
        "output_format": {
          "description": "Output format for linting results (e.g., \"text\", \"json\", \"pylint\", etc.)",
          "type": [
            "string",
            "null"
          ]
        },
        "respect_gitignore": {
          "description": "Respect .gitignore files when scanning directories",
          "default": true,
          "type": "boolean"
        },
        "unfixable": {
          "description": "Rules that should never be fixed, even when --fix is used Takes precedence over fixable",
          "default": [],
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "MarkdownFlavor": {
      "description": "Markdown flavor/dialect enumeration",
      "oneOf": [
        {
          "description": "Standard Markdown without flavor-specific adjustments",
          "type": "string",
          "enum": [
            "standard"
          ]
        },
        {
          "description": "MkDocs flavor with auto-reference support",
          "type": "string",
          "enum": [
            "mkdocs"
          ]
        }
      ]
    },
    "RuleConfig": {
      "description": "Represents a rule-specific configuration",
      "type": "object",
      "additionalProperties": true
    }
  }
}