aboutsummaryrefslogtreecommitdiff
path: root/.eslintrc.json
diff options
context:
space:
mode:
authortoasted-nutbread <toasted-nutbread@users.noreply.github.com>2022-05-20 10:28:38 -0400
committerGitHub <noreply@github.com>2022-05-20 10:28:38 -0400
commit31e20c889e467aa4ba64b0b5baf602adc1359371 (patch)
treea033db935a817b2d407ec20843176610a87a6e16 /.eslintrc.json
parentae0ad227c0fd293609a21e5cc1d2a4b85fe7c520 (diff)
ESlint JSdoc (#2148)
* Install eslint-plugin-jsdoc * Initial rules setup * Update lists * Use @returns rather than @return * Remove error throwing code which is never executed * Fix issues relating to @throws * General error fixes * Update Display type documentation * Various doc fixes * Fix invalid tuple syntax * Doc updates * Remove unused * Doc updates * Enable jsdoc/require-returns * Update rules * Update remaining rules
Diffstat (limited to '.eslintrc.json')
-rw-r--r--.eslintrc.json38
1 files changed, 37 insertions, 1 deletions
diff --git a/.eslintrc.json b/.eslintrc.json
index 67faf781..f1489420 100644
--- a/.eslintrc.json
+++ b/.eslintrc.json
@@ -16,7 +16,8 @@
},
"plugins": [
"no-unsanitized",
- "header"
+ "header",
+ "jsdoc"
],
"ignorePatterns": [
"/ext/lib/"
@@ -87,6 +88,41 @@
"no-unsanitized/method": "error",
"no-unsanitized/property": "error",
+ "jsdoc/check-access": "error",
+ "jsdoc/check-alignment": "error",
+ "jsdoc/check-line-alignment": "error",
+ "jsdoc/check-param-names": "error",
+ "jsdoc/check-property-names": "error",
+ "jsdoc/check-tag-names": "error",
+ "jsdoc/check-types": "error",
+ "jsdoc/check-values": "error",
+ "jsdoc/empty-tags": "error",
+ "jsdoc/implements-on-classes": "error",
+ "jsdoc/multiline-blocks": "error",
+ "jsdoc/newline-after-description": ["error", "never"],
+ "jsdoc/no-bad-blocks": "error",
+ "jsdoc/no-multi-asterisks": "error",
+ "jsdoc/require-asterisk-prefix": "error",
+ "jsdoc/require-hyphen-before-param-description": ["error", "never"],
+ "jsdoc/require-jsdoc": "off",
+ "jsdoc/require-param": "error",
+ "jsdoc/require-param-description": "error",
+ "jsdoc/require-param-name": "error",
+ "jsdoc/require-param-type": "error",
+ "jsdoc/require-property": "error",
+ "jsdoc/require-property-description": "error",
+ "jsdoc/require-property-name": "error",
+ "jsdoc/require-property-type": "error",
+ "jsdoc/require-returns": "error",
+ "jsdoc/require-returns-check": "error",
+ "jsdoc/require-returns-description": "error",
+ "jsdoc/require-returns-type": "error",
+ "jsdoc/require-throws": "error",
+ "jsdoc/require-yields": "error",
+ "jsdoc/require-yields-check": "error",
+ "jsdoc/tag-lines": "error",
+ "jsdoc/valid-types": "error",
+
"header/header": ["error", "block", [
"",
{"pattern": " \\* Copyright \\(C\\) (\\d+-)?2022 Yomichan Authors"},