Add TSDoc linter rules

splitio · Oct 29, 2024 · 2c311b9 · 2c311b9
1 parent dff8b1f
commit 2c311b9
Show file tree

Hide file tree

Showing 3 changed files with 200 additions and 39 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -18,6 +18,7 @@ module.exports = {
   'plugins': [
     'react',
     '@typescript-eslint',
+    'eslint-plugin-tsdoc',
     'import'
   ],
   'rules': {
@@ -63,5 +64,11 @@ module.exports = {
       'import/no-self-import': 'error',
       'import/no-default-export': 'error',
     }
+  }, {
+    // Enable TSDoc rules for TypeScript files, allowing the use of JSDoc in JS files.
+    'files': ['**/*.ts', '**/*.tsx'],
+    'rules': {
+      'tsdoc/syntax': 'warn'
+    }
   }]
 }