feat(allow-modules): include virtual: in the modules pattern (#425)

lfantone · web-flow · commit a10979306d2f · 2025-03-26T12:03:03.000+08:00
diff --git a/lib/util/get-allow-modules.js b/lib/util/get-allow-modules.js
@@ -53,7 +53,7 @@ module.exports.schema = {
     type: "array",
     items: {
         type: "string",
-        pattern: "^(?:@[a-zA-Z0-9_\\-.]+/)?[a-zA-Z0-9_\\-.]+$",
+        pattern: "^(?:virtual:)?(?:@[a-zA-Z0-9_\\-.]+/)?[a-zA-Z0-9_\\-.]+$",
     },
     uniqueItems: true,
 }
diff --git a/tests/lib/rules/no-extraneous-import.js b/tests/lib/rules/no-extraneous-import.js
@@ -98,6 +98,16 @@ ruleTester.run("no-extraneous-import", rule, {
             filename: fixture("tsconfig-paths/index.ts"),
             code: "import foo from '#configurations/foo'",
         },
+
+        // virtual modules
+        {
+            filename: fixture("test.js"),
+            code: "import a from 'virtual:package-name';",
+        },
+        {
+            filename: fixture("test.js"),
+            code: "import a from 'virtual:package-scope/name';",
+        },
     ],
     invalid: [
         {
diff --git a/tests/lib/rules/no-extraneous-require.js b/tests/lib/rules/no-extraneous-require.js
@@ -67,6 +67,16 @@ tester.run("no-extraneous-require", rule, {
             filename: fixture("dependencies/a.js"),
             code: "require('ccc')",
         },
+
+        // virtual modules
+        {
+            filename: fixture("test.js"),
+            code: "require('virtual:package-name');",
+        },
+        {
+            filename: fixture("test.js"),
+            code: "require('virtual:package-scope/name');",
+        },
     ],
     invalid: [
         {
diff --git a/tests/lib/rules/no-missing-import.js b/tests/lib/rules/no-missing-import.js
@@ -167,6 +167,17 @@ ruleTester.run("no-missing-import", rule, {
             code: "import electron from 'electron';",
             options: [{ allowModules: ["electron"] }],
         },
+        // allow virtual modules
+        {
+            filename: fixture("test.js"),
+            code: "import a from 'virtual:package-name';",
+            options: [{ allowModules: ["virtual:package-name"] }],
+        },
+        {
+            filename: fixture("test.js"),
+            code: "import a from 'virtual:package-scope/name';",
+            options: [{ allowModules: ["virtual:package-scope"] }],
+        },
 
         // resolvePaths
         {
@@ -480,5 +491,17 @@ ruleTester.run("no-missing-import", rule, {
                   },
               ]
             : []),
+
+        // virtual modules
+        {
+            filename: fixture("test.js"),
+            code: "import a from 'virtual:package-name';",
+            errors: cantResolve("virtual:package-name"),
+        },
+        {
+            filename: fixture("test.js"),
+            code: "import a from 'virtual:package-scope/name';",
+            errors: cantResolve("virtual:package-scope/name"),
+        },
     ],
 })
diff --git a/tests/lib/rules/no-missing-require.js b/tests/lib/rules/no-missing-require.js
@@ -240,6 +240,17 @@ ruleTester.run("no-missing-require", rule, {
             code: "require('jquery.cookie');",
             options: [{ allowModules: ["jquery.cookie"] }],
         },
+        // allow virtual modules
+        {
+            filename: fixture("test.js"),
+            code: "require('virtual:package-name');",
+            options: [{ allowModules: ["virtual:package-name"] }],
+        },
+        {
+            filename: fixture("test.js"),
+            code: "require('virtual:package-scope/name');",
+            options: [{ allowModules: ["virtual:package-scope"] }],
+        },
 
         // typescriptExtensionMap
         {
@@ -440,6 +451,18 @@ ruleTester.run("no-missing-require", rule, {
             code: "require.resolve('no-exist-package-0');",
             errors: cantResolve("no-exist-package-0"),
         },
+
+        // Virtual modules
+        {
+            filename: fixture("test.js"),
+            code: "require('virtual:package-name');",
+            errors: cantResolve("virtual:package-name"),
+        },
+        {
+            filename: fixture("test.js"),
+            code: "require('virtual:package-scope/name');",
+            errors: cantResolve("virtual:package-scope/name"),
+        },
     ],
 })
 
diff --git a/tests/lib/rules/no-unpublished-import.js b/tests/lib/rules/no-unpublished-import.js
@@ -123,11 +123,23 @@ ruleTester.run("no-unpublished-import", rule, {
             code: "import a from './a';",
         },
 
+        // allow module
         {
             filename: fixture("1/test.js"),
             code: "import electron from 'electron';",
             options: [{ allowModules: ["electron"] }],
         },
+        // allow virtual modules
+        {
+            filename: fixture("test.js"),
+            code: "import a from 'virtual:package-name';",
+            options: [{ allowModules: ["virtual:package-name"] }],
+        },
+        {
+            filename: fixture("test.js"),
+            code: "import a from 'virtual:package-scope/name';",
+            options: [{ allowModules: ["virtual:package-scope"] }],
+        },
 
         // Auto-published files only apply to root package directory
         {
diff --git a/tests/lib/rules/no-unpublished-require.js b/tests/lib/rules/no-unpublished-require.js
@@ -224,6 +224,17 @@ ruleTester.run("no-unpublished-require", rule, {
             code: "require('electron');",
             options: [{ allowModules: ["electron"] }],
         },
+        // allow virtual modules
+        {
+            filename: fixture("test.js"),
+            code: "require('virtual:package-name');",
+            options: [{ allowModules: ["virtual:package-name"] }],
+        },
+        {
+            filename: fixture("test.js"),
+            code: "require('virtual:package-scope/name');",
+            options: [{ allowModules: ["virtual:package-scope"] }],
+        },
 
         // Auto-published files only apply to root package directory
         {

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ module.exports.schema = {`
`53`	`53`	`type: "array",`
`54`	`54`	`items: {`
`55`	`55`	`type: "string",`
`56`		`- pattern: "^(?:@[a-zA-Z0-9_\\-.]+/)?[a-zA-Z0-9_\\-.]+$",`
	`56`	`+ pattern: "^(?:virtual:)?(?:@[a-zA-Z0-9_\\-.]+/)?[a-zA-Z0-9_\\-.]+$",`
`57`	`57`	`},`
`58`	`58`	`uniqueItems: true,`
`59`	`59`	`}`