如何使用 Node.js 和 npm 自动压缩文件

Question

有没有办法在构建时使用 Node.js 和 npm 自动压缩某些文件？

例如，我有一个项目，该文件结构如下所示：

 Project/
--lib/
--node_modules/
--test/
--index.js
--package.json

例如，我希望能够将 lib 文件夹、node_modules 和 index.js 中的某些模块压缩到某个 zip 存档中，以便将其上传到 AWS Lambda。我不需要压缩测试文件夹或测试 Node.js 模块（mocha 和 chai）。我什至创建了一个用于生成 zip 文件的 bash 脚本，但是有没有办法在调用“npm install”时自动执行这个脚本？

这应该是一个标准问题，它应该有一个标准的解决方案，但我无法发现。

更新

感谢 michael，决定使用 gulp。这是我的脚本，以防其他人需要它用于 AWS Lambda：

 var gulp = require('gulp');
var clean = require('gulp-clean');
var zip = require('gulp-zip');
var merge = require('merge-stream');

gulp.task('clean', function () {
    var build = gulp.src('build', {read: false})
        .pipe(clean());
    var dist = gulp.src('dist', {read: false})
        .pipe(clean());

    return merge(build, dist);
});

gulp.task('build', function() {
    var index = gulp.src('index.js')
        .pipe(gulp.dest('build'));
    var lib = gulp.src('lib/**')
        .pipe(gulp.dest('build/lib'));
    var async = gulp.src('node_modules/async/**')
        .pipe(gulp.dest('build/node_modules/async'));
    var collections = gulp.src('node_modules/collections/**')
        .pipe(gulp.dest('build/node_modules/collections'));
    var underscore = gulp.src('node_modules/underscore/**')
        .pipe(gulp.dest('build/node_modules/underscore'));
    var util = gulp.src('node_modules/util/**')
        .pipe(gulp.dest('build/node_modules/util'));
    var xml2js = gulp.src('node_modules/xml2js/**')
        .pipe(gulp.dest('build/node_modules/xml2js'));

    return merge(index, lib, async, collections, underscore, util, xml2js);
});

gulp.task('zip', ['build'], function() {
    return gulp.src('build/*')
        .pipe(zip('archive.zip'))
        .pipe(gulp.dest('dist'));
});

gulp.task('default', ['zip']);

原文由 Dmitry 发布，翻译遵循 CC BY-SA 4.0 许可协议

Answer 1

我会使用 gulp-sftp、gulp-tar 和 gulp-gzip 以及别名作为命令来使用 gulp。在您的用户主文件夹中创建一个名为 .bash_aliases 的文件，其中包含

alias installAndUpload='npm install && gulp runUploader'

重新启动后，您可以使用此别名同时调用这两个操作。

吞咽文件可能看起来像这样

var gulp = require('gulp');
var watch = require('gulp-watch');
var sftp = require('gulp-sftp');
var gzip = require('gulp-gzip');

gulp.task('runUploader', function () {
    gulp.src('.path/to/folder/to/compress/**')
        .pipe(tar('archive.tar'))
        .pipe(gzip())
        .pipe(gulp.dest('path/to/folder/to/store')) // if you want a local copy
        .pipe(sftp({
            host: 'website.com',
            user: 'johndoe',
            pass: '1234'
        }))
});

当然，您也可以添加 gulp-watch 以自动创建 tar/zip 并在目录发生变化时上传。

原文由 baao 发布，翻译遵循 CC BY-SA 3.0 许可协议

Answer 2

我意识到这个答案对于原始海报来说已经晚了好几年。但我对打包 Lambda 函数有几乎相同的问题，所以为了后代，这里有一个不需要任何额外的 devDependencies（如 gulp 或 grunt）并且只使用 npm pack 以及以下内容的解决方案 package.json （但假设你有 sed 和 zip 可用）：

 {
  "name": "my-lambda",
  "version": "1.0.0",
  "scripts": {
    "postpack": "tarball=$(npm list --depth 0 | sed 's/@/-/g; s/ .*/.tgz/g; 1q;'); tar -tf $tarball | sed 's/^package\\///' | zip -@r package; rm $tarball"
  },
  "files": [
    "/index.js",
    "/lib"
  ],
  "dependencies": {
    "async": "*",
    "collections": "*",
    "underscore": "*",
    "util": "*",
    "xml2js": "*"
  },
  "bundledDependencies": [
    "async",
    "collections",
    "underscore",
    "util",
    "xml2js"
  ],
  "devDependencies": {
    "chai": "*",
    "mocha": "*"
  }
}

给定上述 package.json，调用 npm pack 将生成一个 package.zip 文件，其中包含：

 index.js
lib/
node_modules/
├── async/
├── collections/
├── underscore/
├── util/
└── xml2js/

files 数组是要包含的内容的白名单。在这里，它只是 index.js 和 lib 目录。

However, npm will also automatically include package.json , README (and variants like README.md , CHANGELOG (and its variants), and LICENSE （以及替代拼写 LICENCE ）除非你明确排除它们（例如使用 .npmignore ）。

bundledDependencies 数组指定要捆绑的包。在这种情况下，它是所有依赖项，但不是 devDependencies。

最后， postpack 脚本在 npm pack 之后运行，因为 npm pack 生成一个 tarball，但我们需要为 AWS Lambda 生成一个 zip。

https://hackernoon.com/package-lambda-functions-the-easy-way-with-npm-e38fc14613ba 提供了关于 postpack 脚本正在做什么的更详细解释（也是一般方法的来源） .

原文由 eddies 发布，翻译遵循 CC BY-SA 4.0 许可协议