指南
实践
配置
插件
案例
博客
指南
实践
配置
插件
案例
博客
简体中文

命令行工具

@module-federation/enhanced 和 @module-federation/modern-js 提供了轻量的命令行工具。

查看所有命令

如果你需要查看所有可用的 CLI 命令，请在项目目录中运行以下命令：

npx mf -h

输出如下：

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

公共选项

Module Federation CLI 提供了一些公共选项，可以用于所有命令：

选项 描述
-c, --config <config> 指定配置文件路径，可以为相对路径或绝对路径，默认值为 module-federation.config.ts
-m, --mode <mode> 指定运行环境，可以选择 "dev" 或 "prod" ，默认值为 "dev" ，设置后会按照值自动往 process.env.NODE_ENV 环境变量注入 "development" 或 "production"
-h, --help 显示命令帮助

mf dts

mf dts 命令用于拉取或生成 TypeScript 类型声明文件。

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
  -m --mode <mode>      Specify the runtime environment. You can choose "dev" or "prod". The default value is "dev". After setting, the process.env.NODE_ENV environment variable will be
                        automatically injected with "development" or "production" according to the value. (default: "dev")
  -h, --help            display help for command
注意

mf dts 命令会自动根据 module-federation.config.ts 中的配置生成或拉取类型声明文件。 这意味着你必须提供一个有效的配置文件，否则命令将无法正常运行。

如果你是只使用了 runtime API，那么你需要创建一份临时的 module-federation.config.ts 文件，配置 dts.consumeTypes.remoteTypeUrls，然后运行 mf dts 命令。