Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
module.exports = {
extends: ['plugin:jsdoc/recommended'],
plugins: ['jsdoc'],
};
160 changes: 151 additions & 9 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down