Skip to content
Snippets Groups Projects
Commit ae2bd9a5 authored by svornost's avatar svornost
Browse files

Enable (and require) eslint-plugin-jsdoc.

parent b874ee65
No related branches found
No related tags found
No related merge requests found
...@@ -6,6 +6,9 @@ ...@@ -6,6 +6,9 @@
"jquery": true "jquery": true
}, },
"extends": "eslint:recommended", "extends": "eslint:recommended",
"plugins": [
"jsdoc"
],
"globals": { "globals": {
"SugarCube": false, "SugarCube": false,
"Config": false, "Config": false,
...@@ -81,6 +84,33 @@ ...@@ -81,6 +84,33 @@
{ {
"allowSingleLine": true "allowSingleLine": true
} }
] ],
"jsdoc/check-alignment": 1,
"jsdoc/check-examples": 0, // interferes with SugarCube examples
"jsdoc/check-indentation": 0,
"jsdoc/check-param-names": 1,
"jsdoc/check-property-names": 1,
"jsdoc/check-syntax": 1,
"jsdoc/check-tag-names": 1,
"jsdoc/check-types": 1,
"jsdoc/implements-on-classes": 1,
"jsdoc/match-description": 0, // rejects SugarCube syntax
"jsdoc/newline-after-description": 0,
"jsdoc/no-types": 0,
"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-jsdoc": 0,
"jsdoc/require-param": 0,
"jsdoc/require-param-description": 0,
"jsdoc/require-param-name": 1,
"jsdoc/require-param-type": 1,
"jsdoc/require-returns": 0,
"jsdoc/require-returns-check": 1,
"jsdoc/require-returns-description": 0,
"jsdoc/require-returns-type": 1,
"jsdoc/valid-types": 1
} }
} }
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment