@tryghost/zip 1.1.15

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013-2021 Ghost Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,50 @@
+# Zip
+
+## Install
+
+`npm install @tryghost/zip --save`
+
+or
+
+`yarn add @tryghost/zip`
+
+
+## Usage
+
+```
+const zip = require('@tryghost/zip');
+
+// Create a zip from a folder
+
+let res = await zip.compress('path/to/a/folder', 'path/to/archive.zip', [options])
+
+// Extract a zip to a folder
+
+let res = await zip.extract('path/to/archive.zip', 'path/to/files', [options])
+```
+
+## Develop
+
+This is a mono repository, managed with [lerna](https://lernajs.io/).
+
+Follow the instructions for the top-level repo.
+1. `git clone` this repo & `cd` into it as usual
+2. Run `yarn` to install top-level dependencies.
+
+
+## Run
+
+- `yarn dev`
+
+
+## Test
+
+- `yarn lint` run just eslint
+- `yarn test` run lint and tests
+
+
+
+
+# Copyright & License
+
+Copyright (c) 2013-2021 Ghost Foundation - Released under the [MIT license](LICENSE).

package/index.js

@@ -0,0 +1,4 @@
+module.exports = {
+    extract: require('./lib/extract'),
+    compress: require('./lib/compress')
+};

package/lib/compress.js

@@ -0,0 +1,54 @@
+const fs = require('fs-extra');
+const Promise = require('bluebird');
+
+const defaultOptions = {
+    type: 'zip',
+    glob: '**/*',
+    dot: true,
+    ignore: ['node_modules/**']
+};
+
+/**
+ * Compress
+ *
+ * - Create a zip file from a folder
+ *
+ * @param {String} folderToZip - full path to the folder to be zipped
+ * @param {String} destination - full path to the resulting zip file
+ * @param {Object} [options]
+ * @param {String} options.type - zip by default see archiver for other options
+ * @param {String} options.glob - the files to include, defaults to all files and folders
+ * @param {Boolean} options.dot - include all dotfiles and dotfolders
+ * @param {Array} options.ignore - any paths that should be ignored, sets node_modules by default
+ *
+ */
+module.exports = (folderToZip, destination, options = {}) => {
+    const opts = Object.assign({}, defaultOptions, options);
+
+    const archiver = require('archiver');
+    const output = fs.createWriteStream(destination);
+    const archive = archiver.create(opts.type);
+
+    return new Promise((resolve, reject) => {
+        // If folder to zip is a symlink, we want to get the target
+        // of the link and zip that instead of zipping the symlink
+        if (fs.lstatSync(folderToZip).isSymbolicLink()) {
+            folderToZip = fs.realpathSync(folderToZip);
+        }
+
+        output.on('close', function () {
+            resolve({path: destination, size: archive.pointer()});
+        });
+
+        archive.on('error', function (err) {
+            reject(err);
+        });
+        archive.glob(opts.glob, {
+            cwd: folderToZip,
+            dot: opts.dot,
+            ignore: opts.ignore
+        });
+        archive.pipe(output);
+        archive.finalize();
+    });
+};

package/lib/extract.js

@@ -0,0 +1,25 @@
+const defaultOptions = {};
+
+/**
+ * Extract
+ *
+ * - Unzip an archive to a folder
+ *
+ * @param {String} zipToExtract - full path to zip file that should be extracted
+ * @param {String} destination - full path of the extraction target
+ * @param {Object} [options]
+ * @param {Integer} options.defaultDirMode - Directory Mode (permissions), defaults to 0o755
+ * @param {Integer} options.defaultFileMode - File Mode (permissions), defaults to 0o644
+ * @param {Function} options.onEntry - if present, will be called with (entry, zipfile) for every entry in the zip
+ */
+module.exports = (zipToExtract, destination, options) => {
+    const opts = Object.assign({}, defaultOptions, options);
+
+    const extract = require('extract-zip');
+
+    opts.dir = destination;
+
+    return extract(zipToExtract, opts).then(() => {
+        return {path: destination};
+    });
+};

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@tryghost/zip",
+  "version": "1.1.15",
+  "repository": "https://github.com/TryGhost/Utils/tree/master/packages/zip",
+  "author": "Ghost Foundation",
+  "license": "MIT",
+  "main": "index.js",
+  "scripts": {
+    "dev": "echo \"Implement me!\"",
+    "test": "NODE_ENV=testing c8 mocha './test/**/*.test.js'",
+    "lint": "eslint . --ext .js --cache",
+    "posttest": "yarn lint"
+  },
+  "files": [
+    "index.js",
+    "lib"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "c8": "7.9.0",
+    "folder-hash": "4.0.1",
+    "mocha": "9.0.0",
+    "should": "13.2.3",
+    "sinon": "11.0.0"
+  },
+  "dependencies": {
+    "archiver": "^4.0.2",
+    "bluebird": "^3.7.2",
+    "extract-zip": "2.0.1",
+    "fs-extra": "^9.1.0"
+  },
+  "gitHead": "9545d13a14c1b0ac70cd80ee111f66f642eb0a4d"
+}