@module-federation/cli 0.0.0-next-20250312104826

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-present hanric(2heal1)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,63 @@
+<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>
+
+# @module-federation/cli
+
+Module Federation CLI
+
+<p>
+  <a href="https://npmjs.com/package/@module-federation/cli">
+   <img src="https://img.shields.io/npm/v/@module-federation/cli?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/@module-federation/cli?minimal=true"><img src="https://img.shields.io/npm/dm/@module-federation/cli.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="downloads" /></a>
+</p>
+
+## All commands
+
+To view all available CLI commands, run the following command in the project directory:
+
+```bash
+npx @module-federation/cli -h
+```
+
+The output is shown below:
+
+```bash
+Usage: mf <command> [options]
+
+Options:
+  -V, --version   output the version number
+  -h, --help      display help for command
+
+Commands:
+  dts [options]   generate or fetch the mf types
+  help [command]  display help for command
+```
+
+### mf dts
+
+The mf dts command is used to generate or fetch remote types.
+
+```bash
+Usage: mf dts [options]
+
+generate or fetch the mf types
+
+Options:
+  --root <root>         specify the project root directory
+  --output <output>     specify the generated dts output directory
+  --fetch <boolean>     fetch types from remote, default is true (default: true)
+  --generate <boolean>  generate types, default is true (default: true)
+  -c --config <config>  specify the configuration file, can be a relative or absolute path
+  -h, --help            display help for command
+```
+
+## Documentation
+
+See [Documentation](https://module-federation.io/guide/start/quick-start).
+
+## License
+
+[MIT](https://github.com/module-federation/core/blob/main/LICENSE).

package/bin/mf.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+const { runCli } = require('../dist/index.cjs.js');
+
+runCli();

package/dist/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-present hanric(2heal1)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.cjs.d.ts

@@ -0,0 +1 @@
+export * from "./src/index";

package/dist/index.cjs.js

@@ -0,0 +1,514 @@
+'use strict';
+
+var commander = require('commander');
+var path = require('path');
+var sdk = require('@module-federation/sdk');
+var chalk = require('chalk');
+var dtsPlugin = require('@module-federation/dts-plugin');
+var nodeBundleRequire = require('@modern-js/node-bundle-require');
+
+var applyCommonOptions = function(command) {
+    command.option('-c --config <config>', 'specify the configuration file, can be a relative or absolute path');
+};
+
+function _tagged_template_literal(strings, raw) {
+    if (!raw) {
+        raw = strings.slice(0);
+    }
+    return Object.freeze(Object.defineProperties(strings, {
+        raw: {
+            value: Object.freeze(raw)
+        }
+    }));
+}
+function _templateObject() {
+    var data = _tagged_template_literal([
+        "{bold {cyan ",
+        "}}"
+    ]);
+    _templateObject = function _templateObject() {
+        return data;
+    };
+    return data;
+}
+var PREFIX = '[ Module Federation CLI ]';
+var logger = sdk.createLogger(chalk(_templateObject(), PREFIX));
+
+function asyncGeneratorStep$1(gen, resolve, reject, _next, _throw, key, arg) {
+    try {
+        var info = gen[key](arg);
+        var value = info.value;
+    } catch (error) {
+        reject(error);
+        return;
+    }
+    if (info.done) {
+        resolve(value);
+    } else {
+        Promise.resolve(value).then(_next, _throw);
+    }
+}
+function _async_to_generator$1(fn) {
+    return function() {
+        var self = this, args = arguments;
+        return new Promise(function(resolve, reject) {
+            var gen = fn.apply(self, args);
+            function _next(value) {
+                asyncGeneratorStep$1(gen, resolve, reject, _next, _throw, "next", value);
+            }
+            function _throw(err) {
+                asyncGeneratorStep$1(gen, resolve, reject, _next, _throw, "throw", err);
+            }
+            _next(undefined);
+        });
+    };
+}
+function _ts_generator$1(thisArg, body) {
+    var f, y, t, g, _ = {
+        label: 0,
+        sent: function() {
+            if (t[0] & 1) throw t[1];
+            return t[1];
+        },
+        trys: [],
+        ops: []
+    };
+    return g = {
+        next: verb(0),
+        "throw": verb(1),
+        "return": verb(2)
+    }, typeof Symbol === "function" && (g[Symbol.iterator] = function() {
+        return this;
+    }), g;
+    function verb(n) {
+        return function(v) {
+            return step([
+                n,
+                v
+            ]);
+        };
+    }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while(_)try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [
+                op[0] & 2,
+                t.value
+            ];
+            switch(op[0]){
+                case 0:
+                case 1:
+                    t = op;
+                    break;
+                case 4:
+                    _.label++;
+                    return {
+                        value: op[1],
+                        done: false
+                    };
+                case 5:
+                    _.label++;
+                    y = op[1];
+                    op = [
+                        0
+                    ];
+                    continue;
+                case 7:
+                    op = _.ops.pop();
+                    _.trys.pop();
+                    continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+                        _ = 0;
+                        continue;
+                    }
+                    if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+                        _.label = op[1];
+                        break;
+                    }
+                    if (op[0] === 6 && _.label < t[1]) {
+                        _.label = t[1];
+                        t = op;
+                        break;
+                    }
+                    if (t && _.label < t[2]) {
+                        _.label = t[2];
+                        _.ops.push(op);
+                        break;
+                    }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop();
+                    continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) {
+            op = [
+                6,
+                e
+            ];
+            y = 0;
+        } finally{
+            f = t = 0;
+        }
+        if (op[0] & 5) throw op[1];
+        return {
+            value: op[0] ? op[1] : void 0,
+            done: true
+        };
+    }
+}
+function dts(options, _) {
+    return _dts.apply(this, arguments);
+}
+function _dts() {
+    _dts = _async_to_generator$1(function(options, param) {
+        var defaultConfig, defaultPath, _options_fetch, fetch, _options_generate, generate, _options_root, root, output, _options_config, config, configPath, preBundlePath, mfConfig, normalizedDtsOptions, dtsManagerOptions, dtsManagerOptions1;
+        return _ts_generator$1(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    defaultConfig = param.defaultConfig;
+                    defaultPath = path.resolve(process.cwd(), defaultConfig);
+                    _options_fetch = options.fetch, fetch = _options_fetch === void 0 ? true : _options_fetch, _options_generate = options.generate, generate = _options_generate === void 0 ? true : _options_generate, _options_root = options.root, root = _options_root === void 0 ? process.cwd() : _options_root, output = options.output, _options_config = options.config, config = _options_config === void 0 ? defaultPath : _options_config;
+                    configPath = path.isAbsolute(config) ? config : path.resolve(process.cwd(), config);
+                    return [
+                        4,
+                        nodeBundleRequire.bundle(configPath)
+                    ];
+                case 1:
+                    preBundlePath = _state.sent();
+                    return [
+                        4,
+                        import(preBundlePath)
+                    ];
+                case 2:
+                    mfConfig = _state.sent().default.default;
+                    if (!dtsPlugin.isTSProject(mfConfig.dts, root)) {
+                        logger.error('dts is only supported for TypeScript projects');
+                        return [
+                            2
+                        ];
+                    }
+                    normalizedDtsOptions = dtsPlugin.normalizeDtsOptions(mfConfig, root, {
+                        defaultGenerateOptions: {
+                            generateAPITypes: true,
+                            compileInChildProcess: false,
+                            abortOnError: true,
+                            extractThirdParty: false,
+                            extractRemoteTypes: false
+                        },
+                        defaultConsumeOptions: {
+                            abortOnError: true,
+                            consumeAPITypes: true
+                        }
+                    });
+                    if (!normalizedDtsOptions) {
+                        logger.error('dts is not enabled in module-federation.config.ts');
+                        return [
+                            2
+                        ];
+                    }
+                    if (!fetch) return [
+                        3,
+                        5
+                    ];
+                    dtsManagerOptions = dtsPlugin.normalizeConsumeTypesOptions({
+                        context: root,
+                        dtsOptions: normalizedDtsOptions,
+                        pluginOptions: mfConfig
+                    });
+                    if (!!dtsManagerOptions) return [
+                        3,
+                        3
+                    ];
+                    logger.warn('dts.consumeTypes is not enabled in module-federation.config.ts, skip fetching remote types');
+                    return [
+                        3,
+                        5
+                    ];
+                case 3:
+                    logger.debug('start fetching remote types...');
+                    return [
+                        4,
+                        dtsPlugin.consumeTypesAPI(dtsManagerOptions)
+                    ];
+                case 4:
+                    _state.sent();
+                    logger.debug('fetch remote types success!');
+                    _state.label = 5;
+                case 5:
+                    if (!generate) return [
+                        3,
+                        7
+                    ];
+                    dtsManagerOptions1 = dtsPlugin.normalizeGenerateTypesOptions({
+                        context: root,
+                        outputDir: output,
+                        dtsOptions: normalizedDtsOptions,
+                        pluginOptions: mfConfig
+                    });
+                    if (!dtsManagerOptions1) {
+                        logger.warn('dts.generateTypes is not enabled in module-federation.config.ts, skip generating types');
+                        return [
+                            2
+                        ];
+                    }
+                    logger.debug('start generating types...');
+                    return [
+                        4,
+                        dtsPlugin.generateTypesAPI({
+                            dtsManagerOptions: dtsManagerOptions1
+                        })
+                    ];
+                case 6:
+                    _state.sent();
+                    logger.debug('generate types success!');
+                    _state.label = 7;
+                case 7:
+                    return [
+                        2
+                    ];
+            }
+        });
+    });
+    return _dts.apply(this, arguments);
+}
+
+function prepareCli(param) {
+    var welcomeMsg = param.welcomeMsg;
+    // Print a blank line to keep the greet log nice.
+    // Some package managers automatically output a blank line, some do not.
+    var npm_execpath = process.env.npm_execpath;
+    if (!npm_execpath || npm_execpath.includes('npx-cli.js') || npm_execpath.includes('.bun')) {
+        console.log();
+    }
+    logger.info(welcomeMsg);
+}
+
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
+    try {
+        var info = gen[key](arg);
+        var value = info.value;
+    } catch (error) {
+        reject(error);
+        return;
+    }
+    if (info.done) {
+        resolve(value);
+    } else {
+        Promise.resolve(value).then(_next, _throw);
+    }
+}
+function _async_to_generator(fn) {
+    return function() {
+        var self = this, args = arguments;
+        return new Promise(function(resolve, reject) {
+            var gen = fn.apply(self, args);
+            function _next(value) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
+            }
+            function _throw(err) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
+            }
+            _next(undefined);
+        });
+    };
+}
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+function _object_spread(target) {
+    for(var i = 1; i < arguments.length; i++){
+        var source = arguments[i] != null ? arguments[i] : {};
+        var ownKeys = Object.keys(source);
+        if (typeof Object.getOwnPropertySymbols === "function") {
+            ownKeys = ownKeys.concat(Object.getOwnPropertySymbols(source).filter(function(sym) {
+                return Object.getOwnPropertyDescriptor(source, sym).enumerable;
+            }));
+        }
+        ownKeys.forEach(function(key) {
+            _define_property(target, key, source[key]);
+        });
+    }
+    return target;
+}
+function _ts_generator(thisArg, body) {
+    var f, y, t, g, _ = {
+        label: 0,
+        sent: function() {
+            if (t[0] & 1) throw t[1];
+            return t[1];
+        },
+        trys: [],
+        ops: []
+    };
+    return g = {
+        next: verb(0),
+        "throw": verb(1),
+        "return": verb(2)
+    }, typeof Symbol === "function" && (g[Symbol.iterator] = function() {
+        return this;
+    }), g;
+    function verb(n) {
+        return function(v) {
+            return step([
+                n,
+                v
+            ]);
+        };
+    }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while(_)try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [
+                op[0] & 2,
+                t.value
+            ];
+            switch(op[0]){
+                case 0:
+                case 1:
+                    t = op;
+                    break;
+                case 4:
+                    _.label++;
+                    return {
+                        value: op[1],
+                        done: false
+                    };
+                case 5:
+                    _.label++;
+                    y = op[1];
+                    op = [
+                        0
+                    ];
+                    continue;
+                case 7:
+                    op = _.ops.pop();
+                    _.trys.pop();
+                    continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+                        _ = 0;
+                        continue;
+                    }
+                    if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+                        _.label = op[1];
+                        break;
+                    }
+                    if (op[0] === 6 && _.label < t[1]) {
+                        _.label = t[1];
+                        t = op;
+                        break;
+                    }
+                    if (t && _.label < t[2]) {
+                        _.label = t[2];
+                        _.ops.push(op);
+                        break;
+                    }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop();
+                    continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) {
+            op = [
+                6,
+                e
+            ];
+            y = 0;
+        } finally{
+            f = t = 0;
+        }
+        if (op[0] & 5) throw op[1];
+        return {
+            value: op[0] ? op[1] : void 0,
+            done: true
+        };
+    }
+}
+function cli(param) {
+    var name = param.name, version = param.version, applyCommands = param.applyCommands, config = param.config;
+    commander.program.name(name).usage('<command> [options]').version(version);
+    var dtsCommand = commander.program.command('dts');
+    dtsCommand.option('--root <root>', 'specify the project root directory').option('--output <output>', 'specify the generated dts output directory').option('--fetch <boolean>', 'fetch types from remote, default is true', function(value) {
+        return value === 'true';
+    }, true).option('--generate <boolean>', 'generate types, default is true', function(value) {
+        return value === 'true';
+    }, true);
+    applyCommonOptions(dtsCommand);
+    dtsCommand.description('generate or fetch the mf types').action(/*#__PURE__*/ function() {
+        var _ref = _async_to_generator(function(options) {
+            var err;
+            return _ts_generator(this, function(_state) {
+                switch(_state.label){
+                    case 0:
+                        _state.trys.push([
+                            0,
+                            2,
+                            ,
+                            3
+                        ]);
+                        return [
+                            4,
+                            dts(options, {
+                                defaultConfig: config
+                            })
+                        ];
+                    case 1:
+                        _state.sent();
+                        return [
+                            3,
+                            3
+                        ];
+                    case 2:
+                        err = _state.sent();
+                        console.error(err);
+                        process.exit(1);
+                        return [
+                            3,
+                            3
+                        ];
+                    case 3:
+                        return [
+                            2
+                        ];
+                }
+            });
+        });
+        return function(options) {
+            return _ref.apply(this, arguments);
+        };
+    }());
+    if (typeof applyCommands === 'function') {
+        applyCommands(commander.program, applyCommonOptions);
+    }
+    commander.program.parse();
+}
+function runCli(options) {
+    var normalizedOptions = _object_spread({
+        welcomeMsg: "".concat("Module Federation v".concat("0.10.0"), "\n"),
+        name: 'mf',
+        config: 'module-federation.config.ts',
+        version: "0.10.0",
+        applyCommands: function() {}
+    }, options);
+    prepareCli(normalizedOptions);
+    try {
+        cli(normalizedOptions);
+    } catch (err) {
+        console.error(err);
+    }
+}
+
+exports.runCli = runCli;

