feat: adding linting to jsdocs

jsdoc examples also get linted
Tonejs · Oct 25, 2019 · 10ef513 · 10ef513
1 parent 4ccf4d1
commit 10ef513
Showing 1 changed file with 7 additions and 2 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -1,10 +1,15 @@
 module.exports = {
    "parser": '@typescript-eslint/parser',
     "plugins": [
-        '@typescript-eslint',
-    ],
+		'@typescript-eslint',
+		"jsdoc"
+	],
     "extends": ["plugin:@typescript-eslint/recommended"],
     "rules": {
+		"jsdoc/check-alignment": 1,
+		"jsdoc/check-param-names": [ "error" ],
+		"jsdoc/check-examples": [ "error" ],
+		"jsdoc/check-indentation": ["error", {"excludeTags" : ["example", "param"]}],
 		"dot-location" : [ "error", "property" ],
 		"linebreak-style": [ "error", "unix" ],
 		"eqeqeq" : [ "error" ],