feat: Allow to use tryExtensions in the rule no-unpublished-import (#429)

wdzeng · web-flow · commit 002ac9cbc572 · 2025-03-28T23:05:22.000+08:00
diff --git a/docs/rules/no-unpublished-import.md b/docs/rules/no-unpublished-import.md
@@ -51,6 +51,11 @@ Please see the shared settings documentation for more information.
 This can be configured in the rule options or as a shared setting [`settings.convertPath`](../shared-settings.md#convertpath).
 Please see the shared settings documentation for more information.
 
+#### tryExtensions
+
+This can be configured in the rule options or as a shared setting [`settings.tryExtensions`](../shared-settings.md#tryextensions).
+Please see the shared settings documentation for more information.
+
 ### ignoreTypeImport
 
 If using typescript, you may want to ignore type imports. This option allows you to do that.
diff --git a/lib/rules/no-unpublished-import.js b/lib/rules/no-unpublished-import.js
@@ -9,6 +9,7 @@ const getAllowModules = require("../util/get-allow-modules")
 const getConvertPath = require("../util/get-convert-path")
 const getResolvePaths = require("../util/get-resolve-paths")
 const getResolverConfig = require("../util/get-resolver-config")
+const getTryExtensions = require("../util/get-try-extensions")
 const visitImport = require("../util/visit-import")
 
 /**
@@ -18,6 +19,7 @@ const visitImport = require("../util/visit-import")
  *     convertPath?: import('../util/get-convert-path').ConvertPath;
  *     resolvePaths?: import('../util/get-resolve-paths').ResolvePaths;
  *     resolverConfig?: import('../util/get-resolver-config').ResolverConfig;
+ *     tryExtensions?: import('../util/get-try-extensions').TryExtensions;
  *     ignoreTypeImport?: boolean;
  *     ignorePrivate?: boolean;
  *   }?
@@ -42,6 +44,7 @@ module.exports = {
                     convertPath: getConvertPath.schema,
                     resolvePaths: getResolvePaths.schema,
                     resolverConfig: getResolverConfig.schema,
+                    tryExtensions: getTryExtensions.schema,
                     ignoreTypeImport: { type: "boolean", default: false },
                     ignorePrivate: { type: "boolean", default: true },
                 },
diff --git a/tests/fixtures/no-unpublished/4/abc.jsx b/tests/fixtures/no-unpublished/4/abc.jsx
diff --git a/tests/fixtures/no-unpublished/4/package.json b/tests/fixtures/no-unpublished/4/package.json
@@ -0,0 +1,8 @@
+{
+    "name": "test",
+    "version": "0.0.0",
+    "files": [
+        "index.jsx",
+        "abc.jsx"
+    ]
+}
diff --git a/tests/lib/rules/no-unpublished-import.js b/tests/lib/rules/no-unpublished-import.js
@@ -140,6 +140,16 @@ ruleTester.run("no-unpublished-import", rule, {
             code: "import a from 'virtual:package-scope/name';",
             options: [{ allowModules: ["virtual:package-scope"] }],
         },
+        // try extensions
+        {
+            filename: fixture("4/index.jsx"),
+            code: "import abc from './abc';",
+            options: [
+                {
+                    tryExtensions: [".jsx"],
+                },
+            ],
+        },
 
         // Auto-published files only apply to root package directory
         {
@@ -280,6 +290,16 @@ ruleTester.run("no-unpublished-import", rule, {
             ],
             errors: ['"../test.jsx" is not published.'],
         },
+        // try extensions
+        {
+            filename: fixture("4/index.jsx"),
+            code: "import abc from './abc';",
+            errors: ['"./abc" is not published.'],
+            // Without setting tryExtensions, it defaults to [".js", ".json", ".node"], and thus
+            // cannot find the abc.jsx file, which is published.
+            //
+            // options: [{ tryExtensions: [".jsx"], }],
+        },
 
         // outside of the package.
         {
