Skip to content

Commit a034a2a

Browse files
graysurfgraysurf
authored
Merge pull request #317 from sympoies/feat/replace-md-lint-with-rumdl
Replace markdown lint with rumdl
2 parents 5f51b27 + 2527f76 commit a034a2a

File tree

5 files changed

+109
-52
lines changed

5 files changed

+109
-52
lines changed

‎.markdownlint-cli2.jsonc‎

Lines changed: 0 additions & 21 deletions
This file was deleted.

‎.rumdl.toml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
[MD013]
2+
line-length = 140
3+
code-blocks = false
4+
headings = false
5+
tables = false
6+
7+
[MD060]
8+
enabled = true

‎THIRD_PARTY_LICENSES.md‎

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
This file documents third-party Rust crate licenses used by this workspace.
44

55
- Data source: `cargo metadata --format-version 1 --locked`
6-
- Cargo.lock SHA256: `20f5398ac0bcc362311fb5065b7c25ec2ef59888be3058f308af8ba2d07b34a3`
7-
- Third-party crates (`source != null`): 439
6+
- Cargo.lock SHA256: `2130cfd4f9882eed5ad4423ebcd30ca1e195985fd5fd55773f8922a46c8998aa`
7+
- Third-party crates (`source != null`): 445
88
- Workspace crates (`source == null`, excluded below): 25
99

1010
## Notes
@@ -17,9 +17,9 @@ This file documents third-party Rust crate licenses used by this workspace.
1717

