Add markdown linting rules

Author: gabmontes

README.md

@@ -20,13 +20,21 @@ Add this to the ESLint configuration file:
 }
 ```
 
-Additional rule sets are available: `bloq/node`, `bloq/next` and `bloq/mocha`.
+Additional rule sets are available:
 
-## Note on code formatting
+- `bloq/jsdoc`
+- `bloq/markdown`
+- `bloq/mocha`
+- `bloq/next`
+- `bloq/node`
 
-This package is focused on identifying code patterns that are or lead to common errors.
-It is not intended to deal with code formatting and coding styles (even when a few rules may still be enabled).
+## Note on code formatting
 
-## License
+The base rules are focused in identifying code patterns that are or could lead to common errors.
+Enforcing code styles should be mainly done with tools like [Prettier](https://prettier.io), adding it to the end of any `extends` array to ensure the conflicting rules are deactivated:
 
-MIT
+```json
+{
+  "extends": ["bloq", "bloq/node", "prettier"]
+}
+```

markdown.js

@@ -0,0 +1,10 @@
+'use strict'
+
+module.exports = {
+  extends: ['plugin:markdownlint/recommended'],
+  parser: 'eslint-plugin-markdownlint/parser',
+  rules: {
+    'markdownlint/md013': 'off',
+    'markdownlint/md034': 'warn'
+  }
+}

package-lock.json

@@ -8,9 +8,10 @@
     "eslint",
     "eslintconfig",
     "lint",
+    "markdown",
     "mocha",
-    "next.js",
     "next",
+    "next.js",
     "node"
   ],
   "license": "MIT",
@@ -30,6 +31,7 @@
     "eslint-config-prettier": "^8.0.0",
     "eslint-plugin-import": "^2.0.0",
     "eslint-plugin-jsdoc": "^43.0.0",
+    "eslint-plugin-markdownlint": "^0.6.0",
     "eslint-plugin-mocha": "^10.0.0",
     "eslint-plugin-node": "^11.0.0",
     "eslint-plugin-prefer-arrow": "^1.0.0",
@@ -41,12 +43,22 @@
     "lint-staged": "^13.0.0",
     "prettier": "^2.0.0"
   },
-  "preferGlobal": false,
+  "peerDependencies": {
+    "eslint": "^8.0.0"
+  },
   "private": false,
   "eslintConfig": {
     "extends": [
       "./index.js",
       "./node.js"
+    ],
+    "overrides": [
+      {
+        "files": "*.md",
+        "extends": [
+          "./markdown.js"
+        ]
+      }
     ]
   },
   "husky": {
@@ -55,14 +67,19 @@
     }
   },
   "lint-staged": {
-    "*.js": "eslint --cache --fix",
-    "*.{css,js,json,md}": "prettier --write"
+    "!*.{js,md}": [
+      "prettier --ignore-unknown --write"
+    ],
+    "*.{js,md}": [
+      "eslint --cache --fix",
+      "prettier --write"
+    ]
   },
+  "preferGlobal": false,
   "prettier": {
     "quoteProps": "consistent",
     "semi": false,
     "singleQuote": true,
-    "tabWidth": 2,
     "trailingComma": "none"
   }
 }