package/dist/src/cli.d.ts

@@ -0,0 +1,2 @@
+import type { CliOptions } from './types';
+export declare function runCli(options: CliOptions): void;

package/dist/src/commands/dts.d.ts

@@ -0,0 +1,4 @@
+import type { DtsOptions } from '../types';
+export declare function dts(options: DtsOptions, { defaultConfig }: {
+    defaultConfig: string;
+}): Promise<void>;

package/dist/src/index.d.ts

@@ -0,0 +1 @@
+export { runCli } from './cli';

package/dist/src/types.d.ts

@@ -0,0 +1,17 @@
+import type { Command } from 'commander';
+export type CommonOptions = {
+    config?: string;
+};
+export type DtsOptions = {
+    fetch?: boolean;
+    generate?: boolean;
+    root?: string;
+    output?: string;
+} & CommonOptions;
+export type CliOptions = {
+    welcomeMsg?: string;
+    name?: string;
+    version?: string;
+    config?: string;
+    applyCommands?: (command: Command, applyCommonOptions: (command: Command) => void) => void;
+};

package/dist/src/utils/apply-common-options.d.ts

@@ -0,0 +1,2 @@
+import type { Command } from 'commander';
+export declare const applyCommonOptions: (command: Command) => void;

package/dist/src/utils/logger.d.ts

