feat: markdown linting (#61)

Author: iamturns

.markdownlint.yml

@@ -0,0 +1,8 @@
+default: true
+
+# Disable line length check, as some services use a linebreak-sensitive renderer, e.g. GitHub comment and BitBucket
+line-length: false
+
+no-trailing-punctuation:
+  # Allow headings to end with question mark for FAQ
+  punctuation: ".,;:!"

.vscode/extensions.json

@@ -4,9 +4,10 @@
 
   // List of extensions which should be recommended for users of this workspace.
   "recommendations": [
+    "davidanson.vscode-markdownlint",
+    "dbaeumer.vscode-eslint",
     "editorconfig.editorconfig",
-    "esbenp.prettier-vscode",
-    "dbaeumer.vscode-eslint"
+    "esbenp.prettier-vscode"
   ],
 
   // List of extensions recommended by VS Code that should not be recommended for users of this workspace.

.vscode/settings.json

@@ -5,11 +5,15 @@
     "**/node_modules": true
   },
   "editor.formatOnSave": true,
-  "prettier.eslintIntegration": true,
+  // Show eslint warnings and errors in typescript files
   "eslint.validate": [
     "javascript",
     "javascriptreact",
     "typescript",
     "typescriptreact"
-  ]
+  ],
+  // Prefer `markdownlint`
+  "prettier.disableLanguages": ["markdown"],
+  // Run `eslint --fix` after Prettier, follows `npm run format` flow
+  "prettier.eslintIntegration": true
 }

CODE_OF_CONDUCT.md

@@ -67,10 +67,8 @@ members of the project's leadership.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
-
-[homepage]: https://www.contributor-covenant.org
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
+available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)
 
 For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq
+[https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq).

lint-staged.config.js

@@ -4,7 +4,8 @@ module.exports = {
     "package.json": ["npm run format:package", "git add"],
     ".editorconfig": ["prettier --write", "git add"],
     LICENSE: ["prettier --write", "git add"],
-    "**/*.{css,gql,graphql,html,json,less,md,mdx,scss,vue,yaml,yml}": [
+    "**/*.md": ["markdownlint"],
+    "**/*.{css,gql,graphql,html,json,less,scss,vue,yaml,yml}": [
       "prettier --write",
       "git add",
     ],

package-lock.json

@@ -32,8 +32,10 @@
     "format:eslint": "eslint --cache --ext .js,.jsx,.ts,.tsx --fix ./ >/dev/null 2>&1 || true",
     "format:imports": "import-sort --write '**/*.{js,jsx,ts,tsx}'",
     "format:package": "prettier-package-json --write",
-    "format:prettier": "prettier --write '**/*.{css,gql,graphql,html,js,jsx,json,less,md,mdx,scss,ts,tsx,vue,yaml,yml}' '.editorconfig' 'LICENSE'",
-    "lint": "eslint --cache --ext .js,.jsx,.ts,.tsx --format=pretty ./",
+    "format:prettier": "prettier --write '**/*.{css,gql,graphql,html,js,jsx,json,less,scss,ts,tsx,vue,yaml,yml}' '.editorconfig' 'LICENSE'",
+    "lint": "run-p lint:eslint lint:markdown",
+    "lint:eslint": "eslint --cache --ext .js,.jsx,.ts,.tsx --format=pretty ./",
+    "lint:markdown": "markdownlint '**/*.md' --ignore coverage --ignore dist --ignore node_modules",
     "lint:watch": "onchange 'src/**/*' --initial --kill --delay 1000  -- npm run lint",
     "prepublish": "rimraf dist && npm run build",
     "start": "node dist/create-exposed-app.js",
@@ -91,6 +93,7 @@
     "import-sort-style-module": "5.0.0",
     "jest": "^24.0.0",
     "lint-staged": "^8.1.1",
+    "markdownlint-cli": "^0.14.0",
     "nodemon": "^1.18.9",
     "npm-run-all": "^4.1.5",
     "onchange": "^5.2.0",

package.json

@@ -0,0 +1,8 @@
+default: true
+
+# Disable line length check, as some services use a linebreak-sensitive renderer, e.g. GitHub comment and BitBucket
+line-length: false
+
+no-trailing-punctuation:
+  # Allow headings to end with question mark for FAQ
+  punctuation: ".,;:!"

templates/.markdownlint.yml.template

@@ -4,9 +4,10 @@
 
   // List of extensions which should be recommended for users of this workspace.
   "recommendations": [
+    "davidanson.vscode-markdownlint",
+    "dbaeumer.vscode-eslint",
     "editorconfig.editorconfig",
-    "esbenp.prettier-vscode",
-    "dbaeumer.vscode-eslint"
+    "esbenp.prettier-vscode"
   ],
 
   // List of extensions recommended by VS Code that should not be recommended for users of this workspace.

templates/.vscode/extensions.json.template

@@ -5,11 +5,15 @@
     "**/node_modules": true
   },
   "editor.formatOnSave": true,
-  "prettier.eslintIntegration": true,
+  // Show eslint warnings and errors in typescript files
   "eslint.validate": [
     "javascript",
     "javascriptreact",
     "typescript",
     "typescriptreact"
-  ]
+  ],
+  // Prefer `markdownlint`
+  "prettier.disableLanguages": ["markdown"],
+  // Run `eslint --fix` after Prettier, follows `npm run format` flow
+  "prettier.eslintIntegration": true
 }