feat!: remove magic exports support

remix-run · Jul 20, 2023 · 0276abf · 0276abf
1 parent 7098a84
commit 0276abf
Show file tree

Hide file tree

Showing 18 changed files with 39 additions and 518 deletions.
diff --git a/.changeset/blue-beers-tan.md b/.changeset/blue-beers-tan.md
@@ -0,0 +1,19 @@
+---
+"remix": major
+"@remix-run/cloudflare": major
+"@remix-run/dev": major
+"@remix-run/node": major
+"@remix-run/react": major
+"@remix-run/server-runtime": major
+"@remix-run/testing": major
+---
+
+Removed support for "magic exports" from the `remix` package. Remix modules should be imported directly from their source package.
+
+```diff
+- import type { type ActionArgs } from "remix";
+- import { json, useLoaderData } from "remix";
++ import type { ActionArgs } from "@remix-run/node";
++ import { json } from "@remix-run/node";
++ import { useLoaderData } from "@remix-run/react";
+```
diff --git a/integration/cf-compiler-test.ts b/integration/cf-compiler-test.ts
@@ -177,60 +177,6 @@ test.describe("cloudflare compiler", () => {
     );
   });
 
-  // TODO: remove this when we get rid of that feature.
-  test("magic imports still works", async () => {
-    let magicExportsForNode = [
-      "createCloudflareKVSessionStorage",
-      "createCookie",
-      "createCookieSessionStorage",
-      "createMemorySessionStorage",
-      "createSessionStorage",
-      "createSession",
-      "createWorkersKVSessionStorage",
-      "isCookie",
-      "isSession",
-      "json",
-      "redirect",
-      "Form",
-      "Link",
-      "Links",
-      "LiveReload",
-      "Meta",
-      "NavLink",
-      "Outlet",
-      "PrefetchPageLinks",
-      "RemixBrowser",
-      "RemixServer",
-      "Scripts",
-      "ScrollRestoration",
-      "useActionData",
-      "useBeforeUnload",
-      "useCatch",
-      "useFetcher",
-      "useFetchers",
-      "useFormAction",
-      "useHref",
-      "useLoaderData",
-      "useLocation",
-      "useMatches",
-      "useNavigate",
-      "useNavigationType",
-      "useOutlet",
-      "useOutletContext",
-      "useParams",
-      "useResolvedPath",
-      "useSearchParams",
-      "useSubmit",
-    ];
-    let magicRemix = await fs.readFile(
-      path.resolve(projectDir, "node_modules/remix/dist/index.js"),
-      "utf8"
-    );
-    for (let name of magicExportsForNode) {
-      expect(magicRemix).toContain(name);
-    }
-  });
-
   test("node externals are not bundled in the browser bundle", async () => {
     let browserBundle = findBrowserBundle(projectDir);
     let browserCodeFiles = await findCodeFiles(browserBundle);

diff --git a/integration/compiler-test.ts b/integration/compiler-test.ts
@@ -311,62 +311,6 @@ test.describe("compiler", () => {
     expect(fontFile).toBeTruthy();
   });
 
-  // TODO: remove this when we get rid of that feature.
-  test("magic imports still works", async () => {
-    let magicExportsForNode = [
-      "createCookie",
-      "createCookieSessionStorage",
-      "createFileSessionStorage",
-      "createMemorySessionStorage",
-      "createSessionStorage",
-      "unstable_createFileUploadHandler",
-      "unstable_createMemoryUploadHandler",
-      "unstable_parseMultipartFormData",
-      "createSession",
-      "isCookie",
-      "isSession",
-      "json",
-      "redirect",
-      "Form",
-      "Link",
-      "Links",
-      "LiveReload",
-      "Meta",
-      "NavLink",
-      "Outlet",
-      "PrefetchPageLinks",
-      "RemixBrowser",
-      "RemixServer",
-      "Scripts",
-      "ScrollRestoration",
-      "useActionData",
-      "useBeforeUnload",
-      "useCatch",
-      "useFetcher",
-      "useFetchers",
-      "useFormAction",
-      "useHref",
-      "useLoaderData",
-      "useLocation",
-      "useMatches",
-      "useNavigate",
-      "useNavigationType",
-      "useOutlet",
-      "useOutletContext",
-      "useParams",
-      "useResolvedPath",
-      "useSearchParams",
-      "useSubmit",
-    ];
-    let magicRemix = await fse.readFile(
-      path.resolve(fixture.projectDir, "node_modules/remix/dist/index.js"),
-      "utf8"
-    );
-    for (let name of magicExportsForNode) {
-      expect(magicRemix).toContain(name);
-    }
-  });
-
   test.describe("serverBareModulesPlugin", () => {
     let ogConsole: typeof global.console;
     test.beforeEach(() => {

diff --git a/packages/remix-cloudflare/rollup.config.js b/packages/remix-cloudflare/rollup.config.js
@@ -6,7 +6,6 @@ const copy = require("rollup-plugin-copy");
 const {
   getOutputDir,
   copyToPlaygrounds,
-  magicExportsPlugin,
   isBareModuleId,
   createBanner,
 } = require("../../rollup.utils");
@@ -45,7 +44,6 @@ module.exports = function rollup() {
             { src: `${sourceDir}/README.md`, dest: outputDir },
           ],
         }),
-        magicExportsPlugin({ packageName, version }),
         copyToPlaygrounds(),
       ],
     },

diff --git a/packages/remix-dev/__tests__/cli-test.ts b/packages/remix-dev/__tests__/cli-test.ts
@@ -98,7 +98,6 @@ describe("remix CLI", () => {
             $ remix dev [projectDir]
             $ remix routes [projectDir]
             $ remix watch [projectDir]
-            $ remix setup [remixPlatform]
             $ remix codemod <codemod> [projectDir]
 
           Options:

diff --git a/packages/remix-dev/cli/commands.ts b/packages/remix-dev/cli/commands.ts
@@ -19,7 +19,6 @@ import { readConfig } from "../config";
 import { formatRoutes, RoutesFormat, isRoutesFormat } from "../config/format";
 import { createApp } from "./create";
 import { detectPackageManager } from "./detectPackageManager";
-import { setupRemix, isSetupPlatform, SetupPlatform } from "./setup";
 import runCodemod from "../codemod";
 import { CodemodError } from "../codemod/utils/error";
 import { TaskError } from "../codemod/utils/task";
@@ -114,25 +113,16 @@ export async function init(
   }
 }
 
-export async function setup(platformArg?: string) {
-  let platform: SetupPlatform;
-  if (
-    platformArg === "cloudflare-workers" ||
-    platformArg === "cloudflare-pages"
-  ) {
-    console.warn(
-      `Using '${platformArg}' as a platform value is deprecated. Use ` +
-        "'cloudflare' instead."
-    );
-    console.log("HINT: check the `postinstall` script in `package.json`");
-    platform = SetupPlatform.Cloudflare;
-  } else {
-    platform = isSetupPlatform(platformArg) ? platformArg : SetupPlatform.Node;
-  }
-
-  await setupRemix(platform);
-
-  console.log(`Successfully setup Remix for ${platform}.`);
+/**
+ * Keep the function around in v2 so that users with `remix setup` in a script
+ * or postinstall hook can still run a build, but inform them that it's no
+ * longer necessary, and we can remove it in v3.
+ * @deprecated
+ */
+export function setup() {
+  console.warn(
+    "WARNING: The setup command is no longer necessary as of v2. This is a no-op. Please remove this from your dev and CI scripts, as it will be removed in v3."
+  );
 }
 
 export async function routes(

diff --git a/packages/remix-dev/cli/run.ts b/packages/remix-dev/cli/run.ts
@@ -25,7 +25,6 @@ ${colors.logoBlue("R")} ${colors.logoGreen("E")} ${colors.logoYellow(
     $ remix dev [${colors.arg("projectDir")}]
     $ remix routes [${colors.arg("projectDir")}]
     $ remix watch [${colors.arg("projectDir")}]
-    $ remix setup [${colors.arg("remixPlatform")}]
     $ remix codemod <${colors.arg("codemod")}> [${colors.arg("projectDir")}]
 
   ${colors.heading("Options")}:
@@ -528,7 +527,7 @@ export async function run(argv: string[] = process.argv.slice(2)) {
       await commands.watch(input[1], process.env.NODE_ENV);
       break;
     case "setup":
-      await commands.setup(input[1]);
+      commands.setup();
       break;
     case "codemod": {
       await commands.codemod(input[1], input[2]);

diff --git a/packages/remix-dev/cli/setup.ts b/packages/remix-dev/cli/setup.ts
diff --git a/packages/remix-dev/compiler/js/compiler.ts b/packages/remix-dev/compiler/js/compiler.ts
@@ -10,7 +10,6 @@ import { loaders } from "../utils/loaders";
 import { browserRouteModulesPlugin } from "./plugins/routes";
 import { cssFilePlugin } from "../plugins/cssImports";
 import { absoluteCssUrlsPlugin } from "../plugins/absoluteCssUrlsPlugin";
-import { deprecatedRemixPackagePlugin } from "../plugins/deprecatedRemixPackage";
 import { emptyModulesPlugin } from "../plugins/emptyModules";
 import { mdxPlugin } from "../plugins/mdx";
 import { externalPlugin } from "../plugins/external";
@@ -88,7 +87,6 @@ const createEsbuildConfig = (
 
   let plugins: esbuild.Plugin[] = [
     browserRouteModulesPlugin(ctx, /\?browser$/),
-    deprecatedRemixPackagePlugin(ctx),
     cssBundlePlugin(refs),
     cssModulesPlugin(ctx, { outputCss: false }),
     vanillaExtractPlugin(ctx, { outputCss: false }),

diff --git a/packages/remix-dev/compiler/plugins/deprecatedRemixPackage.ts b/packages/remix-dev/compiler/plugins/deprecatedRemixPackage.ts