feat: adding a config for enforcing code docs (#311)

Author: erunion

README.md

@@ -34,6 +34,8 @@ Create a `.eslintrc` file with the following contents:
 > **Note:** `@readme/eslint-config/*` subconfigs must be loaded alongside `@readme/eslint-config`, or at least take advantage of a root `.eslintrc` config that has `root` set to `true`.
 
 * `@readme/eslint-config`
+* `@readme/eslint-config/docs`
+  * Will enforce JSDoc blocks throughout a codebase.
 * `@readme/eslint-config/react`
 * `@readme/eslint-config/testing`
   * This config assumes you're using [Jest](https://jestjs.io/), but if you're using [Mocha](https://mochajs.org/) and [Chai](https://www.chaijs.com/) you should use `@readme/eslint-config/testing-mocha` instead.

docs.js

@@ -0,0 +1,4 @@
+module.exports = {
+  extends: ['plugin:jsdoc/recommended'],
+  plugins: ['jsdoc'],
+};

package-lock.json

@@ -31,6 +31,7 @@
     "eslint-plugin-jest": "^26.0.0",
     "eslint-plugin-jest-dom": "^4.0.0",
     "eslint-plugin-jest-formatting": "^3.0.0",
+    "eslint-plugin-jsdoc": "^37.7.1",
     "eslint-plugin-jsx-a11y": "^6.2.3",
     "eslint-plugin-mocha": "^10.0.3",
     "eslint-plugin-node": "^11.1.0",