@yolanda-qn/incpack-cli v1.1.1

@yolanda-qn/incpack-cli

对前端构建结果进行增量式文件打包处理

安装

yarn add @yolanda-qn/incpack-cli -D

命令

Usage: @yolanda-qn/incpack-cli <command> [options]

命令：
  incpack-cli init                      初始化一个 incpack.config.js 和 .incpack
                                        目录
  incpack-cli compare <current> <last>  比较 <current> 和 <last> 文件记录

选项：
      --project-dir    项目目录。默认 process.cwd()                     [字符串]
      --work-dir       工作目录。默认 .incpack     [字符串] [默认值: ".incpack"]
      --files          目标文件。glob路径。         [字符串] [默认值: "dist/**"]
  -T, --files-table    文件大小分析结果txt文件名(不需要填写文件后缀)。可使用：{d
                       ate} 作为日期 YYYY_MM_DD 占位符；{datetime} 作为
                       YYYY_MM_DD_HH_mm_ss 占位符；{version}
                       作为当前项目版本号，为所在项目下的 package.json
                       中的version字段。          [字符串] [默认值: "{version}"]
      --ignore-commit  是否提交至git。（为true会对filesTable添加.ignore后缀）
                                                          [布尔] [默认值: false]
      --md-name        分析结果markdown文件名（不需要填写文件后缀）。可使用：{da
                       te} 作为日期 YYYY_MM_DD 占位符；{datetime} 作为
                       YYYY_MM_DD_HH_mm_ss 占位符；{version}
                       作为当前项目版本号，为所在项目下的 package.json
                       中的version字段。  [字符串] [默认值: "{version}-analyze"]
      --md             是否生成比较结果的markdown文件     [布尔] [默认值: false]
      --compare-with   要比较的文件分析记录.txt(不要填写文件后缀)。默认目录为
                       workDir, 如果路径为绝对路径例如 / 开头，那么目录为
                       projectDir                          [字符串] [默认值: ""]
      --zip            是否压缩为zip文件                   [布尔] [默认值: true]
      --zip-name       压缩为zip的文件名(不要填写文件后缀)。可使用：{date}
                       作为日期 YYYY_MM_DD 占位符；{datetime} 作为
                       YYYY_MM_DD_HH_mm_ss 占位符；{version}
                       作为当前项目版本号，为所在项目下的 package.json
                       中的version字段。          [字符串] [默认值: "{version}"]
      --zip-root-dir   压缩为zip文件时，相对于根目录路径。例如，指定 files 为
                       dist/h5/**，最后想要的zip包结构 h5
                       为顶级目录。那么这里就设定为 dist [字符串] [默认值: ""]
  -C, --config         配置文件。默认为当前目录下的 incpack.config.js
                                                           [字符串] [默认值: ""]
      --help           显示帮助信息                                       [布尔]
      --version        显示版本号                                         [布尔]

在项目的 package.json 中添加如下指令

{
  "scripts": {
    "incpack": "incpack-cli"
  }
}

初始化

yarn incpack init

会在当前项目根目录下生成一个 incpack.config.js 默认配置和 .incpack 工作目录 可通过 --project-dir 和 --work-dir 来指定项目目录和文件记录存放目录

生成记录

yarn incpack

根据 incpack.config.js 配置，扫描对应目录文件（默认为dist目录），然后在 .incpack 目录生成对应的版本文件记录，例如 1.0.0.txt，此文件应该提交到git以便下个版本进行比较。如果指定了 zip 则生成对应的zip文件。

生成差异记录

可在config文件中指定要比较的记录文件名。 示例：

{ compareWith: '1.0.0' }

另一种方式使用是命令行参数（推荐）

yarn incpack --compare-with 1.0.0

如果开启了 zip 参数那么只会打包新增和有变动的文件

单独比较两个文件记录

compare 当前版本文件记录 上一个版本文件记录

示例

yarn incpack compare 1.1.0 1.0.0

会在.incpack目录生成一个差异化记录的markdown文件