Added updates for HACKING and documentation linting.

Author: brownts

.github/workflows/lint_docs.yml

@@ -0,0 +1,31 @@
+name: Lint Project Documentation
+on:
+  push:
+    paths:
+      - '**.md'
+  pull_request:
+    paths:
+      - '**.md'
+jobs:
+  lint_docs:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    - name: Install Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version: 16.x
+
+    - name: Install Module Dependencies
+      run: npm clean-install --no-optional
+
+    - name: Spellcheck Project Documentation
+      run: npm run spellcheck-docs
+
+    - name: Stylecheck Project Documentation
+      run: npm run prettier-check-docs
+
+    - name: Lint Project Documentation
+      run: npm run lint-docs

.markdownlint.yml

@@ -0,0 +1,10 @@
+default: true
+extends: null
+# Don't allow any trailing whitespace.
+MD009:
+  br_spaces: 0
+  strict: true
+# Let Prettier handle line length and wrapping, since the
+# results generated by Prettier are not necessarily consistent
+# with what Markdownlint is expecting, especially for links.
+MD013: false

.markdownlintignore

@@ -0,0 +1,6 @@
+# Temporarily ignored until they can be updated to abide by the lint rules.
+CHANGELOG.md
+README.md
+
+# Don't lint markdown belonging to dependency modules.
+node_modules

.prettierignore

@@ -0,0 +1,7 @@
+# Temporarily ignored until they can be updated to abide by the style rules.
+CHANGELOG.md
+README.md
+
+**/.github
+**/.vscode-test
+node_modules

.prettierrc

@@ -0,0 +1,3 @@
+{
+  "proseWrap": "always"
+}

.vscode/settings.json

@@ -1,6 +1,18 @@
 // Place your settings in this file to overwrite default and user settings.
 {
 	"editor.insertSpaces": false,
+	"[markdown]": {
+		"editor.defaultFormatter": "esbenp.prettier-vscode",
+		"editor.formatOnSave": true,
+		"editor.rulers": [80],
+		"editor.wordWrap": "bounded",
+		"editor.wordWrapColumn": 80
+	},
+	"files.associations": {
+		// VSCode defaults these to Markdown instead of ignore files
+		".markdownlintignore": "ignore",
+		".prettierignore": "ignore"
+	},
 	"files.exclude": {
 		"out": false // set this to true to hide the "out" folder with the compiled JS files
 	},

.vscode/tasks.json

@@ -63,6 +63,43 @@
 			"command": "npm",
 			"group": "test",
 			"args": ["run", "coverage"]
+		},
+		{
+			"label": "npm:lint-docs",
+			"detail": "Lint Project Documentation",
+			"type": "shell",
+			"command": "npm",
+			"group": "build",
+			"args": ["run", "lint-docs"],
+			"problemMatcher": "$markdownlint"
+		},
+		{
+			"label": "npm:spellcheck-docs",
+			"detail": "Spellcheck Project Documentation",
+			"type": "shell",
+			"command": "npm",
+			"group": "build",
+			"args": ["run", "spellcheck-docs"],
+			"problemMatcher": {
+				"fileLocation": "absolute",
+				"owner": "spellcheck-docs",
+				"pattern": {
+					"regexp": "^(.+)?:(\\d+):(\\d+) - (.+)$",
+					"file": 1,
+					"line": 2,
+					"column": 3,
+					"message": 4
+				},
+				"severity": "info"
+			}
+		},
+		{
+			"label": "npm:prettier-write-docs",
+			"detail": "Reformat Project Documentation",
+			"type": "shell",
+			"command": "npm",
+			"group": "build",
+			"args": ["run", "prettier-write-docs"]
 		}
 	]
 }

.vscodeignore

@@ -1,9 +1,20 @@
+# List of paths and files to exclude from the packaged extension.
+.github/**
 .vscode/**
 typings/**
-out/test/**
+out/src/test/**
 test/**
 src/**
 **/*.map
 .gitignore
+.markdownlintignore
+.markdownlint.yml
+.mocharc.yml
+.nycrc.yml
+.prettierignore
+.prettierrc
+cspell.json
+cspell-dict.txt
+HACKING.md
 tsconfig.json
 vsc-extension-quickstart.md