@@ -0,0 +1,3 @@
+import { type Logger } from '@module-federation/sdk';
+declare const logger: Logger;
+export default logger;

package/dist/src/utils/prepare.d.ts

@@ -0,0 +1,2 @@
+import type { CliOptions } from '../types';
+export declare function prepareCli({ welcomeMsg }: Required<CliOptions>): void;

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@module-federation/cli",
+  "version": "0.0.0-next-20250312104826",
+  "type": "commonjs",
+  "description": "Module Federation CLI",
+  "homepage": "https://module-federation.io",
+  "bugs": {
+    "url": "https://github.com/module-federation/core/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/module-federation/core",
+    "directory": "packages/cli"
+  },
+  "bin": {
+    "mf": "./bin/mf.js"
+  },
+  "license": "MIT",
+  "main": "./dist/index.cjs.js",
+  "files": [
+    "dist",
+    "bin"
+  ],
+  "dependencies": {
+    "commander": "11.1.0",
+    "chalk": "3.0.0",
+    "@modern-js/node-bundle-require": "2.65.1",
+    "@module-federation/sdk": "0.0.0-next-20250312104826",
+    "@module-federation/dts-plugin": "0.0.0-next-20250312104826"
+  },
+  "devDependencies": {
+    "@types/node": "~16.11.7"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true,
+    "registry": "https://registry.npmjs.org/"
+  }
+}