create-module-federation 0.0.0-next-20250306073231 → 0.0.0-next-20250310022208

package/README.md

@@ -1 +1,40 @@
-# `create-module-federation`
+<p align="center">
+  <a href="https://module-federation.io/" target="blank"><img src="https://module-federation.io/module-federation.svg" alt="Module Federation 2.0" /></a>
+</p>
+
+# create-module-federation
+
+Create a new Module Federation project.
+
+<p>
+  <a href="https://npmjs.com/package/create-module-federation">
+   <img src="https://img.shields.io/npm/v/create-module-federation?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
+  </a>
+  <img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" />
+  <a href="https://npmcharts.com/compare/create-module-federation?minimal=true"><img src="https://img.shields.io/npm/dm/create-module-federation.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="downloads" /></a>
+</p>
+
+## Usage
+
+Using `npm create`:
+
+```bash
+npm create module-federation@latest
+```
+
+Using CLI flags:
+
+```bash
+npx create-module-federation --dir my-project --template provider-modern --name provider
+
+# Using abbreviations
+npx create-module-federation -d my-project -t provider-modern -n provider
+```
+
+## Documentation
+
+See [Documentation](https://module-federation.io/guide/start/quick-start).
+
+## License
+
+[MIT](https://github.com/module-federation/core/blob/main/LICENSE).

package/dist/index.js

@@ -98,8 +98,8 @@ const packageDir = __WEBPACK_EXTERNAL_MODULE_path__["default"].resolve(create_di
 const OTHER_TYPE = {
     zephyr: {
         label: 'zephyr',
-        command: 'npm create zephyr@latest',
-        hint: 'npm create zephyr@latest'
+        packageName: 'zephyr-apps@latest',
+        hint: 'create zephyr-apps@latest'
     }
 };
 function upperFirst(str) {
@@ -119,8 +119,7 @@ function logHelpMessage(name, templates) {
      --override       override files in target directory
 
    Templates:
-
-     ${templates.join(', ')}
+     ${templates.filter((t)=>!t.startsWith('zephyr')).join(', ')}
 `);
 }
 function pkgFromUserAgent(userAgent) {
@@ -190,6 +189,27 @@ function getTemplateName({ projectType, roleType, framework }, args) {
 function getTemplateDir(templateName) {
     return `templates/${templateName}/`;
 }
+async function getProjectType(template) {
+    if (!template) return checkCancel(await (0, __WEBPACK_EXTERNAL_MODULE__clack_prompts_3cae1695__.select)({
+        message: 'Please select the type of project you want to create:',
+        options: [
+            {
+                value: "app",
+                label: 'Application'
+            },
+            {
+                value: "lib",
+                label: 'Lib'
+            },
+            {
+                value: "zephyr",
+                label: 'Zephyr Powered (Learn more at https://zephyr-cloud.io)'
+            }
+        ]
+    }));
+    if (template.includes('lib')) return "lib";
+    return "app";
+}
 async function forgeTemplate({ projectType, argv, templateParameters, distFolder }) {
     let framework = 'modern';
     let roleType = "provider";
@@ -247,32 +267,11 @@ async function forgeTemplate({ projectType, argv, templateParameters, distFolder
     };
     const templateDir = getTemplateDir(templateName);
     let commonTemplateDir = '';
-    commonTemplateDir = "lib" === projectType ? 'templates/lib-common/' : `templates/${framework}-common/`;
-    await renderTemplate(commonTemplateDir);
+    if ("lib" === projectType) commonTemplateDir = 'templates/lib-common/';
+    else if ('app' === projectType) commonTemplateDir = `templates/${framework}-common/`;
+    if (commonTemplateDir) await renderTemplate(commonTemplateDir);
     await renderTemplate(templateDir);
 }
-async function getProjectType(template) {
-    if (!template) return checkCancel(await (0, __WEBPACK_EXTERNAL_MODULE__clack_prompts_3cae1695__.select)({
-        message: 'Please select the type of project you want to create:',
-        options: [
-            {
-                value: "app",
-                label: 'Application'
-            },
-            {
-                value: "lib",
-                label: 'Lib'
-            },
-            {
-                value: "other",
-                label: 'Other'
-            }
-        ]
-    }));
-    if (template.startsWith('create-')) return "other";
-    if (template.includes('lib')) return "lib";
-    return "app";
-}
 async function create({ name, templates }) {
     const argv = (0, __WEBPACK_EXTERNAL_MODULE_minimist__["default"])(process.argv.slice(2), {
         alias: {
@@ -293,6 +292,22 @@ async function create({ name, templates }) {
     const pkgInfo = pkgFromUserAgent(process.env['npm_config_user_agent']);
     const pkgManager = pkgInfo ? pkgInfo.name : 'npm';
     const mfVersion = "0.10.0";
+    argv.template = templates.includes(argv.template || '') ? argv.template : void 0;
+    const projectType = await getProjectType(argv.template);
+    if ("zephyr" === projectType) {
+        const zephyrPackage = OTHER_TYPE['zephyr'].packageName;
+        const zephyrCommand = `${pkgManager} create ${zephyrPackage}`;
+        (0, __WEBPACK_EXTERNAL_MODULE__clack_prompts_3cae1695__.note)(`Running: ${zephyrCommand}`, 'Launching Zephyr setup');
+        (0, __WEBPACK_EXTERNAL_MODULE_child_process__.spawnSync)(pkgManager, [
+            'create',
+            zephyrPackage
+        ], {
+            stdio: 'inherit',
+            shell: true
+        });
+        (0, __WEBPACK_EXTERNAL_MODULE__clack_prompts_3cae1695__.outro)('Done.');
+        return;
+    }
     const mfName = argv.name || checkCancel(await (0, __WEBPACK_EXTERNAL_MODULE__clack_prompts_3cae1695__.text)({
         message: 'Please input Module Federation name:',
         placeholder: 'mf_project_name',
@@ -319,27 +334,6 @@ async function create({ name, templates }) {
         }));
         if ('no' === option) cancelAndExit();
     }
-    argv.template = templates.includes(argv.template || '') ? argv.template : void 0;
-    const projectType = await getProjectType(argv.template);
-    if ("other" === projectType) {
-        const otherOptions = Object.keys(OTHER_TYPE).map((key)=>({
-                value: key,
-                label: OTHER_TYPE[key].label
-            }));
-        const otherProjectKey = checkCancel(await (0, __WEBPACK_EXTERNAL_MODULE__clack_prompts_3cae1695__.select)({
-            message: 'Please select the type of template you want to create:',
-            options: otherOptions
-        }));
-        const { command } = OTHER_TYPE[otherProjectKey];
-        const commandWithManager = command.replace(/^npm create /, `${pkgManager} create `);
-        const npmParams = 'npm' === pkgManager && pkgInfo?.version && parseInt(pkgInfo.version.split('.')[0], 10) < 7 ? ' --' : '';
-        const realCommand = `${commandWithManager}${npmParams} -d ${distFolder} -n ${mfName}${argv.override ? ' --override' : ''}`;
-        const [cmd, ...cmdArgs] = realCommand.split(' ');
-        const { status } = (0, __WEBPACK_EXTERNAL_MODULE_child_process__.spawnSync)(cmd, cmdArgs, {
-            stdio: 'inherit'
-        });
-        process.exit(status ?? 0);
-    }
     await forgeTemplate({
         projectType,
         argv,
@@ -359,12 +353,11 @@ async function create({ name, templates }) {
 }
 const TEMPLATES = [
     'provider-modern',
-    'consumer-modern',
     'provider-rsbuild',
-    'consumer-rsbuild',
     'rslib',
     'rslib-storybook',
-    'create-zephyr'
+    'consumer-modern',
+    'consumer-rsbuild'
 ];
 create({
     name: 'Module Federation',

package/package.json

@@ -3,7 +3,7 @@
   "description": "Create a new Module Federation project",
   "public": true,
   "sideEffects": false,
-  "version": "0.0.0-next-20250306073231",
+  "version": "0.0.0-next-20250310022208",
   "license": "MIT",
   "repository": {
     "type": "git",

package/templates/provider-modern-ts/modern.config.ts

@@ -0,0 +1,18 @@
+import { appTools, defineConfig } from '@modern-js/app-tools';
+import { moduleFederationPlugin } from '@module-federation/modern-js';
+
+// https://modernjs.dev/en/configure/app/usage
+export default defineConfig({
+  runtime: {
+    router: true,
+  },
+  plugins: [
+    appTools({
+      bundler: 'rspack', // Set to 'webpack' to enable webpack
+    }),
+    moduleFederationPlugin(),
+  ],
+  server: {
+    port: 3001,
+  },
+});

package/templates/provider-rsbuild-ts/rsbuild.config.ts

@@ -0,0 +1,11 @@
+import { defineConfig } from '@rsbuild/core';
+import { pluginReact } from '@rsbuild/plugin-react';
+import { pluginModuleFederation } from '@module-federation/rsbuild-plugin';
+import moduleFederationConfig from './module-federation.config';
+
+export default defineConfig({
+  plugins: [pluginReact(), pluginModuleFederation(moduleFederationConfig)],
+  server: {
+    port: 3001,
+  },
+});