zipto

zipto是用纯JavaScript编写的。可将目录压缩到对应位置的zip中。可用作库或命令行程序。

安装

请确保已安装Node 10或更高版本。

npm install zipto --save

安装命令行程序:

npm install zipto -g

JS API

const zipto = require('zipto')

zipto({
  dir: 'app',
  out: 'dist',
  name: 'app'
});

Options

• dir (required) - 需要压缩的目录
• name - 压缩后文件名称；默认值：与 dir 同值
• out - 压缩后输出目录; 默认值：dist
• date - 压缩后文件名称时间；
• debug - 开启 debug 模式；默认值：true

CLI Usage

zipto -d <zip-dir> -n <zip-name> -o <zip-out>

• -d,--dir <dir> (required) - 需要压缩的目录
• -n,--name <name> - 压缩后文件名称；默认值：与 dir 同值
• -o,--out <dir> - 压缩后输出目录; 默认值：dist
• --date <format> - 压缩后文件名称时间；
• --no-date - 禁用时间处理；
• --debug - 开启 debug 模式；默认值：true
• --no-debug - 关闭 debug 模式；默认值：false
• -h,--help - 展示 help 信息

Config

/.zipto.js

const {defineConfig} = require('./index');
const dayjs = require("dayjs");
const path = require("node:path");

module.exports = defineConfig({
  dateformat: 'YYYY-MM-DD_HH_mm_ss',
  join: '-',
  name(options, config) {
    return options.name? options.name: options.dir;
  },
  date (options, config) {
    return dayjs().format(config.dateformat);
  },
  output (options, other, config) {
    const {dir} = options;
    const {zip, archive} = other;
    console.log(`
--------- ---------压缩完毕--------- ---------
压缩目录：${path.resolve('.', dir)}
压缩结果：${zip}
生成文件大小 ${(archive.pointer() / 1024 / 1024).toFixed(2)} MB
`);
  }
});

Update

1.3.2

• 移除 npm 仓库的打包测试文件；

1.3.1

• 修复 .zipto.js 中的 date 配置默认不生效的BUG；

1.3.0

• 取消 name 的必填要求（默认与 dir 同值）
• 添加 --no-date 可禁用时间处理函数
• .zipto.js 可分别定制 name 和 date 函数