Herramienta de línea de comandos

Module Federation ofrece una herramienta de línea de comandos ligera, mf, incluida en @module-federation/enhanced.

Note

Si ya completaste la integración siguiendo una guía de integración, lo habitual es que @module-federation/enhanced ya esté en tu árbol de dependencias y que este comando esté disponible de inmediato. Si no es así, instálalo manualmente en tu proyecto antes de ejecutar los comandos siguientes.

Ver todos los comandos

Si necesitas ver todos los comandos de CLI disponibles, ejecuta el siguiente comando en el directorio del proyecto:

npx mf -h

Salida:


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

Opciones comunes

La CLI de Module Federation ofrece algunas opciones comunes que puedes usar con todos los comandos:

OpciónDescripción
-c, --config <config>Especifica la ruta del archivo de configuración, que puede ser relativa o absoluta. El valor por defecto es module-federation.config.ts
-m, --mode <mode>Especifica el entorno de ejecución; puedes elegir "dev" o "prod". El valor por defecto es "dev". Según el valor elegido, se inyectará automáticamente "development" o "production" en la variable de entorno process.env.NODE_ENV.
-h, --helpMuestra la ayuda del comando

mf dts

mf dts se usa para descargar o generar archivos de declaración de tipos de 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
Nota

El comando mf dts genera o descarga automáticamente los archivos de declaración de tipos según la configuración de module-federation.config.ts. Esto significa que debes proporcionar un archivo de configuración válido; de lo contrario, el comando no se ejecutará correctamente.

Si solo usas la API de runtime, debes crear un archivo module-federation.config.ts temporal, configurar dts.consumeTypes.remoteTypeUrls y, después, ejecutar el comando mf dts.