Skip to content

Commit 83ffdb6

Browse files
committed
ci: switch from markdownlint to rumdl
1 parent 9575d30 commit 83ffdb6

File tree

7 files changed

+101
-60
lines changed

7 files changed

+101
-60
lines changed

.editorconfig

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ indent_size = 3
1010
tab_width = 3
1111
trim_trailing_whitespace = true
1212

13-
[*.{yml,yaml}]
13+
[*.{yml,yaml,scm,cff}]
1414
indent_style = space
1515
indent_size = 2
1616
tab_width = 2
@@ -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
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/markdown-linting.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.

.rsync-exclude

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ Justfile
2525
.harper-dictionary.txt
2626
.typos.toml
2727
.editorconfig
28-
.markdownlint.yaml
28+
.rumdl.toml
29+
.rumdl_cache
2930
jxa-globals.d.ts
3031
jsconfig.json
3132
alfred.d.ts

.rumdl.toml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# DOCS https://github.com/rvben/rumdl/blob/main/docs/global-settings.md
2+
# ------------------------------------------------------------------------------
3+
4+
[global]
5+
line-length = 80
6+
disable = [
7+
"MD032", # blanks-around-lists: space waster
8+
]
9+
10+
# ------------------------------------------------------------------------------
11+
12+
[MD007] # ul-indent
13+
indent = 4 # consistent with .editorconfig
14+
15+
[MD013] # line-length
16+
code-blocks = false
17+
reflow = true # enable auto-formatting
18+
reflow-mode = "default" # default|normalize|sentence-per-line
19+
20+
[MD022] # blanks-around-headings
21+
lines-below = 0 # rule of proximity
22+
23+
[MD029] # ol-prefix
24+
style = "ordered"
25+
26+
[MD033] # inline-html
27+
allowed-elements = ["a", "img", "kbd"] # badges
28+
29+
[MD063] # heading-capitalization
30+
style = "sentence_case"
31+
32+
# ------------------------------------------------------------------------------
33+
34+
[per-file-ignores]
35+
".github/pull_request_template.md" = ["MD041"] # does not need to start with h1

README.md

