feat: add ignorePackages option

gajus · Sep 19, 2023 · 545558a · 545558a
1 parent c43ef5f
commit 545558a
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/rules/requireExtension.ts b/src/rules/requireExtension.ts
@@ -9,6 +9,11 @@ import { readPackageJson } from '../utilities/readPackageJson';
 const extensions = ['.js', '.ts', '.tsx'];
 
 const defaultOptions = {
+  // You may want to disable ignorePackages because there can be too many false-positives
+  // when attempting to identify if a package import requires .js extension or not.
+  //
+  // * We need to consider that the resolved path can be @types/.
+  // * We need to consider that the package.json might have package.json#exports rules.
   ignorePackages: false,
 };