Skip to content

Commit

Permalink
Add JSDoc plugin (#286)
Browse files Browse the repository at this point in the history
  • Loading branch information
pvdlg authored and sindresorhus committed Jan 20, 2018
1 parent 0d18368 commit c1f1be6
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
6 changes: 5 additions & 1 deletion config/plugins.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ module.exports = {
'unicorn',
'promise',
'import',
'node'
'node',
'jsdoc'
],
extends: [
'plugin:ava/recommended',
Expand Down Expand Up @@ -80,6 +81,9 @@ module.exports = {
// 'node/shebang': 'error',
'node/no-deprecated-api': 'error',
'node/exports-style': ['error', 'module.exports'],
'jsdoc/newline-after-description': 'warn',
'jsdoc/require-description-complete-sentence': 'warn',
'jsdoc/require-hyphen-before-param-description': 'warn',
// Disabled by default (overrides `plugin:unicorn/recommended`), will be enabled if supported by the Node.js version
'unicorn/prefer-spread': 'off',
'unicorn/no-new-buffer': 'off'
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@
"eslint-formatter-pretty": "^1.0.0",
"eslint-plugin-ava": "^4.2.0",
"eslint-plugin-import": "^2.0.0",
"eslint-plugin-jsdoc": "^3.3.1",
"eslint-plugin-no-use-extend-native": "^0.3.2",
"eslint-plugin-node": "^5.2.1",
"eslint-plugin-prettier": "^2.3.1",
Expand Down

0 comments on commit c1f1be6

Please sign in to comment.