Add TSDoc linter rules

splitio · Oct 29, 2024 · 912f20e · 912f20e
1 parent 4d2a5a4
commit 912f20e
Show file tree

Hide file tree

Showing 80 changed files with 866 additions and 918 deletions.
diff --git a/.eslintrc b/.eslintrc
@@ -5,6 +5,7 @@
   "parser": "@typescript-eslint/parser",
   "plugins": [
     "@typescript-eslint",
+    "eslint-plugin-tsdoc",
     "import"
   ],
 
@@ -90,6 +91,19 @@
         "sourceType": "module"
       }
     },
+    {
+      "files": ["types/**"],
+      "rules": {
+        "no-use-before-define": "off"
+      }
+    },
+    {
+      // Enable TSDoc rules for TypeScript files, allowing the use of JSDoc in JS files.
+      "files": ["**/*.ts"],
+      "rules": {
+        "tsdoc/syntax": "warn"
+      }
+    },
     // @TODO remove when moving InLocalStorage to js-browser
     {
       "files": ["src/storages/inLocalStorage/**/*.ts"],