Added updates for HACKING and documentation linting. · WebFreak001/code-debug@cdb9975 · GitHub
Skip to content

Commit cdb9975

Browse files
browntsbrownts
committed
Added updates for HACKING and documentation linting.
1 parent 18847c1 commit cdb9975

14 files changed

Lines changed: 3113 additions & 215 deletions

‎.github/workflows/lint_docs.yml‎

Lines changed: 31 additions & 0 deletions

‎.markdownlint.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
default: true
2+
extends: null
3+
# Don't allow any trailing whitespace.
4+
MD009:
5+
br_spaces: 0
6+
strict: true
7+
# Let Prettier handle line length and wrapping, since the
8+
# results generated by Prettier are not necessarily consistent
9+
# with what Markdownlint is expecting, especially for links.
10+
MD013: false

‎.markdownlintignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Temporarily ignored until they can be updated to abide by the lint rules.
2+
CHANGELOG.md
3+
README.md
4+
5+
# Don't lint markdown belonging to dependency modules.
6+
node_modules

‎.prettierignore‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Temporarily ignored until they can be updated to abide by the style rules.
2+
CHANGELOG.md
3+
README.md
4+
5+
**/.github
6+
**/.vscode-test
7+
node_modules

‎.prettierrc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"proseWrap": "always"
3+
}

‎.vscode/settings.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
// Place your settings in this file to overwrite default and user settings.
22
{
33
"editor.insertSpaces": false,
4+
"[markdown]": {
5+
"editor.defaultFormatter": "esbenp.prettier-vscode",
6+
"editor.formatOnSave": true,
7+
"editor.rulers": [80],
8+
"editor.wordWrap": "bounded",
9+
"editor.wordWrapColumn": 80
10+
},
11+
"files.associations": {
12+
// VSCode defaults these to Markdown instead of ignore files
13+
".markdownlintignore": "ignore",
14+
".prettierignore": "ignore"
15+
},
416
"files.exclude": {
517
"out": false // set this to true to hide the "out" folder with the compiled JS files
618
},

‎.vscode/tasks.json‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,43 @@
6363
"command": "npm",
6464
"group": "test",
6565
"args": ["run", "coverage"]
66+
},
67+
{
68+
"label": "npm:lint-docs",
69+
"detail": "Lint Project Documentation",
70+
"type": "shell",
71+
"command": "npm",
72+
"group": "build",
73+
"args": ["run", "lint-docs"],
74+
"problemMatcher": "$markdownlint"
75+
},
76+
{
77+
"label": "npm:spellcheck-docs",
78+
"detail": "Spellcheck Project Documentation",
79+
"type": "shell",
80+
"command": "npm",
81+
"group": "build",
82+
"args": ["run", "spellcheck-docs"],
83+
"problemMatcher": {
84+
"fileLocation": "absolute",
85+
"owner": "spellcheck-docs",
86+
"pattern": {
87+
"regexp": "^(.+)?:(\\d+):(\\d+) - (.+)$",
88+
"file": 1,
89+
"line": 2,
90+
"column": 3,
91+
"message": 4
92+
},
93+
"severity": "info"
94+
}
95+
},
96+
{
97+
"label": "npm:prettier-write-docs",
98+
"detail": "Reformat Project Documentation",
99+
"type": "shell",
100+
"command": "npm",
101+
"group": "build",
102+
"args": ["run", "prettier-write-docs"]
66103
}
67104
]
68105
}

‎.vscodeignore‎

Lines changed: 12 additions & 1 deletion

0 commit comments

Comments
 (0)