1818
| License Expression | Crate Count |
1919
| --- | ---: |
20-
| MIT OR Apache-2.0 | 209 |
20+
| MIT OR Apache-2.0 | 214 |
2121
| MIT | 79 |
22-
| Apache-2.0 OR MIT | 34 |
22+
| Apache-2.0 OR MIT | 35 |
2323
| Zlib OR Apache-2.0 OR MIT | 19 |
2424
| Unicode-3.0 | 18 |
2525
| MIT/Apache-2.0 | 17 |
@@ -81,6 +81,7 @@ This file documents third-party Rust crate licenses used by this workspace.
8181
| base64 | 0.22.1 | MIT OR Apache-2.0 | crates.io |
8282
| bitflags | 2.11.0 | MIT OR Apache-2.0 | crates.io |
8383
| block-buffer | 0.10.4 | MIT OR Apache-2.0 | crates.io |
84+
| block-buffer | 0.12.0 | MIT OR Apache-2.0 | crates.io |
8485
| block2 | 0.6.2 | MIT | crates.io |
8586
| blocking | 1.6.2 | Apache-2.0 OR MIT | crates.io |
8687
| bstr | 1.12.1 | MIT OR Apache-2.0 | crates.io |
@@ -105,19 +106,23 @@ This file documents third-party Rust crate licenses used by this workspace.
105106
| combine | 4.6.7 | MIT | crates.io |
106107
| concurrent-queue | 2.5.0 | Apache-2.0 OR MIT | crates.io |
107108
| console | 0.16.3 | MIT | crates.io |
109+
| const-oid | 0.10.2 | Apache-2.0 OR MIT | crates.io |
108110
| core-foundation | 0.10.1 | MIT OR Apache-2.0 | crates.io |
109111
| core-foundation-sys | 0.8.7 | MIT OR Apache-2.0 | crates.io |
110112
| core_maths | 0.1.1 | MIT | crates.io |
111113
| cpufeatures | 0.2.17 | MIT OR Apache-2.0 | crates.io |
114+
| cpufeatures | 0.3.0 | MIT OR Apache-2.0 | crates.io |
112115
| crc32fast | 1.5.0 | MIT OR Apache-2.0 | crates.io |
113116
| crossbeam-utils | 0.8.21 | MIT OR Apache-2.0 | crates.io |
114117
| crypto-common | 0.1.7 | MIT OR Apache-2.0 | crates.io |
118+
| crypto-common | 0.2.1 | MIT OR Apache-2.0 | crates.io |
115119
| ctrlc | 3.5.2 | MIT/Apache-2.0 | crates.io |
116120
| data-encoding | 2.10.0 | MIT | crates.io |
117121
| data-url | 0.3.2 | MIT OR Apache-2.0 | crates.io |
118122
| deranged | 0.5.8 | MIT OR Apache-2.0 | crates.io |
119123
| diff | 0.1.13 | MIT OR Apache-2.0 | crates.io |
120124
| digest | 0.10.7 | MIT OR Apache-2.0 | crates.io |
125+
| digest | 0.11.2 | MIT OR Apache-2.0 | crates.io |
121126
| directories | 6.0.0 | MIT OR Apache-2.0 | crates.io |
122127
| dirs-sys | 0.5.0 | MIT OR Apache-2.0 | crates.io |
123128
| dispatch2 | 0.3.1 | Zlib OR Apache-2.0 OR MIT | crates.io |
@@ -171,6 +176,7 @@ This file documents third-party Rust crate licenses used by this workspace.
171176
| http-body | 1.0.1 | MIT | crates.io |
172177
| http-body-util | 0.1.3 | MIT | crates.io |
173178
| httparse | 1.10.1 | MIT OR Apache-2.0 | crates.io |
179+
| hybrid-array | 0.4.8 | MIT OR Apache-2.0 | crates.io |
174180
| hyper | 1.8.1 | MIT | crates.io |
175181
| hyper-rustls | 0.27.7 | Apache-2.0 OR ISC OR MIT | crates.io |
176182
| hyper-util | 0.1.20 | MIT | crates.io |
@@ -323,10 +329,10 @@ This file documents third-party Rust crate licenses used by this workspace.
323329
| serde_derive | 1.0.228 | MIT OR Apache-2.0 | crates.io |
324330
| serde_json | 1.0.149 | MIT OR Apache-2.0 | crates.io |
325331
| serde_repr | 0.1.20 | MIT OR Apache-2.0 | crates.io |
326-
| serde_spanned | 1.0.4 | MIT OR Apache-2.0 | crates.io |
332+
| serde_spanned | 1.1.0 | MIT OR Apache-2.0 | crates.io |
327333
| serde_urlencoded | 0.7.1 | MIT/Apache-2.0 | crates.io |
328334
| sha1 | 0.10.6 | MIT OR Apache-2.0 | crates.io |
329-
| sha2 | 0.10.9 | MIT OR Apache-2.0 | crates.io |
335+
| sha2 | 0.11.0 | MIT OR Apache-2.0 | crates.io |
330336
| sharded-slab | 0.1.7 | MIT | crates.io |
331337
| shell-words | 1.1.1 | MIT/Apache-2.0 | crates.io |
332338
| shlex | 1.3.0 | MIT OR Apache-2.0 | crates.io |
@@ -363,11 +369,11 @@ This file documents third-party Rust crate licenses used by this workspace.
363369
| tinyvec_macros | 0.1.1 | MIT OR Apache-2.0 OR Zlib | crates.io |
364370
| tokio | 1.50.0 | MIT | crates.io |
365371
| tokio-rustls | 0.26.4 | MIT OR Apache-2.0 | crates.io |
366-
| toml | 1.0.7+spec-1.1.0 | MIT OR Apache-2.0 | crates.io |
367-
| toml_datetime | 1.0.1+spec-1.1.0 | MIT OR Apache-2.0 | crates.io |
372+
| toml | 1.1.0+spec-1.1.0 | MIT OR Apache-2.0 | crates.io |
373+
| toml_datetime | 1.1.0+spec-1.1.0 | MIT OR Apache-2.0 | crates.io |
368374
| toml_edit | 0.25.5+spec-1.1.0 | MIT OR Apache-2.0 | crates.io |
369-
| toml_parser | 1.0.10+spec-1.1.0 | MIT OR Apache-2.0 | crates.io |
370-
| toml_writer | 1.0.7+spec-1.1.0 | MIT OR Apache-2.0 | crates.io |
375+
| toml_parser | 1.1.0+spec-1.1.0 | MIT OR Apache-2.0 | crates.io |
376+
| toml_writer | 1.1.0+spec-1.1.0 | MIT OR Apache-2.0 | crates.io |
371377
| tower | 0.5.3 | MIT | crates.io |
372378
| tower-http | 0.6.8 | MIT | crates.io |
373379
| tower-layer | 0.3.3 | MIT | crates.io |

‎THIRD_PARTY_NOTICES.md‎

Lines changed: 62 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
This file documents third-party notice-file discovery for Rust crates used by this workspace.
44

55
- Data source: `cargo metadata --format-version 1 --locked`
6-
- Cargo.lock SHA256: `20f5398ac0bcc362311fb5065b7c25ec2ef59888be3058f308af8ba2d07b34a3`
7-
- Third-party crates (`source != null`): 439
6+
- Cargo.lock SHA256: `2130cfd4f9882eed5ad4423ebcd30ca1e195985fd5fd55773f8922a46c8998aa`
7+
- Third-party crates (`source != null`): 445
88

