Add eslint rule for enforcing correct TSDoc syntax

v-jiepeng · Apr 30, 2021 · 5eb6cfd · 5eb6cfd
1 parent cef43d2
commit 5eb6cfd
Show file tree

Hide file tree

Showing 3 changed files with 70 additions and 1 deletion.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -4,11 +4,12 @@ module.exports = {
     env: {
         node: true,
     },
-    plugins: ['@typescript-eslint', 'prettier'],
+    plugins: ['@typescript-eslint', 'prettier', 'eslint-plugin-tsdoc'],
     extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
     rules: {
         '@typescript-eslint/array-type': ['error', { default: 'array-simple' }],
         '@typescript-eslint/member-delimiter-style': 'off',
         'prettier/prettier': 'error',
+        'tsdoc/syntax': 'error',
     },
 }
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -57,6 +57,7 @@
     "eslint-plugin-flowtype": "^4.7.0",
     "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-prettier": "^3.2.0",
+    "eslint-plugin-tsdoc": "^0.2.14",
     "firebase-tools": "^8.17.0",
     "gatsby-theme-docz": "^2.3.1",
     "prettier": "^2.2.1",