stormrage

gmsoft frontend cli

install

yarn global add stormrage

如果安装后使用提示 stormrage 找不到

1. 执行 yarn global bin
2. 将输出结果加入到操作系统环境变量 path 中

sub-commit

• init 用于根据模板初始化项目
• start [project] 启动调试
• devbuild [project] 启动组件项目开发编译, 用于和 app 的联调
• test [project] 启动测试
• bad | deploy [project] 编译部署
• genapi [project] 生成 api 代码
• doc [project] 启动 doc 调试
• fisinstall | fi [components] 使用 fis3 install 安装项目依赖
• replace [project], 对项目内容进行(二次)替换

usage

stormrage init

option:

• -s, --no-start 生成后不自动启动项目

模板使用了内部的服务器, 请配置你的 hosts 文件:

(stormrage 会尝试自动设置, 如果设置失败, 请手动设置以下规则)

• 192.168.2.10 cdn.gm
• 192.168.2.11 registry.gmsoftdev.com
• 192.168.2.12 registry.gmsofttest.com

stormrage start [project]

project - 指定项目, 未指定时默认为当前目录

option:

• -p, --package <package> react 项目为 mono 仓库时, 指定启动的 package
• --port <port> react 项目启动端口号, 默认 app: 3000, components: 3030
• -o, --output <path> fis 项目的产出目录, 默认为 D:/debug-root, macOS 下为 ~/debug-root
• -c, --clean fis 项目启动调试前, 先清除编译缓存
• --plugin-option <json> fis 项目传递给插件的参数(must be a json)

stormrage devbuild [project]

project - 指定项目, 未指定时默认为当前目录

option:

• --port <port> react 项目启动端口号, 默认 3030
• --pick 选择需要发布的组件, 组件项目有效

stormrage test [project]

project - 指定项目, 未指定时默认为当前目录

option:

• -p, --package <package> react 项目为 mono 仓库时, 指定测试的 package

stormrage bad [project] or stormrage deploy [project]

project - 指定项目, 未指定时默认为当前目录

option:

• -p, --package <package> react 项目为 mono 仓库时, 指定要发布的 package
• -d, --dest <path> 发布结果存放位置, 默认为 d:/发布结果
• --no-doc 不生成组件文档
• --pick 选择需要发布的组件, 组件项目有效
• --svn <url> 通过 svn url 指定需要发布的项目, 优先级高于 [project]
• --no-force-svn-checkout 使用 svn 选项时, 若已有项目缓存, 不执行 checkout 操作, 直接使用缓存
• --env <deployEnv> 指定发布目标环境
• --room <deployRoom> 指定发布目标机房
• --plugin-option <json> fis 项目传递给插件的参数(must be a json)
• --build-script <buildScript> 指定编译脚本, eg: gulp web, config like react project

stormrage genapi [project]

project - 指定项目, 未指定时默认为当前目录

option:

• -p, --package <package> react 项目为 mono 仓库时, 指定需要生成 api 代码的 package

stormrage genmeta [project]

project - 指定项目, 未指定时默认为当前目录

option:

• --pick 选择需要提取元数据的组件

stormrage doc [project]

project - 指定项目, 未指定时默认为当前目录

option:

• -p, --package <package> react 项目为 mono 仓库时, 指定启动的 package
• -b, --build 编译构建产出文档目录
• --env <deployEnv> 指定发布目标环境
• --room <deployRoom> 指定发布目标机房
• --plugin-option <json> 传递给插件的参数(must be a json)

stormrage fisinstall [components] or stormrage fi [components]

components - 需要安装的依赖

option:

• -r, --root <project> 指定项目根目录

stormrage replace [project]

project - 已编译的项目结果

option:

• -c, --conf <path> 指定替换内容的配置(js)文件, 返回一个 object, key 为被替换内容，value 为替换内容。eg: module.export = {"a": "b"};
• -o, --output <output> 指定替换后的项目输出位置(如果路径以.zip结尾，则会输出压缩文件)
• -t, --output-type <outputType> 指定输出格式 dir | zip，如果output未以.zip结尾 默认为 dir

deployInfoConfig

如需配置发布配置拉取url请在项目根目录新增文件 .deployrc schema:

{
  info: infoUrl, // 服务器信息
  shell: shellUrl // 脚本
}

mono项目请在每个子项目中配置

error code

{
  // 解析 plugin-option 失败, 请检查校验是否是合法的json字符串
  PLUGIN_OPTION_ERROR: 1,
  // 拷贝配置文件到发布目录失败
  COPY_MACHINE_CONF_ERROR: 2,
  // 环境对应项目配置文件不存在
  NO_CONF_ERROR: 3,
  // 项目配置文件错误
  CONF_ERROR: 4,
  // 写应用部署信息文件失败
  WRITE_APP_CONF_ERROR: 5,
  // SVN相关操作失败
  SVN_ERROR: 6,
  // REACT_APP_DEPLOY_MACHINES 配置解析失败
  REACT_APP_DEPLOY_MACHINES_ERROR: 7,
  // build错误
  BUILD_ERROR: 8,
  // yarn未安装
  NO_YARN_ERROR: 9,
  // 生成或解压zip文件错误
  ZIP_ERROR: 10,
  // 执行(第三方)命令失败
  RUN_COMMAND_ERROR: 11,
  // 依赖安装错误
  YARN_INSTALL_ERROR: 12,

  // 初始化模板下载失败
  DOWNLOAD_ERROR: 100,
  // 未知错误
  UNKNOWN_ERROR: 10000,
};

fis project

// 通过此插件, 可修改项目配置
// 多个插件的调用模式为 Waterfall, 即每个插件的返回值会传递给下一个插件
const plugin = async context => {
  return context;
};

// readOnly
context : {
    // tool, 命令行交互
    inquirer, 
    // tool, immer 修改配置
    produce, 
    // NODE_ENV
    mode: development | production,
    // 编译的media
    mediaName: env-room, 
    // 命令行传递给插件的参数
    pluginOption,
    config:{
       // plugins: [plugin], // 编译插件
       notUseHash, // 文件名不加hash
       notOptimizeJs, // 不压缩js
       notOptimizeCss, // 不压缩css
       domain, // 项目部署域名(包含子路径)
       pack, // 是否打包
       packConf, // 打包配置
       // 填写额外的忽略文件
       ignoreFiles, 
       vars, // 参数配置
       envs, // 环境变量
       // plugins:［plugin］, // 编译插件
       themeVars, // less 替换变量
       deploy:{
           type: scp | zip | local, // 发布方式
           subPath, // 仅 local 有效
           zipFileNameSubjoin, // 生成的包文件附加名称, 用于同一项目通过代码剪裁生成不同结果时能生成不同名称的zip
           machines: [{
              machine: "machine1",
              where: [{ "rootKey": "nginx.websrc", "path": "/xpath"}]
              }]
          }
    },
}

默认忽略文件列表: https://github.com/gmsoft-happyCoding/stormrage/blob/master/lib/fis-scripts/default-ignore-files.js

webpack project

// 通过此插件, 可修改项目配置
// 多个插件的调用模式为 Waterfall, 即每个插件的返回值会传递给下一个插件
const plugin = async context => {
  return context;
};

// readOnly
context : {
    // tool, 命令行交互
    inquirer, 
    // tool, immer 修改配置
    produce,
    // 命令行传递给插件的参数
    pluginOption, 
    config:{
       envs, // 参数配置(环境变量), read by https://github.com/lorenwest/node-config
       // plugins: [plugin], // 编译插件
    },
}