Lines changed: 38 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<!-- LTeX: enabled=false -->
2+
23
# Alfred GitFred
34
<!-- LTeX: enabled=true -->
45
![GitHub downloads](https://img.shields.io/github/downloads/chrisgrieser/gitfred/total?label=GitHub%20Downloads&style=plastic&logo=github)
@@ -14,39 +15,39 @@ Helpful GitHub assistant for Alfred.
1415
<img alt="Showcase issue search" width=70% src="https://github.com/chrisgrieser/gitfred/assets/73286100/fe15a8a2-e0c4-493f-95ba-f41e3da7e8dc">
1516

1617
## Usage
17-
- Search all public GitHub repositories via the keyword `gh`.
18-
* Uses the [GitHub search query
19-
syntax](https://docs.github.com/en/search-github/searching-on-github/searching-for-repositories),
20-
for example `alfred user:chrisgrieser` to search for repositories with the
21-
name `alfred` by the user `chrisgrieser`.
22-
* <kbd>⏎</kbd>: Open the repo's GitHub page.
23-
* <kbd>⌘⏎</kbd>: Open the repo's homepage. If it has none, opens the
24-
releases page instead.
25-
* <kbd>⌥⏎</kbd>: Copy the repo URL.
26-
* <kbd>⌃⏎</kbd>: Clone the repo to a local folder and open in the Terminal.
27-
- Access your repositories via `gmy`.
28-
* <kbd>⏎</kbd>: If the repo is available locally on your device, open it in
29-
the terminal. Otherwise, open the repo's GitHub page.
30-
* <kbd>⌘⏎</kbd>: Open the repo's GitHub page.
31-
* <kbd>⌥⏎</kbd>: Copy the repo URL.
32-
* <kbd>⇧⏎</kbd>: Clone the repo to a local folder and open in the Terminal.
33-
If the repo is already locally available on your device, just open the
34-
repository in the Terminal.
35-
- Open recent GitHub issues you are involved in with `ghi`.
36-
* <kbd>⏎</kbd>: Open the issue in the browser.
37-
* <kbd>⌥⏎</kbd>: Copy the issue URL.
38-
- Access PRs you have opened with the keyword `gpr`.
39-
* <kbd>⏎</kbd>: Open the PR in the browser.
40-
* <kbd>⌥⏎</kbd>: Copy the link to the PR.
41-
- Directly open your GitHub notification via `ghn`.
42-
* Requires [GitHub Token](https://github.com/settings/tokens).
43-
* <kbd>⏎</kbd>: Open the notification in the browser. In cases where no URL
44-
is available, such as deleted comments or CI activity, opens the GitHub
45-
notification inbox instead.
46-
* <kbd>⌘⏎</kbd>: Mark the notification as read.
47-
* <kbd>⌥⏎</kbd>: Copy the URL of the notification target.
48-
* <kbd>⌃⏎</kbd>: Mark the notification as done.
49-
- Additionally, you can press the
18+
* Search all public GitHub repositories via the keyword `gh`.
19+
* Uses the [GitHub search query
20+
syntax](https://docs.github.com/en/search-github/searching-on-github/searching-for-repositories),
21+
for example `alfred user:chrisgrieser` to search for repositories with the
22+
name `alfred` by the user `chrisgrieser`.
23+
* <kbd>⏎</kbd>: Open the repo's GitHub page.
24+
* <kbd>⌘⏎</kbd>: Open the repo's homepage. If it has none, opens the
25+
releases page instead.
26+
* <kbd>⌥⏎</kbd>: Copy the repo URL.
27+
* <kbd>⌃⏎</kbd>: Clone the repo to a local folder and open in the Terminal.
28+
* Access your repositories via `gmy`.
29+
* <kbd>⏎</kbd>: If the repo is available locally on your device, open it in
30+
the terminal. Otherwise, open the repo's GitHub page.
31+
* <kbd>⌘⏎</kbd>: Open the repo's GitHub page.
32+
* <kbd>⌥⏎</kbd>: Copy the repo URL.
33+
* <kbd>⇧⏎</kbd>: Clone the repo to a local folder and open in the Terminal.
34+
If the repo is already locally available on your device, just open the
35+
repository in the Terminal.
36+
* Open recent GitHub issues you are involved in with `ghi`.
37+
* <kbd>⏎</kbd>: Open the issue in the browser.
38+
* <kbd>⌥⏎</kbd>: Copy the issue URL.
39+
* Access PRs you have opened with the keyword `gpr`.
40+
* <kbd>⏎</kbd>: Open the PR in the browser.
41+
* <kbd>⌥⏎</kbd>: Copy the link to the PR.
42+
* Directly open your GitHub notification via `ghn`.
43+
* Requires [GitHub Token](https://github.com/settings/tokens).
44+
* <kbd>⏎</kbd>: Open the notification in the browser. In cases where no URL
45+
is available, such as deleted comments or CI activity, opens the GitHub
46+
notification inbox instead.
47+
* <kbd>⌘⏎</kbd>: Mark the notification as read.
48+
* <kbd>⌥⏎</kbd>: Copy the URL of the notification target.
49+
* <kbd>⌃⏎</kbd>: Mark the notification as done.
50+
* Additionally, you can press the
5051
[hotkey](https://www.alfredapp.com/help/workflows/triggers/hotkey/) to clone
5152
a GitHub repo from the current browser tab. ([Note that Firefox is not
5253
supported.](https://www.alfredforum.com/topic/16748-how-to-do-x-in-firefox-from-alfred/))
@@ -76,10 +77,10 @@ digital economy. For my PhD project, I investigate the governance of the app
7677
economy and how software ecosystems manage the tension between innovation and
7778
compatibility. If you are interested in this subject, feel free to get in touch.
7879

79-
- [Website](https://chris-grieser.de/)
80-
- [Mastodon](https://pkm.social/@pseudometa)
81-
- [ResearchGate](https://www.researchgate.net/profile/Christopher-Grieser)
82-
- [LinkedIn](https://www.linkedin.com/in/christopher-grieser-ba693b17a/)
80+
* [Website](https://chris-grieser.de/)
81+
* [Mastodon](https://pkm.social/@pseudometa)
82+
* [ResearchGate](https://www.researchgate.net/profile/Christopher-Grieser)
83+
* [LinkedIn](https://www.linkedin.com/in/christopher-grieser-ba693b17a/)
8384

8485
<a href='https://ko-fi.com/Y8Y86SQ91' target='_blank'> <img height='36'
8586
style='border:0px;height:36px;' src='https://cdn.ko-fi.com/cdn/kofi1.png?v=3'

0 commit comments

Comments
 (0)