99
## Notice Extraction Policy
1010

@@ -259,6 +259,15 @@ This file documents third-party notice-file discovery for Rust crates used by th
259259

260260
### block-buffer 0.10.4
261261

262+
- License: `MIT OR Apache-2.0`
263+
- Source: `crates.io`
264+
- Notice files: No explicit NOTICE file discovered.
265+
- License file references:
266+
- `LICENSE-APACHE`
267+
- `LICENSE-MIT`
268+
269+
### block-buffer 0.12.0
270+
262271
- License: `MIT OR Apache-2.0`
263272
- Source: `crates.io`
264273
- Notice files: No explicit NOTICE file discovered.
@@ -473,6 +482,15 @@ This file documents third-party notice-file discovery for Rust crates used by th
473482
- License file references:
474483
- `LICENSE`
475484

485+
### const-oid 0.10.2
486+
487+
- License: `Apache-2.0 OR MIT`
488+
- Source: `crates.io`
489+
- Notice files: No explicit NOTICE file discovered.
490+
- License file references:
491+
- `LICENSE-APACHE`
492+
- `LICENSE-MIT`
493+
476494
### core-foundation 0.10.1
477495

478496
- License: `MIT OR Apache-2.0`
@@ -501,6 +519,15 @@ This file documents third-party notice-file discovery for Rust crates used by th
501519

502520
### cpufeatures 0.2.17
503521

522+
- License: `MIT OR Apache-2.0`
523+
- Source: `crates.io`
524+
- Notice files: No explicit NOTICE file discovered.
525+
- License file references:
526+
- `LICENSE-APACHE`
527+
- `LICENSE-MIT`
528+
529+
### cpufeatures 0.3.0
530+
504531
- License: `MIT OR Apache-2.0`
505532
- Source: `crates.io`
506533
- Notice files: No explicit NOTICE file discovered.
@@ -528,6 +555,15 @@ This file documents third-party notice-file discovery for Rust crates used by th
528555

529556
### crypto-common 0.1.7
530557

558+
- License: `MIT OR Apache-2.0`
559+
- Source: `crates.io`
560+
- Notice files: No explicit NOTICE file discovered.
561+
- License file references:
562+
- `LICENSE-APACHE`
563+
- `LICENSE-MIT`
564+
565+
### crypto-common 0.2.1
566+
531567
- License: `MIT OR Apache-2.0`
532568
- Source: `crates.io`
533569
- Notice files: No explicit NOTICE file discovered.
@@ -581,6 +617,15 @@ This file documents third-party notice-file discovery for Rust crates used by th
581617

582618
### digest 0.10.7
583619

620+
- License: `MIT OR Apache-2.0`
621+
- Source: `crates.io`
622+
- Notice files: No explicit NOTICE file discovered.
623+
- License file references:
624+
- `LICENSE-APACHE`
625+
- `LICENSE-MIT`
626+
627+
### digest 0.11.2
628+
584629
- License: `MIT OR Apache-2.0`
585630
- Source: `crates.io`
586631
- Notice files: No explicit NOTICE file discovered.
@@ -1044,6 +1089,15 @@ This file documents third-party notice-file discovery for Rust crates used by th
10441089

10451090
### httparse 1.10.1
10461091

1092+
- License: `MIT OR Apache-2.0`
1093+
- Source: `crates.io`
1094+
- Notice files: No explicit NOTICE file discovered.
1095+
- License file references:
1096+
- `LICENSE-APACHE`
1097+
- `LICENSE-MIT`
1098+
1099+
### hybrid-array 0.4.8
1100+
10471101
- License: `MIT OR Apache-2.0`
10481102
- Source: `crates.io`
10491103
- Notice files: No explicit NOTICE file discovered.
@@ -2355,7 +2409,7 @@ This file documents third-party notice-file discovery for Rust crates used by th
23552409
- `LICENSE-APACHE`
23562410
- `LICENSE-MIT`
23572411

2358-
### serde_spanned 1.0.4
2412+
### serde_spanned 1.1.0
23592413

23602414
- License: `MIT OR Apache-2.0`
23612415
- Source: `crates.io`
@@ -2382,7 +2436,7 @@ This file documents third-party notice-file discovery for Rust crates used by th
23822436
- `LICENSE-APACHE`
23832437
- `LICENSE-MIT`
23842438

