@nx/module-federation 24.0.0-beta.2 → 24.0.0-beta.3

package/README.md

@@ -23,9 +23,7 @@
 
 Get to green PRs in half the time. Nx optimizes your builds, scales your CI, and fixes failed PRs. Built for developers and AI agents.
 
-This package is a [Module Federation plugin for Nx](https://nx.dev/nx-api/module-federation).
-Module Federation allows developers to share code between deployed applications easier and makes team collaboration more efficient.  
-To learn more about Module Federation, check out the [official documentation](https://module-federation.io/).
+Nx Module Federation was removed in Nx v24. This package only ships the migrations that move a workspace to the official [Module Federation](https://module-federation.io/) plugins. See the [React](https://nx.dev/docs/kb/migrate-from-nx-module-federation) and [Angular](https://nx.dev/docs/kb/migrate-angular-module-federation) migration guides.
 
 ## Getting Started
 

package/dist/angular.d.ts

@@ -1,5 +1 @@
-export * from './src/with-module-federation/angular/with-module-federation';
-export * from './src/with-module-federation/angular/with-module-federation-ssr';
-export * from './src/plugins/nx-module-federation-plugin/angular/nx-module-federation-plugin';
-export * from './src/plugins/nx-module-federation-plugin/angular/nx-module-federation-dev-server-plugin';
-export * from './src/plugins/nx-module-federation-plugin/angular/nx-module-federation-ssr-dev-server-plugin';
+export { withModuleFederation, withModuleFederationForSSR, NxModuleFederationPlugin, NxModuleFederationDevServerPlugin, NxModuleFederationSSRDevServerPlugin, } from './src/stubs/stubs';

package/dist/angular.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./src/with-module-federation/angular/with-module-federation"), exports);
-tslib_1.__exportStar(require("./src/with-module-federation/angular/with-module-federation-ssr"), exports);
-tslib_1.__exportStar(require("./src/plugins/nx-module-federation-plugin/angular/nx-module-federation-plugin"), exports);
-tslib_1.__exportStar(require("./src/plugins/nx-module-federation-plugin/angular/nx-module-federation-dev-server-plugin"), exports);
-tslib_1.__exportStar(require("./src/plugins/nx-module-federation-plugin/angular/nx-module-federation-ssr-dev-server-plugin"), exports);
+exports.NxModuleFederationSSRDevServerPlugin = exports.NxModuleFederationDevServerPlugin = exports.NxModuleFederationPlugin = exports.withModuleFederationForSSR = exports.withModuleFederation = void 0;
+var stubs_1 = require("./src/stubs/stubs");
+Object.defineProperty(exports, "withModuleFederation", { enumerable: true, get: function () { return stubs_1.withModuleFederation; } });
+Object.defineProperty(exports, "withModuleFederationForSSR", { enumerable: true, get: function () { return stubs_1.withModuleFederationForSSR; } });
+Object.defineProperty(exports, "NxModuleFederationPlugin", { enumerable: true, get: function () { return stubs_1.NxModuleFederationPlugin; } });
+Object.defineProperty(exports, "NxModuleFederationDevServerPlugin", { enumerable: true, get: function () { return stubs_1.NxModuleFederationDevServerPlugin; } });
+Object.defineProperty(exports, "NxModuleFederationSSRDevServerPlugin", { enumerable: true, get: function () { return stubs_1.NxModuleFederationSSRDevServerPlugin; } });

package/dist/index.d.ts

@@ -1 +1 @@
-export * from './src/utils/public-api';
+export type * from './src/stubs/models';

package/dist/index.js

@@ -1,4 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./src/utils/public-api"), exports);

package/dist/rspack.d.ts

@@ -1,5 +1 @@
-export * from './src/with-module-federation/rspack/with-module-federation';
-export * from './src/with-module-federation/rspack/with-module-federation-ssr';
-export * from './src/plugins/nx-module-federation-plugin/rspack/nx-module-federation-plugin';
-export * from './src/plugins/nx-module-federation-plugin/rspack/nx-module-federation-dev-server-plugin';
-export * from './src/plugins/nx-module-federation-plugin/rspack/nx-module-federation-ssr-dev-server-plugin';
+export { withModuleFederation, withModuleFederationForSSR, NxModuleFederationPlugin, NxModuleFederationDevServerPlugin, NxModuleFederationSSRDevServerPlugin, } from './src/stubs/stubs';

package/dist/rspack.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./src/with-module-federation/rspack/with-module-federation"), exports);
-tslib_1.__exportStar(require("./src/with-module-federation/rspack/with-module-federation-ssr"), exports);
-tslib_1.__exportStar(require("./src/plugins/nx-module-federation-plugin/rspack/nx-module-federation-plugin"), exports);
-tslib_1.__exportStar(require("./src/plugins/nx-module-federation-plugin/rspack/nx-module-federation-dev-server-plugin"), exports);
-tslib_1.__exportStar(require("./src/plugins/nx-module-federation-plugin/rspack/nx-module-federation-ssr-dev-server-plugin"), exports);
+exports.NxModuleFederationSSRDevServerPlugin = exports.NxModuleFederationDevServerPlugin = exports.NxModuleFederationPlugin = exports.withModuleFederationForSSR = exports.withModuleFederation = void 0;
+var stubs_1 = require("./src/stubs/stubs");
+Object.defineProperty(exports, "withModuleFederation", { enumerable: true, get: function () { return stubs_1.withModuleFederation; } });
+Object.defineProperty(exports, "withModuleFederationForSSR", { enumerable: true, get: function () { return stubs_1.withModuleFederationForSSR; } });
+Object.defineProperty(exports, "NxModuleFederationPlugin", { enumerable: true, get: function () { return stubs_1.NxModuleFederationPlugin; } });
+Object.defineProperty(exports, "NxModuleFederationDevServerPlugin", { enumerable: true, get: function () { return stubs_1.NxModuleFederationDevServerPlugin; } });
+Object.defineProperty(exports, "NxModuleFederationSSRDevServerPlugin", { enumerable: true, get: function () { return stubs_1.NxModuleFederationSSRDevServerPlugin; } });

package/dist/src/migrations/update-24-0-0/inventory.d.ts

@@ -0,0 +1,11 @@
+import { type Tree } from '@nx/devkit';
+export type Framework = 'react' | 'angular';
+export interface ModuleFederationUsage {
+    projectRoot: string;
+    files: string[];
+    ssr: boolean;
+}
+export type ModuleFederationInventory = Record<Framework, ModuleFederationUsage[]>;
+export declare function inventoryModuleFederation(tree: Tree): ModuleFederationInventory;
+export declare function removeUnusedModuleFederationPackage(tree: Tree, inventory: ModuleFederationInventory): boolean;
+export declare function describeUsage(usage: ModuleFederationUsage): string;

package/dist/src/migrations/update-24-0-0/inventory.js

@@ -0,0 +1,139 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.inventoryModuleFederation = inventoryModuleFederation;
+exports.removeUnusedModuleFederationPackage = removeUnusedModuleFederationPackage;
+exports.describeUsage = describeUsage;
+const devkit_1 = require("@nx/devkit");
+const posix_1 = require("node:path/posix");
+const SCANNED_EXTENSIONS = new Set([
+    '.ts',
+    '.tsx',
+    '.mts',
+    '.cts',
+    '.js',
+    '.jsx',
+    '.mjs',
+    '.cjs',
+    '.json',
+]);
+// Name the package without using it.
+const SKIPPED_FILES = new Set([
+    'migrations.json',
+    'package-lock.json',
+    'npm-shrinkwrap.json',
+]);
+const ANGULAR_MARKERS = [
+    '@nx/module-federation/angular',
+    '@nx/angular/mf',
+    '@nx/angular:module-federation-dev-server',
+    '@nx/angular:module-federation-dev-ssr',
+];
+const REACT_MARKERS = [
+    '@nx/module-federation/webpack',
+    '@nx/module-federation/rspack',
+    '@nx/react/mf',
+    '@nx/react/module-federation',
+    '@nx/rspack/module-federation',
+    '@nx/react:module-federation-',
+    '@nx/rspack:module-federation-',
+];
+// Root, `/url-helpers` and `/internal` imports say nothing about the framework.
+const SHARED_MARKER = /['"]@nx\/module-federation(\/url-helpers|\/internal)?['"]/;
+const SSR_MARKERS = [
+    'withModuleFederationForSSR',
+    'NxModuleFederationSSRDevServerPlugin',
+    'module-federation-ssr-dev-server',
+    'module-federation-dev-ssr',
+];
+const DEPENDENCY_FIELDS = [
+    'dependencies',
+    'devDependencies',
+    'peerDependencies',
+    'optionalDependencies',
+];
+function inventoryModuleFederation(tree) {
+    const byProject = new Map();
+    (0, devkit_1.visitNotIgnoredFiles)(tree, '', (filePath) => {
+        if (!SCANNED_EXTENSIONS.has((0, posix_1.extname)(filePath)))
+            return;
+        if (SKIPPED_FILES.has(filePath))
+            return;
+        const content = readScannableContent(tree, filePath);
+        if (!content)
+            return;
+        const frameworks = new Set();
+        if (ANGULAR_MARKERS.some((m) => content.includes(m))) {
+            frameworks.add('angular');
+        }
+        if (REACT_MARKERS.some((m) => content.includes(m))) {
+            frameworks.add('react');
+        }
+        if (frameworks.size === 0 && !SHARED_MARKER.test(content))
+            return;
+        const projectRoot = findProjectRoot(tree, filePath);
+        const usage = byProject.get(projectRoot) ?? {
+            frameworks: new Set(),
+            files: [],
+            ssr: false,
+        };
+        frameworks.forEach((f) => usage.frameworks.add(f));
+        usage.files.push(filePath);
+        usage.ssr ||= SSR_MARKERS.some((m) => content.includes(m));
+        byProject.set(projectRoot, usage);
+    });
+    const inventory = { react: [], angular: [] };
+    for (const [projectRoot, usage] of byProject) {
+        // Projects with only shared-entry imports are listed for both prompts to triage.
+        const frameworks = usage.frameworks.size > 0 ? [...usage.frameworks] : ['react', 'angular'];
+        for (const framework of frameworks) {
+            inventory[framework].push({
+                projectRoot,
+                files: usage.files.sort(),
+                ssr: usage.ssr,
+            });
+        }
+    }
+    return inventory;
+}
+// Nothing left to migrate, so the dependency can go without an agent.
+function removeUnusedModuleFederationPackage(tree, inventory) {
+    if (inventory.react.length > 0 || inventory.angular.length > 0) {
+        return false;
+    }
+    if (!tree.exists('package.json'))
+        return false;
+    const before = tree.read('package.json', 'utf-8');
+    (0, devkit_1.removeDependenciesFromPackageJson)(tree, ['@nx/module-federation'], ['@nx/module-federation']);
+    return tree.read('package.json', 'utf-8') !== before;
+}
+function describeUsage(usage) {
+    return `${usage.projectRoot || '.'}${usage.ssr ? ' (server-side rendering)' : ''}: ${usage.files.join(', ')}`;
+}
+function readScannableContent(tree, filePath) {
+    const content = tree.read(filePath, 'utf-8');
+    if (!content || !content.includes('@nx/'))
+        return null;
+    if (!filePath.endsWith('package.json'))
+        return content;
+    // A declared dependency is not usage; package.json only counts for its `nx` targets.
+    try {
+        const packageJson = JSON.parse(content);
+        for (const field of DEPENDENCY_FIELDS)
+            delete packageJson[field];
+        return JSON.stringify(packageJson);
+    }
+    catch {
+        return content;
+    }
+}
+function findProjectRoot(tree, filePath) {
+    let dir = (0, posix_1.dirname)(filePath);
+    while (dir !== '.' && dir !== '') {
+        if (tree.exists((0, posix_1.join)(dir, 'project.json')) ||
+            tree.exists((0, posix_1.join)(dir, 'package.json'))) {
+            return dir;
+        }
+        dir = (0, posix_1.dirname)(dir);
+    }
+    return '';
+}

package/dist/src/migrations/update-24-0-0/migrate-angular-module-federation.d.ts

@@ -0,0 +1,5 @@
+import { type ModuleFederationInventory } from './inventory';
+export declare function angularModuleFederationSteps(inventory: ModuleFederationInventory): {
+    nextSteps: string[];
+    agentContext: string[];
+};

package/dist/src/migrations/update-24-0-0/migrate-angular-module-federation.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.angularModuleFederationSteps = angularModuleFederationSteps;
+const inventory_1 = require("./inventory");
+function angularModuleFederationSteps(inventory) {
+    const usages = inventory.angular;
+    if (usages.length === 0)
+        return null;
+    return {
+        nextSteps: [
+            `Migrate ${usages.length} Angular project(s) off Nx Module Federation. See https://nx.dev/docs/kb/migrate-angular-module-federation`,
+        ],
+        agentContext: [
+            'Angular projects that use Nx Module Federation, with the files that reference it:',
+            ...usages.map(inventory_1.describeUsage),
+        ],
+    };
+}

package/dist/src/migrations/update-24-0-0/migrate-module-federation.d.ts

@@ -0,0 +1,10 @@
+import { type Tree } from '@nx/devkit';
+export default function migrateModuleFederation(tree: Tree): Promise<{
+    skipAgentic: boolean;
+    nextSteps?: undefined;
+    agentContext?: undefined;
+} | {
+    skipAgentic?: undefined;
+    nextSteps: string[];
+    agentContext: string[];
+}>;

package/dist/src/migrations/update-24-0-0/migrate-module-federation.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = migrateModuleFederation;
+const devkit_1 = require("@nx/devkit");
+const inventory_1 = require("./inventory");
+const migrate_angular_module_federation_1 = require("./migrate-angular-module-federation");
+const migrate_react_module_federation_1 = require("./migrate-react-module-federation");
+// One migration for both frameworks: removing `@nx/module-federation` triggers a
+// reinstall, and any migration from this package that runs after it fails to load.
+async function migrateModuleFederation(tree) {
+    const inventory = (0, inventory_1.inventoryModuleFederation)(tree);
+    const steps = [
+        (0, migrate_react_module_federation_1.reactModuleFederationSteps)(inventory),
+        (0, migrate_angular_module_federation_1.angularModuleFederationSteps)(inventory),
+    ].filter((s) => s !== null);
+    if (steps.length === 0) {
+        if ((0, inventory_1.removeUnusedModuleFederationPackage)(tree, inventory)) {
+            await (0, devkit_1.formatFiles)(tree);
+        }
+        return { skipAgentic: true };
+    }
+    return {
+        nextSteps: steps.flatMap((s) => s.nextSteps),
+        agentContext: steps.flatMap((s) => s.agentContext),
+    };
+}