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

readmeio · Feb 3, 2022 · 59eeab7 · 59eeab7
1 parent bcdf50e
commit 59eeab7
Show file tree

Hide file tree

Showing 4 changed files with 158 additions and 9 deletions.
diff --git a/README.md b/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.

diff --git a/docs.js b/docs.js
@@ -0,0 +1,4 @@
+module.exports = {
+  extends: ['plugin:jsdoc/recommended'],
+  plugins: ['jsdoc'],
+};
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.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",