Skip to content

Commit

Permalink
feat: Add bunch of JSDoc rules
Browse files Browse the repository at this point in the history
BREAKING CHANGES: Added new JSDoc rules which might show up an error in places that where no problem before.
  • Loading branch information
jhnns committed Feb 1, 2020
1 parent a123f41 commit 680550e
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
18 changes: 18 additions & 0 deletions base.js
Original file line number Diff line number Diff line change
Expand Up @@ -224,22 +224,40 @@ module.exports = {
], // http://eslint.org/docs/rules/indent
"init-declarations": "off", // http://eslint.org/docs/rules/init-declarations
// https://github.com/gajus/eslint-plugin-jsdoc/blob/master/README.md
"jsdoc/check-access": "error",
"jsdoc/check-alignment": "error",
"jsdoc/check-examples": "error",
"jsdoc/check-indentation": "error",
"jsdoc/check-param-names": "error",
"jsdoc/check-property-names": "error",
"jsdoc/check-syntax": "off",
"jsdoc/check-tag-names": ["error", {
"definedTags": ["swagger"]
}],
"jsdoc/check-types": "error",
"jsdoc/check-values": "off",
"jsdoc/empty-tags": "error",
"jsdoc/implements-on-classes": "off",
"jsdoc/match-description": "off",
"jsdoc/newline-after-description": "error",
"jsdoc/no-bad-blocks": "error",
"jsdoc/no-defaults": "error",
"jsdoc/no-types": "off",
"jsdoc/no-undefined-types": "error",
"jsdoc/require-description": "off",
"jsdoc/require-description-complete-sentence": "off",
"jsdoc/require-example": "off",
"jsdoc/require-file-overview": "off",
"jsdoc/require-hyphen-before-param-description": "error",
"jsdoc/require-jsdoc": "off",
"jsdoc/require-param": "error",
"jsdoc/require-param-description": "off",
"jsdoc/require-param-name": "off",
"jsdoc/require-param-type": "error",
"jsdoc/require-property": "off",
"jsdoc/require-property-description": "off",
"jsdoc/require-property-name": "error",
"jsdoc/require-property-type": "error",
"jsdoc/require-returns": "error",
"jsdoc/require-returns-check": "error",
"jsdoc/require-returns-description": "off",
Expand Down
1 change: 1 addition & 0 deletions typescript.js
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,7 @@ module.exports = {
"import/namespace": "off", // TypeScript should catch it anyway
"import/no-unresolved": "off", // TypeScript should catch it anyway
"indent": "off",
"jsdoc/no-types": "error", // JSDoc types are not necessary when using TypeScript
// TypeScript files tend to get longer due to types
"max-lines": [
"warn",
Expand Down

0 comments on commit 680550e

Please sign in to comment.