feat(eslint-plugin): add triple-slash-reference rule to ban TS '///' …

…within source code
microsoft · Apr 11, 2024 · dd4286a · dd4286a
1 parent 31be1ad
commit dd4286a
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/change/@fluentui-eslint-plugin-ee7a918a-238e-45f3-8a6b-18eb7ca7e02b.json b/change/@fluentui-eslint-plugin-ee7a918a-238e-45f3-8a6b-18eb7ca7e02b.json
@@ -0,0 +1,7 @@
+{
+  "type": "patch",
+  "comment": "feat(eslint-plugin): add triple-slash-reference rule to  ban TS '///' within source code",
+  "packageName": "@fluentui/eslint-plugin",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}
diff --git a/packages/cra-template/.eslintrc.json b/packages/cra-template/.eslintrc.json
@@ -6,7 +6,9 @@
       "files": ["template/**/*.{ts,tsx}"],
       "rules": {
         // the rule can't understand that the actual list of deps is in template.json
-        "import/no-extraneous-dependencies": "off"
+        "import/no-extraneous-dependencies": "off",
+        // valid in some template files - don't wanna spam consumer with inline eslint-disabled pragmas
+        "@typescript-eslint/triple-slash-reference": "off"
       }
     }
   ]

diff --git a/packages/eslint-plugin/src/configs/base.js b/packages/eslint-plugin/src/configs/base.js
@@ -14,6 +14,8 @@ module.exports = {
      */
     ...getNamingConventionRule(),
     '@fluentui/max-len': 'off',
+    // @typescript-eslint rules
+    '@typescript-eslint/triple-slash-reference': ['error', { lib: 'always', path: 'never', types: 'never' }],
   },
   overrides: [
     {