search

uioz / mfe-proxy-cli

MIT License
0 stars 0 forks source link

功能命令设计 #9

Open uioz opened 3 years ago

uioz commented 3 years ago

创建项目

mfe-proxy-cli create <project-name(aka. folder)> [packageName...]

特点:

添加项目

mfe-proxy-cli install [packageName...]

特点

移除项目

mfe-proxy-cli remove [packageName...]

特点

manifest 生成

mfe-proxy-cli generate manifest [packageName...]

特点

初始化已有的 mfe 项目

mfe 项目是指一个 npm package, 其所依赖的模块都是可以被 mfe-proxy-cli 所处理的.

另外如果直接使用 npm install 一个 mfe 项目, 内容会被安装到 node_modules 目录中而 init 命令不会这样做.

mfe-proxy-cli init <project name> <packageName>

特点

uioz commented 3 years ago

create 命令

语法:

Usage: index create [options] <projectName> <packageName...>

packageName 支持全部 npm install 所支持的包类型.
packageName 也支持 [packageName]<registry> 语法为了给每个包指定 registry.
例如: eg. [@vue/cli]<http://localhost:8080>

Arguments:
  projectName                    创建项目所使用的目录名称
  packageName                  用于交付给 npm install 所使用的包名称.

Options:
  -n, --to-npm <anyoption...>  跟随的所有选项都会交由 npm install 命令
  -m, --manifest-name <name>   指定一个名称用于生成 manifest 文件
  --no-manifest                当命令执行完成后不生成 manifest 文件
  -S, --serve                 当安装完成后启动 mfe-proxy-server
  -P, --port <port>                 mfe-proxy-server 监听的端口(默认 80)
  -H, --host <host>                mfe-proxy-server 监听的地址(默认 0.0.0.0)
  -M, --mode <mode>                mfe-proxy-server 运行模式(默认值由 mfe-proxy-server 决定)
  -h, --help                   display help for command
uioz commented 3 years ago

server-install 命令

说明:

Usage: index server-install [options]

this command will install mfe-proxy-server and configures it with options

Options:
  -S, --serve        immediately serving this project use mfe-proxy-server after installed (default: false)
  -i, --inject       to inject serve command in packageJson (default: false)
  -P, --port <port>  mfe-proxy-server port (80 by default)
  -H, --host <host>  mfe-proxy-server host (0.0.0.0 by default)
  -M, --mode <mode>  development or production (production by default)
  -h, --help         display help for command
uioz commented 3 years ago

update 命令

类似于 npm update 命令, 但是不会去更新那些不在 manifest 中的 package, 即使手动指定.

注意: --to-npm --registry <registry> 将会被manifest中所记录的registry覆盖, 如果需要特殊配置请通过npm来手动处理这已经超出了update` 的设计初衷.

说明:

Usage: index update [options] [<pkg>...]

this command will only update the "mfe" package which has a "mfe-config.js" in its project folder

Options:
  -m, --manifest <manifest>    to specify a manifest file (default: "mfe-manifest.json")
  -n, --to-npm <anyoption...>
  -h, --help                   display help for command