Skip to content

Commit

Permalink
[INTERNAL] ESLint: Replace deprecated valid-jsdoc rule with eslint-pl…
Browse files Browse the repository at this point in the history
  • Loading branch information
RandomByte committed Jan 9, 2019
1 parent bd34fc2 commit 492245b
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 47 deletions.
36 changes: 28 additions & 8 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ module.exports = {
"ecmaVersion": 8
},
"extends": ["eslint:recommended", "google"],
"plugins": [
"jsdoc"
],
"rules": {
"indent": [
"error",
Expand Down Expand Up @@ -36,15 +39,32 @@ module.exports = {
"comma-dangle": "off",
"no-tabs": "off",
"no-console": "off", // to allow fallback in case of npmlog error
'valid-jsdoc': [
2,
{
requireParamDescription: false,
requireReturnDescription: false,
requireReturn: false,
prefer: {return: 'returns'},
"valid-jsdoc": 0,
"jsdoc/check-examples": 2,
"jsdoc/check-param-names": 2,
"jsdoc/check-tag-names": 2,
"jsdoc/check-types": 2,
"jsdoc/newline-after-description": 2,
"jsdoc/no-undefined-types": 0,
"jsdoc/require-description": 0,
"jsdoc/require-description-complete-sentence": 0,
"jsdoc/require-example": 0,
"jsdoc/require-hyphen-before-param-description": 0,
"jsdoc/require-param": 2,
"jsdoc/require-param-description": 0,
"jsdoc/require-param-name": 2,
"jsdoc/require-param-type": 2,
"jsdoc/require-returns": 0,
"jsdoc/require-returns-description": 0,
"jsdoc/require-returns-type": 2,
"jsdoc/valid-types": 2
},
"settings": {
"jsdoc": {
"tagNamePreference": {
"return": "returns"
}
],
}
},
"root": true
};
85 changes: 46 additions & 39 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 @@ -100,6 +100,7 @@
"docdash": "^1.0.2",
"eslint": "^5.11.1",
"eslint-config-google": "^0.11.0",
"eslint-plugin-jsdoc": "^3.15.1",
"jsdoc": "^3.5.5",
"nyc": "^13.1.0",
"opn-cli": "^4.0.0",
Expand Down

0 comments on commit 492245b

Please sign in to comment.