Skip to content

Commit bcbaf93

Browse files
committed
💚 add markdownlint
1 parent 7a03ba6 commit bcbaf93

File tree

4 files changed

+28
-4
lines changed

4 files changed

+28
-4
lines changed

‎.github/workflows/check.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,6 @@ jobs:
1414
with:
1515
node-version: lts/*
1616
- run: npm run lint
17+
- run: npm run mdlint
1718
- run: npm run test
1819
- run: npm run check

‎.markdownlint.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# for reference, see https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
2+
3+
# Default state for all rules
4+
default: true
5+
6+
# MD013/line-length - Line length
7+
MD013: false
8+
9+
# MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content
10+
MD024:
11+
# Only check sibling headings
12+
siblings_only: true
13+
14+
# MD033/no-inline-html: Inline HTML
15+
MD033: false
16+
17+
# MD034/no-bare-urls - Bare URL
18+
MD034: false

‎CODE_OF_CONDUCT.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1-
This repository is a TC39 project and subscribes to its [code of conduct](https://tc39.es/code-of-conduct/). It is available at [https://tc39.es/code-of-conduct/](https://tc39.es/code-of-conduct/).
21

3-
To ask a question or report an issue, please email [[email protected]](mailto:[email protected]).
2+
This repository is a TC39 project and subscribes to its [code of conduct](https://tc39.es/code-of-conduct/). It is available at [https://tc39.es/code-of-conduct/](https://tc39.es/code-of-conduct/). <!-- markdownlint-disable-line MD041 -->
3+
4+
To ask a question or report an issue, please email [[email protected]](mailto:[email protected]).

‎package.json

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,13 @@
44
"check": "node -e 'import(\"./scripts/check-delegates.mjs\").then(cd => cd.checkDelegates())'",
55
"test": "node ./scripts/check-delegates-test.mjs",
66
"lint": "eslint . --ext .js,.mjs,.cjs",
7-
"lint:fix": "npm run lint -- --fix"
7+
"lint:fix": "npm run lint -- --fix",
8+
"//": "markdownlint commands ignore old files",
9+
"mdlint": "markdownlint-cli2 '**/*.md' '!node_modules' '!meetings/201*/*.md' '!meetings/202[0-2]*/*.md' '!meetings/2023-0[1-3]/*.md'",
10+
"mdlint:fix": "markdownlint-cli2-fix '**/*.md' '!node_modules' '!meetings/201*/*.md' '!meetings/202[0-2]*/*.md' '!meetings/2023-0[1-3]/*.md'"
811
},
912
"devDependencies": {
10-
"eslint": "^8.41.0"
13+
"eslint": "^8.41.0",
14+
"markdownlint-cli2": "^0.7.1"
1115
}
1216
}

0 commit comments

Comments
 (0)