Skip to content

Commit 6ce6e76

Browse files
committed
switch to rumdl for markdown lint and format
1 parent 2c954c9 commit 6ce6e76

File tree

2 files changed

+34
-21
lines changed

2 files changed

+34
-21
lines changed

dev/treefmt.nix

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,6 @@ in
2323
terraform.enable = true;
2424
};
2525

26-
programs.mdformat = {
27-
enable = true;
28-
excludes = [ "docs/*.md" ];
29-
settings = {
30-
number = true;
31-
wrap = "no";
32-
};
33-
};
34-
3526
programs.yamlfmt = {
3627
enable = true;
3728
settings.formatter.retain_line_breaks_single = true;
@@ -50,20 +41,15 @@ in
5041

5142
dnscontrol.includes = [ "*dnsconfig.js" ];
5243

53-
mdformat-mkdocs = {
54-
command = pkgs.mdformat.withPlugins (p: [
55-
p.mdformat-frontmatter
56-
p.mdformat-mkdocs
57-
p.mdformat-simple-breaks
58-
]);
44+
rumdl = {
45+
command = pkgs.rumdl;
5946
options = [
60-
"--number"
61-
"--wrap"
62-
"no"
63-
];
64-
includes = [
65-
"docs/*.md"
47+
"check"
48+
"--fix"
49+
"--fail-on"
50+
"warning"
6651
];
52+
includes = [ "*.md" ];
6753
};
6854

6955
shellcheck.priority = 1;

pyproject.toml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,30 @@ ignore = [
3232
"S101",
3333
"SIM117",
3434
]
35+
36+
[tool.rumdl]
37+
disable = ["MD014", "MD041"]
38+
flavor = "gfm"
39+
40+
[tool.rumdl.MD013]
41+
line-length = 0
42+
reflow = true
43+
reflow-mode = "sentence-per-line"
44+
45+
[tool.rumdl.MD029]
46+
style = "ordered"
47+
48+
[tool.rumdl.MD057]
49+
absolute-links = "relative_to_docs"
50+
compact-paths = true
51+
52+
[tool.rumdl.MD074]
53+
absolute-links = "warn"
54+
not-found = "warn"
55+
omitted-files = "warn"
56+
57+
[tool.rumdl.per-file-flavor]
58+
"docs/**/*.md" = "mkdocs"
59+
60+
[tool.rumdl.per-file-ignores]
61+
"docs/**/*.md" = ["MD033", "MD059"]

0 commit comments

Comments
 (0)