Merge pull request #2131 from embroider-build/create-embroider-virtual

Rename @embroider/core/entrypoint to @embroider/virtual/compat-modules
embroider-build · Oct 3, 2024 · 72d2f54 · 72d2f54
2 parents aa52b09 + d92cda2
commit 72d2f54
Show file tree

Hide file tree

Showing 11 changed files with 31 additions and 9 deletions.
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -11,10 +11,16 @@
   "license": "MIT",
   "author": "Edward Faulkner",
   "main": "src/index.js",
+  "typesVersions": {
+    "*": {
+      "virtual": ["types/virtual"]
+    }
+  },
   "files": [
     "src/**/*.js",
     "src/**/*.d.ts",
-    "src/**/*.js.map"
+    "src/**/*.js.map",
+    "types"
   ],
   "scripts": {
     "test": "jest"

diff --git a/packages/core/src/module-resolver.ts b/packages/core/src/module-resolver.ts
@@ -409,13 +409,17 @@ export class Resolver {
     }
 
     //TODO move the extra forwardslash handling out into the vite plugin
-    const candidates = ['@embroider/core/entrypoint', '/@embroider/core/entrypoint', './@embroider/core/entrypoint'];
+    const candidates = [
+      '@embroider/virtual/compat-modules',
+      '/@embroider/virtual/compat-modules',
+      './@embroider/virtual/compat-modules',
+    ];
 
     if (!candidates.some(c => request.specifier.startsWith(c + '/') || request.specifier === c)) {
       return request;
     }
 
-    const result = /\.?\/?@embroider\/core\/entrypoint(?:\/(?<packageName>.*))?/.exec(request.specifier);
+    const result = /\.?\/?@embroider\/virtual\/compat-modules(?:\/(?<packageName>.*))?/.exec(request.specifier);
 
     if (!result) {
       // TODO make a better error

diff --git a/packages/core/src/virtual-entrypoint.ts b/packages/core/src/virtual-entrypoint.ts
@@ -97,7 +97,7 @@ export function renderEntrypoint(
     // deliberately ignoring the app (which is the first entry in the engines array)
     let [, ...childEngines] = resolver.options.engines;
     for (let childEngine of childEngines) {
-      let target = `@embroider/core/entrypoint/${childEngine.packageName}`;
+      let target = `@embroider/virtual/compat-modules/${childEngine.packageName}`;
 
       if (childEngine.isLazy) {
         lazyEngines.push({

diff --git a/packages/core/types/virtual/index.d.ts b/packages/core/types/virtual/index.d.ts
@@ -0,0 +1,9 @@
+declare module '@embroider/virtual/compat-modules' {
+  interface UnknownModule {
+    [exportName: string]: unknown;
+  }
+
+  const compatModules: Record<string, UnknownModule>;
+
+  export default compatModules;
+}
diff --git a/packages/core/types/virtual/index.js b/packages/core/types/virtual/index.js
@@ -0,0 +1,3 @@
+throw new Error(
+  `@embroider/virtual module loaded at runtime! This is likely a mistake. Make sure that you have all the needed plugins for virtually providing embroider's virtual modules.`
+);
diff --git a/tests/addon-template/tests/dummy/app/app.js b/tests/addon-template/tests/dummy/app/app.js
@@ -1,5 +1,5 @@
 import Application from '@ember/application';
-import compatModules from '@embroider/core/entrypoint';
+import compatModules from '@embroider/virtual/compat-modules';
 import Resolver from 'ember-resolver';
 import loadInitializers from 'ember-load-initializers';
 import config from 'dummy/config/environment';

diff --git a/tests/app-template/app/app.js b/tests/app-template/app/app.js
@@ -1,5 +1,5 @@
 import Application from '@ember/application';
-import compatModules from '@embroider/core/entrypoint';
+import compatModules from '@embroider/virtual/compat-modules';
 import Resolver from 'ember-resolver';
 import loadInitializers from 'ember-load-initializers';
 import config from './config/environment';

diff --git a/tests/scenarios/compat-renaming-test.ts b/tests/scenarios/compat-renaming-test.ts
@@ -31,7 +31,7 @@ appScenarios
             import utilsIndex from 'somebody-elses-package/utils/index';
             import utilsIndexJS from 'somebody-elses-package/utils/index.js';
             import singleFilePackage from 'single-file-package';
-            import compat from '@embroider/core/entrypoint';
+            import compat from '@embroider/virtual/compat-modules';
 
             module('Unit | basics', function () {
               test('whole package renaming works for top-level module', async function (assert) {

diff --git a/tests/ts-app-template/app/app.ts b/tests/ts-app-template/app/app.ts
@@ -1,5 +1,5 @@
 import Application from '@ember/application';
-import compatModules from '@embroider/core/entrypoint';
+import compatModules from '@embroider/virtual/compat-modules';
 import Resolver from 'ember-resolver';
 import loadInitializers from 'ember-load-initializers';
 import config from 'ts-app-template/config/environment';

diff --git a/tests/ts-app-template/types/ts-app-template/entry.d.ts b/tests/ts-app-template/types/ts-app-template/entry.d.ts
diff --git a/tests/ts-app-template/types/ts-app-template/index.d.ts b/tests/ts-app-template/types/ts-app-template/index.d.ts
@@ -1,3 +1,4 @@
+/// <reference types="@embroider/core/virtual" />
 import 'ember-source/types';
 
 export {};