@goldstack/utils-sh - npm Package Compare versions

Comparing version 0.1.30 to 0.1.31

dist/utilsSh.d.ts

@@ -13,2 +13,13 @@ import sh from 'shelljs';
 export declare const mkdir: (options: string, ...dir: string[]) => void;
+export declare const zip: (params: {
+    directory: string;
+    target: string;
+}) => Promise<void>;
+/**
+ * Unzips a zip file into directly into a directory.
+ */
+export declare const unzip: (params: {
+    file: string;
+    targetDirectory: string;
+}) => Promise<void>;
 declare const exec: (cmd: string, params?: ExecParams | undefined) => string;
@@ -15,0 +26,0 @@ declare const read: (path: string) => string;

dist/utilsSh.js

@@ -61,3 +61,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cd = exports.sh = exports.write = exports.read = exports.pwd = exports.exec = exports.mkdir = exports.rm = exports.rmSafe = exports.cp = exports.copy = void 0;
+exports.cd = exports.sh = exports.write = exports.read = exports.pwd = exports.exec = exports.unzip = exports.zip = exports.mkdir = exports.rm = exports.rmSafe = exports.cp = exports.copy = void 0;
 var shelljs_1 = __importStar(require("shelljs"));
@@ -69,2 +69,4 @@ exports.sh = shelljs_1.default;
 var rimraf_1 = __importDefault(require("rimraf"));
+var archiver_1 = __importDefault(require("archiver"));
+var extract_zip_1 = __importDefault(require("extract-zip"));
 exports.copy = function (source, dest) { return __awaiter(void 0, void 0, void 0, function () {
@@ -207,2 +209,43 @@ var sourceArr, _loop_1, _i, sourceArr_1, sourceEl;
 };
+exports.zip = function (params) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, new Promise(function (resolve, reject) {
+                    var output = fs_1.default.createWriteStream(params.target);
+                    var archive = archiver_1.default('zip', {
+                        zlib: { level: 9 },
+                    });
+                    archive.on('warning', function (err) {
+                        console.warn(err.message);
+                    });
+                    output.on('finish', function () {
+                        resolve();
+                    });
+                    output.on('error', reject);
+                    // pipe archive data to the file
+                    archive.pipe(output);
+                    archive.directory(params.directory, false);
+                    archive.finalize();
+                })];
+            case 1:
+                _a.sent();
+                return [2 /*return*/];
+        }
+    });
+}); };
+/**
+ * Unzips a zip file into directly into a directory.
+ */
+exports.unzip = function (params) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, extract_zip_1.default(params.file, {
+                    dir: path_1.default.resolve(params.targetDirectory),
+                })];
+            case 1:
+                _a.sent();
+                return [2 /*return*/];
+        }
+    });
+}); };
 var exec = function (cmd, params) {
@@ -209,0 +252,0 @@ var res = shelljs_1.default.exec(cmd, { silent: params === null || params === void 0 ? void 0 : params.silent });

package.json

 {
   "name": "@goldstack/utils-sh",
-  "version": "0.1.30",
+  "version": "0.1.31",
   "license": "MIT",
@@ -23,2 +23,4 @@ "author": "Max Rohde",
     "@goldstack/utils-log": "0.1.35",
+    "archiver": "^5.0.0",
+    "extract-zip": "^2.0.1",
     "ncp": "^2.0.0",
@@ -30,2 +32,3 @@ "rimraf": "^3.0.2",
     "@goldstack/utils-git": "0.1.21",
+    "@types/archiver": "^3.1.0",
     "@types/jest": "^25.2.3",
@@ -32,0 +35,0 @@ "@types/ncp": "^2.0.4",

No alert changes

Improved metrics

Total package byte prevSize

26845

13.79%

Lines of code

391

16.02%

Worsened metrics

Dependency count

6

50%

Dev dependency count

10

11.11%

Dependency changes

• + Added

  archiver@^5.0.0

• + Added

  extract-zip@^2.0.1

• + Added

  @types/node@24.0.10
  (transitive)

• + Added

  @types/yauzl@2.10.3
  (transitive)

• + Added

  archiver@5.3.2
  (transitive)

• + Added

  archiver-utils@2.1.03.0.4
  (transitive)

• + Added

  async@3.2.6
  (transitive)

• + Added

  base64-js@1.5.1
  (transitive)

• + Added

  bl@4.1.0
  (transitive)

• + Added

  brace-expansion@2.0.2
  (transitive)

• + Added

  buffer@5.7.1
  (transitive)

• + Added

  buffer-crc32@0.2.13
  (transitive)

• + Added

  compress-commons@4.1.2
  (transitive)

• + Added

  core-util-is@1.0.3
  (transitive)

• + Added

  crc-32@1.2.2
  (transitive)

• + Added

  crc32-stream@4.0.3
  (transitive)

• + Added

  debug@4.4.1
  (transitive)

• + Added

  end-of-stream@1.4.5
  (transitive)

• + Added

  extract-zip@2.0.1
  (transitive)

• + Added

  fd-slicer@1.1.0
  (transitive)

• + Added

  fs-constants@1.0.0
  (transitive)

• + Added

  get-stream@5.2.0
  (transitive)

• + Added

  graceful-fs@4.2.11
  (transitive)

• + Added

  ieee754@1.2.1
  (transitive)

• + Added

  isarray@1.0.0
  (transitive)

• + Added

  lazystream@1.0.1
  (transitive)

• + Added

  lodash.defaults@4.2.0
  (transitive)

• + Added

  lodash.difference@4.5.0
  (transitive)

• + Added

  lodash.flatten@4.4.0
  (transitive)

• + Added

  lodash.isplainobject@4.0.6
  (transitive)

• + Added

  lodash.union@4.6.0
  (transitive)

• + Added

  minimatch@5.1.6
  (transitive)

• + Added

  ms@2.1.3
  (transitive)

• + Added

  normalize-path@3.0.0
  (transitive)

• + Added

  pend@1.2.0
  (transitive)

• + Added

  process-nextick-args@2.0.1
  (transitive)

• + Added

  pump@3.0.3
  (transitive)

• + Added

  readable-stream@2.3.83.6.2
  (transitive)

• + Added

  readdir-glob@1.1.3
  (transitive)

• + Added

  safe-buffer@5.1.2
  (transitive)

• + Added

  string_decoder@1.1.1
  (transitive)

• + Added

  tar-stream@2.2.0
  (transitive)

• + Added

  undici-types@7.8.0
  (transitive)

• + Added

  util-deprecate@1.0.2
  (transitive)

• + Added

  yauzl@2.10.0
  (transitive)

• + Added

  zip-stream@4.1.1
  (transitive)