Skip to content

Commit e34511f

Browse files
committed
ci: switch from markdownlint to rumdl
1 parent 0fec9c5 commit e34511f

File tree

7 files changed

+82
-53
lines changed

7 files changed

+82
-53
lines changed

.editorconfig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,6 @@ indent_size = 4
2121
tab_width = 4
2222

2323
[*.md]
24+
indent_style = space
2425
indent_size = 4
25-
tab_width = 4
2626
trim_trailing_whitespace = false

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
<!-- Explain how this PR resolves the problem. -->
66

77
## AI usage disclosure
8-
<!-- If you used AI beyond simple autocomplete, describe how.
9-
AI-assisted code is not discouraged if it has been properly reviewed;
8+
<!-- If you used AI beyond simple autocomplete, describe how.
9+
AI-assisted code is not discouraged if it has been properly reviewed;
1010
this disclosure is for transparency. -->
1111

1212
## Checklist

.github/workflows/markdownlint.yml

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

.github/workflows/rumdl-lint.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Markdown linting via rumdl
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- "**/*.md"
8+
- ".github/workflows/rumdl-lint.yml"
9+
- ".rumdl.toml"
10+
pull_request:
11+
paths:
12+
- "**/*.md"
13+
14+
jobs:
15+
rumdl:
16+
name: rumdl
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/checkout@v6
20+
- uses: rvben/rumdl@v0
21+
with:
22+
report-type: annotations

.markdownlint.yaml

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

.rumdl.toml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# DOCS https://github.com/rvben/rumdl/blob/main/docs/global-settings.md
2+
3+
[global]
4+
line-length = 80
5+
disable = [
6+
"MD032", # blanks-around-lists: space waster
7+
]
8+
# PENDING https://github.com/rvben/rumdl/issues/208
9+
exclude = [".github/pull_request_template.md"]
10+
11+
# ------------------------------------------------------------------------------
12+
13+
[MD004] # ul-style
14+
style = "dash" # GitHub default & quicker to type
15+
16+
[MD007] # ul-indent
17+
indent = 4 # consistent with .editorconfig
18+
19+
[MD013] # line-length
20+
code-blocks = false
21+
reflow = true # enable auto-formatting
22+
23+
[MD022] # blanks-around-headings
24+
lines-below = 0 # rule of proximity
25+
26+
[MD029] # ol-prefix
27+
style = "ordered"
28+
29+
[MD033] # inline-html
30+
allowed-elements = ["a", "img"] # badges
31+
32+
[MD049] # emphasis-style
33+
style = "asterisk" # better than underscore, since it's not considered a word-char
34+
35+
[MD050] # strong-style
36+
style = "asterisk" # better than underscore, since it's not considered a word-char
37+
38+
[MD063] # heading-capitalization
39+
style = "sentence_case"
40+
41+
# ------------------------------------------------------------------------------
42+
43+
[per-file-ignores]
44+
# does not need to start with h1
45+
".github/pull_request_template.md" = ["MD041"]

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@ insignificant punctuation.
88
<!-- toc -->
99

1010
- [Features](#features)
11-
* [Subword motion](#subword-motion)
12-
* [Skipping insignificant punctuation](#skipping-insignificant-punctuation)
11+
- [Subword motion](#subword-motion)
12+
- [Skipping insignificant punctuation](#skipping-insignificant-punctuation)
1313
- [Installation](#installation)
1414
- [Configuration](#configuration)
15-
* [Basic configuration](#basic-configuration)
16-
* [Advanced: custom movement patterns](#advanced-custom-movement-patterns)
15+
- [Basic configuration](#basic-configuration)
16+
- [Advanced: custom movement patterns](#advanced-custom-movement-patterns)
1717
- [Extras & special cases](#extras--special-cases)
18-
* [UTF-8 support](#utf-8-support)
19-
* [Subword text object](#subword-text-object)
20-
* [Operator-pending mode: the case of `cw`](#operator-pending-mode-the-case-of-cw)
21-
* [Consistent operator-pending mode](#consistent-operator-pending-mode)
22-
* [Motions in insert mode](#motions-in-insert-mode)
23-
* [`precognition.nvim` integration](#precognitionnvim-integration)
18+
- [UTF-8 support](#utf-8-support)
19+
- [Subword text object](#subword-text-object)
20+
- [Operator-pending mode: the case of `cw`](#operator-pending-mode-the-case-of-cw)
21+
- [Consistent operator-pending mode](#consistent-operator-pending-mode)
22+
- [Motions in insert mode](#motions-in-insert-mode)
23+
- [`precognition.nvim` integration](#precognitionnvim-integration)
2424
- [Credits](#credits)
2525

2626
<!-- tocstop -->
@@ -186,6 +186,7 @@ You can do so directly in `packer.nvim` or via dependency on `nvim_rocks` in
186186
`lazy.nvim`.
187187

188188
<!-- markdownlint-disable line-length # build line needs to be that long -->
189+
189190
```lua
190191
-- packer
191192
{ "chrisgrieser/nvim-spider", rocks = "luautf8" }
@@ -201,6 +202,7 @@ You can do so directly in `packer.nvim` or via dependency on `nvim_rocks` in
201202
},
202203
},
203204
```
205+
204206
<!-- markdownlint-enable line-length -->
205207

206208
### Subword text object

0 commit comments

Comments
 (0)