2385-
### sha2 0.10.9
2439+
### sha2 0.11.0
23862440

23872441
- License: `MIT OR Apache-2.0`
23882442
- Source: `crates.io`
@@ -2702,7 +2756,7 @@ This file documents third-party notice-file discovery for Rust crates used by th
27022756
- `LICENSE-APACHE`
27032757
- `LICENSE-MIT`
27042758

2705-
### toml 1.0.7+spec-1.1.0
2759+
### toml 1.1.0+spec-1.1.0
27062760

27072761
- License: `MIT OR Apache-2.0`
27082762
- Source: `crates.io`
@@ -2711,7 +2765,7 @@ This file documents third-party notice-file discovery for Rust crates used by th
27112765
- `LICENSE-APACHE`
27122766
- `LICENSE-MIT`
27132767

2714-
### toml_datetime 1.0.1+spec-1.1.0
2768+
### toml_datetime 1.1.0+spec-1.1.0
27152769

27162770
- License: `MIT OR Apache-2.0`
27172771
- Source: `crates.io`
@@ -2729,7 +2783,7 @@ This file documents third-party notice-file discovery for Rust crates used by th
27292783
- `LICENSE-APACHE`
27302784
- `LICENSE-MIT`
27312785

2732-
### toml_parser 1.0.10+spec-1.1.0
2786+
### toml_parser 1.1.0+spec-1.1.0
27332787

27342788
- License: `MIT OR Apache-2.0`
27352789
- Source: `crates.io`
@@ -2738,7 +2792,7 @@ This file documents third-party notice-file discovery for Rust crates used by th
27382792
- `LICENSE-APACHE`
27392793
- `LICENSE-MIT`
27402794

2741-
### toml_writer 1.0.7+spec-1.1.0
2795+
### toml_writer 1.1.0+spec-1.1.0
27422796

27432797
- License: `MIT OR Apache-2.0`
27442798
- Source: `crates.io`

‎scripts/ci/markdownlint-audit.sh‎

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ usage() {
66
Usage:
77
markdownlint-audit.sh [--strict]
88
9-
Run workspace Markdown lint checks using markdownlint-cli2 and the repo baseline config.
9+
Run workspace Markdown lint checks using rumdl and the repo baseline config.
1010
1111
Options:
1212
--strict Treat lint failures as hard failures (exit 1)
@@ -46,24 +46,34 @@ if ! command -v npx >/dev/null 2>&1; then
4646
exit 2
4747
fi
4848

49-
config_file="$repo_root/.markdownlint-cli2.jsonc"
49+
config_file="$repo_root/.rumdl.toml"
5050
if [[ ! -f "$config_file" ]]; then
51-
echo "error: missing markdownlint config: $config_file" >&2
51+
echo "error: missing rumdl config: $config_file" >&2
52+
exit 2
53+
fi
54+
55+
declare -a md_files=()
56+
while IFS= read -r -d '' path; do
57+
if [[ "$path" == "README.md" || "$path" == "DEVELOPMENT.md" || "$path" == "AGENTS.md" ]]; then
58+
md_files+=("$path")
59+
continue
60+
fi
61+
62+
if [[ "$path" =~ ^docs/.+\.md$ || "$path" =~ ^crates/[^/]+/README\.md$ || "$path" =~ ^crates/[^/]+/docs/.+\.md$ ]]; then
63+
md_files+=("$path")
64+
fi
65+
done < <(git ls-files -z -- README.md DEVELOPMENT.md AGENTS.md docs crates)
66+
67+
if [[ "${#md_files[@]}" -eq 0 ]]; then
68+
echo "error: no Markdown files matched audit scope" >&2
5269
exit 2
5370
fi
5471

5572
lint_cmd=(
56-
npx --yes
57-
--package markdownlint-cli2@0.21.0
58-
--package katex@0.16.21
59-
markdownlint-cli2
73+
npx --yes rumdl@0.1.62
74+
check
6075
--config "$config_file"
61-
"README.md"
62-
"DEVELOPMENT.md"
63-
"AGENTS.md"
64-
"docs/**/*.md"
65-
"crates/*/README.md"
66-
"crates/*/docs/**/*.md"
76+
"${md_files[@]}"
6777
)
6878

6979
echo "+ ${lint_cmd[*]}"

0 commit comments

Comments
 (0)
⚡