build_forge_tool

build_forge_tool

build_forge_tool 是一个开发构建辅助工具,目的是在不影响当前项目构建基础上, 实现“打包--构建.zip--git自动管理版本--启动文件服务”的完整流程。

局部安装使用

• 局部安装

  pnpm add build_forge_tool
  

• 在package.json中配置

  {
      ...
      "script":{
          ...
          "test": "bft --exec=app --command=build --mode=test",
          "release": "bft --exec=app --command=build --mode=release",
          "share": "bft --exec=share",
      }
      ...
  }
  

• 使用

  pnpm test
  

全局安装使用

• 安装

  pnpm add build_forge_tool -g
  

• 使用

  bft --exec=share
  

运行参数 格式: name short type description default

• version v 获取版本信息
• help h 获取帮助信息
• exec e 要运行的指令
  • app 构建应用
    • command string 运行方式 build | serve
    • mode m string 模式 test | release
    • version v string 版本号 默认: process.env.~APP_VERSION
    • zip z boolean 是否生成zip 默认: false
    • upgrade u boolean 是否升级package.json版本 默认: false
    • git-commit c boolean 是否提交git 默认: false
    • git-tag t boolean 是否生成tag 默认: false
    • git-push p boolean 是否推送远程 默认: false
    • debug p boolean 是否开户控制台调试 默认: false
  • work 构建工作区
    • name 应用名称，多应用使用“;”分隔 string
    • root 多应用根目录，多目录使用“;”分隔 string 默认: apps
    • command string 运行方式 build | serve
  • share 运行一个文件分享服务
    • port p string 端口号 默认: process.env.APP_ROOT+1000
    • input i string 输入 默认: process.env.APP_ROOT/.zip
  • zip 将构建产物打包为.zip文件 { filePath: string }
    • mode m string 模式 test | release
    • name n string 名称, 默认: process.env.~APP_NAME
    • version v string 版本, 默认: process.env.~APP_VERSION
    • input i string 输入, 默认: process.env.APP_ROOT/dist
    • output o string 输出, 默认: process.env.APP_ROOT/.zip
  • upgrade 升级package.json版本号 { version: string }
    • mode m string 模式 test | release
    • version v string 版本, 默认: process.env.~APP_VERSION
    • root r string package.json所在根目录, 默认: process.env.APP_ROOT

环境变量

• ENV_PATH 额外的加载地址
• ENV_PREFIX 自定义的环境变量前缀 其它环境变量使用到此前缀时将使用~指代 默认: BFT_
• ~APP_NAME 名称 默认: npm_package_name
• ~APP_TITLE 标题 默认: npm_package_config_title
• ~APP_VERSION 版本号 默认: 以npm_package_version为依据, 根据mode参数动态设置
• APP_ROOT 应用根目录 默认: process.cwd()
• APP_PORT 应用根目录 默认: npm_package_config_port
• APP_BUILD_COMMAND 构建应用运行命令 默认: pnpm build
• APP_SERVE_COMMAND 启动应用服务运行命令 默认: pnpm serve