fix(module-federation): add comment clarifying default export in conf…

…ig file (#28675)

<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

<!-- If this is a particularly complex change or feature addition, you
can request a dedicated Nx release for this pull request branch. Mention
someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they
will confirm if the PR warrants its own release for testing purposes,
and generate it for you if appropriate. -->

## Current Behavior
<!-- This is the behavior we have today -->

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #

packages/angular/src/generators/host/__snapshots__/host.spec.ts.snap

@@ -232,7 +232,10 @@ exports[`Host App Generator --ssr should generate the correct files 5`] = `
 `;
 
 exports[`Host App Generator --ssr should generate the correct files 6`] = `
-"module.exports = {
+"/**
+ * Nx requires a default export of the config to allow correct resolution of the module federation graph.
+ **/
+module.exports = {
   name: 'test',
   /**
    * To use a remote that does not exist in your current Nx Workspace
@@ -421,7 +424,10 @@ exports[`Host App Generator --ssr should generate the correct files for standalo
 `;
 
 exports[`Host App Generator --ssr should generate the correct files for standalone 5`] = `
-"module.exports = {
+"/**
+ * Nx requires a default export of the config to allow correct resolution of the module federation graph.
+ **/
+module.exports = {
   name: 'test',
   /**
    * To use a remote that does not exist in your current Nx Workspace
@@ -655,6 +661,9 @@ const config: ModuleFederationConfig = {
   remotes: []
 };
 
+/**
+* Nx requires a default export of the config to allow correct resolution of the module federation graph.
+**/
 export default config;
 "
 `;
@@ -890,6 +899,9 @@ const config: ModuleFederationConfig = {
   remotes: []
 };
 
+/**
+* Nx requires a default export of the config to allow correct resolution of the module federation graph.
+**/
 export default config;
 "
 `;

packages/angular/src/generators/remote/__snapshots__/remote.spec.ts.snap

@@ -206,7 +206,10 @@ exports[`MF Remote App Generator --ssr should generate the correct files 5`] = `
 `;
 
 exports[`MF Remote App Generator --ssr should generate the correct files 6`] = `
-"module.exports = {
+"/**
+ * Nx requires a default export of the config to allow correct resolution of the module federation graph.
+ **/
+module.exports = {
   name: 'test',
   exposes: {
     './Module': 'test/src/app/remote-entry/entry.module.ts',
@@ -441,6 +444,9 @@ const config: ModuleFederationConfig = {
   },
 };
 
+/**
+* Nx requires a default export of the config to allow correct resolution of the module federation graph.
+**/
 export default config;
 "
 `;
@@ -623,7 +629,10 @@ bootstrapApplication(RemoteEntryComponent, appConfig).catch((err) =>
 `;
 
 exports[`MF Remote App Generator should generate the a remote setup for standalone components 2`] = `
-"module.exports = {
+"/**
+ * Nx requires a default export of the config to allow correct resolution of the module federation graph.
+ **/
+module.exports = {
   name: 'test',
   exposes: {
     './Routes': 'test/src/app/remote-entry/entry.routes.ts',
@@ -691,6 +700,9 @@ const config: ModuleFederationConfig = {
   },
 };
 
+/**
+* Nx requires a default export of the config to allow correct resolution of the module federation graph.
+**/
 export default config;
 "
 `;

packages/angular/src/generators/setup-mf/__snapshots__/setup-mf.spec.ts.snap

@@ -73,7 +73,10 @@ export const appRoutes: Route[] = [
 `;
 
 exports[`Init MF should add a remote application and add it to a specified host applications webpack config that contains a remote application already 1`] = `
-"module.exports = {
+"/**
+* Nx requires a default export of the config to allow correct resolution of the module federation graph.
+**/
+module.exports = {
   name: 'app1',
   /**
    * To use a remote that does not exist in your current Nx Workspace
@@ -112,12 +115,18 @@ const config: ModuleFederationConfig = {
   remotes: ['remote1','remote2',]
 };
 
+/**
+* Nx requires a default export of the config to allow correct resolution of the module federation graph.
+**/
 export default config;
 "
 `;
 
 exports[`Init MF should add a remote application and add it to a specified host applications webpack config when no other remote has been added to it 1`] = `
-"module.exports = {
+"/**
+ * Nx requires a default export of the config to allow correct resolution of the module federation graph.
+ **/
+module.exports = {
   name: 'app1',
   /**
    * To use a remote that does not exist in your current Nx Workspace
@@ -156,6 +165,9 @@ const config: ModuleFederationConfig = {
   remotes: ['remote1',]
 };
 
+/**
+* Nx requires a default export of the config to allow correct resolution of the module federation graph.
+**/
 export default config;
 "
 `;
@@ -208,7 +220,10 @@ module.exports = withModuleFederation(config, { dts: false });
 `;
 
 exports[`Init MF should create webpack and mf configs correctly 2`] = `
-"module.exports = {
+"/**
+* Nx requires a default export of the config to allow correct resolution of the module federation graph.
+**/
+module.exports = {
   name: 'app1',
   /**
    * To use a remote that does not exist in your current Nx Workspace
@@ -241,7 +256,10 @@ module.exports = withModuleFederation(config, { dts: false });
 `;
 
 exports[`Init MF should create webpack and mf configs correctly 4`] = `
-"module.exports = {
+"/**
+* Nx requires a default export of the config to allow correct resolution of the module federation graph.
+**/
+module.exports = {
   name: 'remote1',
   exposes: {
     './Module': 'remote1/src/app/remote-entry/entry.module.ts',
@@ -283,6 +301,9 @@ const config: ModuleFederationConfig = {
   remotes: []
 };
 
+/**
+* Nx requires a default export of the config to allow correct resolution of the module federation graph.
+**/
 export default config;
 "
 `;
@@ -310,6 +331,9 @@ const config: ModuleFederationConfig = {
   },
 };
 
+/**
+* Nx requires a default export of the config to allow correct resolution of the module federation graph.
+**/
 export default config;
 "
 `;

packages/angular/src/generators/setup-mf/files/ts-webpack/module-federation.config.ts__tmpl__

@@ -21,4 +21,7 @@ const config: ModuleFederationConfig = {
   },<% } %>
 };
 
+/**
+* Nx requires a default export of the config to allow correct resolution of the module federation graph.
+**/
 export default config;

packages/angular/src/generators/setup-mf/files/webpack/module-federation.config.js__tmpl__

@@ -1,3 +1,6 @@
+/**
+* Nx requires a default export of the config to allow correct resolution of the module federation graph.
+**/
 module.exports = {
   name: '<%= name %>',<% if(type === 'host') { %>
   /**

packages/react/src/generators/host/__snapshots__/host.webpack.spec.ts.snap

@@ -36,6 +36,9 @@ const moduleFederationConfig = {
   remotes: [],
 };
 
+/**
+ * Nx requires a default export of the config to allow correct resolution of the module federation graph.
+ **/
 module.exports = moduleFederationConfig;
 "
 `;
@@ -73,6 +76,9 @@ const config: ModuleFederationConfig = {
   remotes: [],
 };
 
+/**
+ * Nx requires a default export of the config to allow correct resolution of the module federation graph.
+ **/
 export default config;
 "
 `;
@@ -103,7 +109,10 @@ module.exports = composePlugins(
 `;
 
 exports[`hostGenerator bundler=webpack should generate host files and configs when --typescriptConfiguration=false 2`] = `
-"module.exports = {
+"/**
+ * Nx requires a default export of the config to allow correct resolution of the module federation graph.
+ **/
+module.exports = {
   name: 'test',
   /**
    * To use a remote that does not exist in your current Nx Workspace
@@ -165,6 +174,9 @@ const config: ModuleFederationConfig = {
   ],
 };
 
+/**
+* Nx requires a default export of the config to allow correct resolution of the module federation graph.
+**/
 export default config;
 "
 `;

packages/react/src/generators/host/files/rspack-module-federation-ssr-ts/module-federation.server.config.ts__tmpl__

@@ -10,4 +10,7 @@ const config: ModuleFederationConfig = {
   ],
 };
 
+/**
+* Nx requires a default export of the config to allow correct resolution of the module federation graph.
+**/
 export default config;

packages/react/src/generators/host/files/rspack-module-federation-ssr/module-federation.server.config.js__tmpl__

@@ -13,4 +13,7 @@ const moduleFederationConfig = {
   ],
 };
 
+/**
+* Nx requires a default export of the config to allow correct resolution of the module federation graph.
+**/
 module.exports = moduleFederationConfig;

packages/react/src/generators/host/files/rspack-module-federation-ts/module-federation.config.ts__tmpl__

@@ -22,4 +22,7 @@ const config: ModuleFederationConfig = {
   ],
 };
 
+/**
+* Nx requires a default export of the config to allow correct resolution of the module federation graph.
+**/
 export default config;

packages/react/src/generators/host/files/rspack-module-federation/module-federation.config.js__tmpl__

@@ -1,3 +1,6 @@
+/**
+* Nx requires a default export of the config to allow correct resolution of the module federation graph.
+**/
 module.exports = {
   name: '<%= projectName %>',
   /**
@@ -18,4 +21,4 @@ module.exports = {
        }
     %>
   ],
-};
+};

packages/react/src/generators/host/files/webpack-module-federation-ssr-ts/module-federation.server.config.ts__tmpl__

@@ -10,4 +10,7 @@ const config: ModuleFederationConfig = {
   ],
 };
 
+/**
+* Nx requires a default export of the config to allow correct resolution of the module federation graph.
+**/
 export default config;

packages/react/src/generators/host/files/webpack-module-federation-ssr/module-federation.server.config.js__tmpl__

@@ -13,4 +13,7 @@ const moduleFederationConfig = {
   ],
 };
 
+/**
+* Nx requires a default export of the config to allow correct resolution of the module federation graph.
+**/
 module.exports = moduleFederationConfig;

packages/react/src/generators/host/files/webpack-module-federation-ts/module-federation.config.ts__tmpl__

@@ -22,4 +22,7 @@ const config: ModuleFederationConfig = {
   ],
 };
 
+/**
+* Nx requires a default export of the config to allow correct resolution of the module federation graph.
+**/
 export default config;

packages/react/src/generators/host/files/webpack-module-federation/module-federation.config.js__tmpl__

@@ -1,3 +1,6 @@
+/**
+* Nx requires a default export of the config to allow correct resolution of the module federation graph.
+**/
 module.exports = {
   name: '<%= projectName %>',
   /**
@@ -18,4 +21,4 @@ module.exports = {
        }
     %>
   ],
-};
+};

packages/react/src/generators/remote/__snapshots__/remote.rspack.spec.ts.snap

@@ -23,7 +23,10 @@ module.exports = composePlugins(withNx(), withReact(), withModuleFederation(conf
 exports[`remote generator bundler=rspack should create the remote with the correct config files 2`] = `"module.exports = require('./rspack.config');"`;
 
 exports[`remote generator bundler=rspack should create the remote with the correct config files 3`] = `
-"module.exports = {
+"/**
+* Nx requires a default export of the config to allow correct resolution of the module federation graph.
+**/
+module.exports = {
    name: 'test',
    
    exposes: {
@@ -56,7 +59,10 @@ module.exports = composePlugins(withNx(), withReact(), withModuleFederation(conf
 exports[`remote generator bundler=rspack should create the remote with the correct config files when --js=true 2`] = `"module.exports = require('./rspack.config');"`;
 
 exports[`remote generator bundler=rspack should create the remote with the correct config files when --js=true 3`] = `
-"module.exports = {
+"/**
+* Nx requires a default export of the config to allow correct resolution of the module federation graph.
+**/
+module.exports = {
    name: 'test',
    
    exposes: {
@@ -106,6 +112,9 @@ const config: ModuleFederationConfig = {
   },
 };
 
+/**
+ * Nx requires a default export of the config to allow correct resolution of the module federation graph.
+ **/
 export default config;
 "
 `;
@@ -131,7 +140,10 @@ module.exports = composePlugins(withNx(), withReact({ssr: true}), withModuleFede
 `;
 
 exports[`remote generator bundler=rspack should generate correct remote with config files when using --ssr 2`] = `
-"module.exports = {
+"/**
+* Nx requires a default export of the config to allow correct resolution of the module federation graph.
+**/
+module.exports = {
     name: 'test',
    exposes: {
      './Module': './src/remote-entry.ts',
@@ -174,6 +186,9 @@ const config: ModuleFederationConfig = {
   },
 };
 
+/**
+ * Nx requires a default export of the config to allow correct resolution of the module federation graph.
+ **/
 export default config;
 "
 `;