@sap-ux/environment-check 0.13.0 → 0.14.0

package/dist/archive/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Archive a project to zip file. Result file is written to parent of the project root folder.
+ *
+ * @param projectRoot - root of the project, where package.json is located
+ * @param targetFileName - optional file name, defaults to project folder + timestamp + .zip
+ */
+export declare function archiveProject(projectRoot: string, targetFileName?: string): Promise<{
+    path: string;
+    size: string;
+}>;
+//# sourceMappingURL=index.d.ts.map

package/dist/archive/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/archive/index.ts"],"names":[],"mappings":"AAQA;;;;;GAKG;AACH,wBAAsB,cAAc,CAChC,WAAW,EAAE,MAAM,EACnB,cAAc,CAAC,EAAE,MAAM,GACxB,OAAO,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,CAiCzC"}

package/dist/archive/index.js

@@ -0,0 +1,111 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.archiveProject = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const archiver = __importStar(require("archiver"));
+const glob_gitignore_1 = require("glob-gitignore");
+const ignore_1 = __importDefault(require("ignore"));
+const i18n_1 = require("../i18n");
+const formatter_1 = require("../formatter");
+/**
+ * Archive a project to zip file. Result file is written to parent of the project root folder.
+ *
+ * @param projectRoot - root of the project, where package.json is located
+ * @param targetFileName - optional file name, defaults to project folder + timestamp + .zip
+ */
+function archiveProject(projectRoot, targetFileName) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!fs_1.existsSync(projectRoot)) {
+            return Promise.reject(new Error(i18n_1.t('error.noProjectRoot', { projectRoot })));
+        }
+        const fileList = yield getFileList(projectRoot);
+        return new Promise((resolve, reject) => {
+            try {
+                const zip = archiver.default('zip', { zlib: { level: 9 } });
+                let targetName = '';
+                if (typeof targetFileName === 'string') {
+                    targetName = targetFileName.toLocaleLowerCase().endsWith('.zip')
+                        ? targetFileName
+                        : targetFileName + '.zip';
+                }
+                else {
+                    targetName = `${path_1.basename(projectRoot)}-${new Date()
+                        .toISOString()
+                        .replace('T', '')
+                        .replace(':', '')
+                        .substring(0, 14)}.zip`;
+                }
+                const targetPath = path_1.join(path_1.dirname(projectRoot), targetName);
+                const writeStream = fs_1.createWriteStream(targetPath);
+                zip.pipe(writeStream);
+                zip.on('error', (error) => reject(error));
+                for (const file of fileList) {
+                    zip.file(path_1.join(projectRoot, file), { name: file });
+                }
+                writeStream.on('close', () => resolve({ path: targetPath, size: formatter_1.byteNumberToSizeString(zip.pointer()) }));
+                zip.finalize();
+            }
+            catch (error) {
+                reject(error);
+            }
+        });
+    });
+}
+exports.archiveProject = archiveProject;
+/**
+ * Get list of files to be added to archive. Depending on the existence of file {cwd}/.gitignore, we use either a default filter
+ * or the .gitignore content.
+ *
+ * @param cwd - working directory, usually the project root
+ * @returns - list of files to add to the archive, relative to cwd
+ */
+function getFileList(cwd) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const gitignorePath = path_1.join(cwd, '.gitignore');
+        const hasGitignore = fs_1.existsSync(gitignorePath);
+        const globPattern = hasGitignore ? ['**'] : ['**', '.cdsrc.json', '.extconfig.json'];
+        const dot = hasGitignore;
+        const ignores = hasGitignore ? (yield fs_1.promises.readFile(gitignorePath)).toString() : ['**/.env', '**/node_modules'];
+        const skip = hasGitignore ? undefined : ['**/node_modules/**'];
+        const files = yield glob_gitignore_1.glob(globPattern, {
+            cwd,
+            dot,
+            ignore: ignore_1.default().add(ignores),
+            skip
+        });
+        return files;
+    });
+}
+//# sourceMappingURL=index.js.map

package/dist/archive/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/archive/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2BAA6D;AAC7D,+BAA+C;AAC/C,mDAAqC;AACrC,mDAAsC;AACtC,oDAA4B;AAC5B,kCAA4B;AAC5B,4CAAsD;AAEtD;;;;;GAKG;AACH,SAAsB,cAAc,CAChC,WAAmB,EACnB,cAAuB;;QAEvB,IAAI,CAAC,eAAU,CAAC,WAAW,CAAC,EAAE;YAC1B,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,QAAC,CAAC,qBAAqB,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;SAC/E;QACD,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,WAAW,CAAC,CAAC;QAChD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI;gBACA,MAAM,GAAG,GAAG,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;gBAC5D,IAAI,UAAU,GAAG,EAAE,CAAC;gBACpB,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE;oBACpC,UAAU,GAAG,cAAc,CAAC,iBAAiB,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC;wBAC5D,CAAC,CAAC,cAAc;wBAChB,CAAC,CAAC,cAAc,GAAG,MAAM,CAAC;iBACjC;qBAAM;oBACH,UAAU,GAAG,GAAG,eAAQ,CAAC,WAAW,CAAC,IAAI,IAAI,IAAI,EAAE;yBAC9C,WAAW,EAAE;yBACb,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC;yBAChB,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC;yBAChB,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC;iBAC/B;gBACD,MAAM,UAAU,GAAG,WAAI,CAAC,cAAO,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC,CAAC;gBAC1D,MAAM,WAAW,GAAG,sBAAiB,CAAC,UAAU,CAAC,CAAC;gBAClD,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBACtB,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;gBAC1C,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE;oBACzB,GAAG,CAAC,IAAI,CAAC,WAAI,CAAC,WAAW,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;iBACrD;gBACD,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,kCAAsB,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC1G,GAAG,CAAC,QAAQ,EAAE,CAAC;aAClB;YAAC,OAAO,KAAK,EAAE;gBACZ,MAAM,CAAC,KAAK,CAAC,CAAC;aACjB;QACL,CAAC,CAAC,CAAC;IACP,CAAC;CAAA;AApCD,wCAoCC;AAED;;;;;;GAMG;AACH,SAAe,WAAW,CAAC,GAAW;;QAClC,MAAM,aAAa,GAAG,WAAI,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;QAC9C,MAAM,YAAY,GAAG,eAAU,CAAC,aAAa,CAAC,CAAC;QAC/C,MAAM,WAAW,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,aAAa,EAAE,iBAAiB,CAAC,CAAC;QACrF,MAAM,GAAG,GAAG,YAAY,CAAC;QACzB,MAAM,OAAO,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,MAAM,aAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;QACpH,MAAM,IAAI,GAAG,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC;QAE/D,MAAM,KAAK,GAAG,MAAM,qBAAI,CAAC,WAAW,EAAE;YAClC,GAAG;YACH,GAAG;YACH,MAAM,EAAE,gBAAM,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC;YAC7B,IAAI;SACP,CAAC,CAAC;QACH,OAAO,KAAK,CAAC;IACjB,CAAC;CAAA"}

package/dist/formatter.d.ts

@@ -21,4 +21,11 @@ export declare function getServiceCountText(count: number): string;
  * @returns - replacer that replaces circular structures
  */
 export declare function getCircularReplacer(): (key: string, value: any) => any;
+/**
+ * Convert an int byte number to a nice output format like 1.23 KB.
+ *
+ * @param byteNumber - int number of bytes
+ * @returns output string
+ */
+export declare function byteNumberToSizeString(byteNumber: number): string;
 //# sourceMappingURL=formatter.d.ts.map

package/dist/formatter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formatter.d.ts","sourceRoot":"","sources":["../src/formatter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAEhE;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,CAAC,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAMhF;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,UAEhD;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,GAAG,CAWtE"}
+{"version":3,"file":"formatter.d.ts","sourceRoot":"","sources":["../src/formatter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAEhE;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,CAAC,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAMhF;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,UAEhD;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,GAAG,CAWtE;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAOjE"}

package/dist/formatter.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCircularReplacer = exports.getServiceCountText = exports.countNumberOfServices = void 0;
+exports.byteNumberToSizeString = exports.getCircularReplacer = exports.getServiceCountText = exports.countNumberOfServices = void 0;
 /**
  * Count the number of services from the result of a catalog call.
  *
@@ -45,4 +45,19 @@ function getCircularReplacer() {
     };
 }
 exports.getCircularReplacer = getCircularReplacer;
+/**
+ * Convert an int byte number to a nice output format like 1.23 KB.
+ *
+ * @param byteNumber - int number of bytes
+ * @returns output string
+ */
+function byteNumberToSizeString(byteNumber) {
+    if (byteNumber === 0) {
+        return '0 Bytes';
+    }
+    const units = ['Bytes', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];
+    const i = Math.floor(Math.log(byteNumber) / Math.log(1024));
+    return `${parseFloat((byteNumber / Math.pow(1024, i)).toFixed(2))} ${units[i]}`;
+}
+exports.byteNumberToSizeString = byteNumberToSizeString;
 //# sourceMappingURL=formatter.js.map

package/dist/formatter.js.map

@@ -1 +1 @@
-{"version":3,"file":"formatter.js","sourceRoot":"","sources":["../src/formatter.ts"],"names":[],"mappings":";;;AAEA;;;;;GAKG;AACH,SAAgB,qBAAqB,CAAC,aAAkC;IACpE,IAAI,cAAc,GAAG,CAAC,CAAC;IACvB,IAAI,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;QAC9B,cAAc,GAAG,aAAa,CAAC,MAAM,CAAC;KACzC;IACD,OAAO,cAAc,CAAC;AAC1B,CAAC;AAND,sDAMC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,KAAa;IAC7C,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,WAAW,CAAC;AAClE,CAAC;AAFD,kDAEC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB;IAC/B,MAAM,IAAI,GAAG,IAAI,OAAO,EAAE,CAAC;IAC3B,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;QAClB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE;YAC7C,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;gBACjB,OAAO,sBAAsB,CAAC;aACjC;YACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;SACnB;QACD,OAAO,KAAK,CAAC;IACjB,CAAC,CAAC;AACN,CAAC;AAXD,kDAWC"}
+{"version":3,"file":"formatter.js","sourceRoot":"","sources":["../src/formatter.ts"],"names":[],"mappings":";;;AAEA;;;;;GAKG;AACH,SAAgB,qBAAqB,CAAC,aAAkC;IACpE,IAAI,cAAc,GAAG,CAAC,CAAC;IACvB,IAAI,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;QAC9B,cAAc,GAAG,aAAa,CAAC,MAAM,CAAC;KACzC;IACD,OAAO,cAAc,CAAC;AAC1B,CAAC;AAND,sDAMC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,KAAa;IAC7C,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,WAAW,CAAC;AAClE,CAAC;AAFD,kDAEC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB;IAC/B,MAAM,IAAI,GAAG,IAAI,OAAO,EAAE,CAAC;IAC3B,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;QAClB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE;YAC7C,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;gBACjB,OAAO,sBAAsB,CAAC;aACjC;YACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;SACnB;QACD,OAAO,KAAK,CAAC;IACjB,CAAC,CAAC;AACN,CAAC;AAXD,kDAWC;AAED;;;;;GAKG;AACH,SAAgB,sBAAsB,CAAC,UAAkB;IACrD,IAAI,UAAU,KAAK,CAAC,EAAE;QAClB,OAAO,SAAS,CAAC;KACpB;IACD,MAAM,KAAK,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACxE,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IAC5D,OAAO,GAAG,UAAU,CAAC,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;AACpF,CAAC;AAPD,wDAOC"}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './types';
 export * from './checks';
-export { convertResultsToMarkdown, storeResultsZip, archiveProject, convertResultsToString } from './output';
+export { convertResultsToMarkdown, storeResultsZip, convertResultsToString } from './output';
+export { archiveProject } from './archive';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,OAAO,EAAE,wBAAwB,EAAE,eAAe,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,OAAO,EAAE,wBAAwB,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAC;AAC7F,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC"}

package/dist/index.js

@@ -10,12 +10,13 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertResultsToString = exports.archiveProject = exports.storeResultsZip = exports.convertResultsToMarkdown = void 0;
+exports.archiveProject = exports.convertResultsToString = exports.storeResultsZip = exports.convertResultsToMarkdown = void 0;
 __exportStar(require("./types"), exports);
 __exportStar(require("./checks"), exports);
 var output_1 = require("./output");
 Object.defineProperty(exports, "convertResultsToMarkdown", { enumerable: true, get: function () { return output_1.convertResultsToMarkdown; } });
 Object.defineProperty(exports, "storeResultsZip", { enumerable: true, get: function () { return output_1.storeResultsZip; } });
-Object.defineProperty(exports, "archiveProject", { enumerable: true, get: function () { return output_1.archiveProject; } });
 Object.defineProperty(exports, "convertResultsToString", { enumerable: true, get: function () { return output_1.convertResultsToString; } });
+var archive_1 = require("./archive");
+Object.defineProperty(exports, "archiveProject", { enumerable: true, get: function () { return archive_1.archiveProject; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,0CAAwB;AACxB,2CAAyB;AACzB,mCAA6G;AAApG,kHAAA,wBAAwB,OAAA;AAAE,yGAAA,eAAe,OAAA;AAAE,wGAAA,cAAc,OAAA;AAAE,gHAAA,sBAAsB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,0CAAwB;AACxB,2CAAyB;AACzB,mCAA6F;AAApF,kHAAA,wBAAwB,OAAA;AAAE,yGAAA,eAAe,OAAA;AAAE,gHAAA,sBAAsB,OAAA;AAC1E,qCAA2C;AAAlC,yGAAA,cAAc,OAAA"}

package/dist/output/zip.d.ts

@@ -6,14 +6,4 @@ import type { EnvironmentCheckResult } from '../types';
  * @param targetFile - path and filename of target zip archive. Default is 'envcheck-results.zip'.
  */
 export declare function storeResultsZip(results: EnvironmentCheckResult, targetFile?: string): void;
-/**
- * Archive a project to zip file. Result file is written to parent of the project root folder.
- *
- * @param projectRoot - root of the project, where package.json is located
- * @param targetFileName - optional file name, defaults to project folder + timestamp + .zip
- */
-export declare function archiveProject(projectRoot: string, targetFileName?: string): Promise<{
-    path: string;
-    size: string;
-}>;
 //# sourceMappingURL=zip.d.ts.map

package/dist/output/zip.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"zip.d.ts","sourceRoot":"","sources":["../../src/output/zip.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAC;AAkBvD;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,sBAAsB,EAAE,UAAU,SAAyB,GAAG,IAAI,CA0B1G;AAED;;;;;GAKG;AACH,wBAAsB,cAAc,CAChC,WAAW,EAAE,MAAM,EACnB,cAAc,CAAC,EAAE,MAAM,GACxB,OAAO,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,CA2CzC"}
+{"version":3,"file":"zip.d.ts","sourceRoot":"","sources":["../../src/output/zip.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAC;AAIvD;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,sBAAsB,EAAE,UAAU,SAAyB,GAAG,IAAI,CA0B1G"}

package/dist/output/zip.js

@@ -18,36 +18,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.archiveProject = exports.storeResultsZip = void 0;
+exports.storeResultsZip = void 0;
 const fs_1 = require("fs");
-const path_1 = require("path");
 const archiver = __importStar(require("archiver"));
+const formatter_1 = require("../formatter");
 const markdown_1 = require("./markdown");
-const i18n_1 = require("../i18n");
-/**
- * Convert a int byte number to a nice output format like 1.23 KB.
- *
- * @param byteNumber - int number of bytes
- * @returns output string
- */
-function byteNumberToSizeString(byteNumber) {
-    if (byteNumber === 0) {
-        return '0 Bytes';
-    }
-    const units = ['Bytes', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];
-    const i = Math.floor(Math.log(byteNumber) / Math.log(1024));
-    return `${parseFloat((byteNumber / Math.pow(1024, i)).toFixed(2))} ${units[i]}`;
-}
 /**
  * Store output results to zip archive. This includes the markdown report and the raw JSON.
  *
@@ -58,7 +34,7 @@ function storeResultsZip(results, targetFile = 'envcheck-results.zip') {
     const zip = archiver.default('zip', { zlib: { level: 9 } });
     const writeStream = fs_1.createWriteStream(targetFile);
     writeStream.on('close', () => {
-        console.log(`Results written to file '${targetFile}' ${byteNumberToSizeString(zip.pointer())}`);
+        console.log(`Results written to file '${targetFile}' ${formatter_1.byteNumberToSizeString(zip.pointer())}`);
     });
     zip.on('warning', (error) => {
         if (error.code === 'ENOENT') {
@@ -80,58 +56,4 @@ function storeResultsZip(results, targetFile = 'envcheck-results.zip') {
     zip.finalize();
 }
 exports.storeResultsZip = storeResultsZip;
-/**
- * Archive a project to zip file. Result file is written to parent of the project root folder.
- *
- * @param projectRoot - root of the project, where package.json is located
- * @param targetFileName - optional file name, defaults to project folder + timestamp + .zip
- */
-function archiveProject(projectRoot, targetFileName) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return new Promise((resolve, reject) => {
-            if (fs_1.existsSync(projectRoot)) {
-                try {
-                    const zip = archiver.default('zip', { zlib: { level: 9 } });
-                    let targetName = '';
-                    if (typeof targetFileName === 'string') {
-                        targetName = targetFileName.toLocaleLowerCase().endsWith('.zip')
-                            ? targetFileName
-                            : targetFileName + '.zip';
-                    }
-                    else {
-                        targetName = `${path_1.basename(projectRoot)}-${new Date()
-                            .toISOString()
-                            .replace('T', '')
-                            .replace(':', '')
-                            .substring(0, 14)}.zip`;
-                    }
-                    const targetPath = path_1.join(path_1.dirname(projectRoot), targetName);
-                    const writeStream = fs_1.createWriteStream(targetPath);
-                    // To define which files to include/exclude archiver uses node-readdir-glob. If we use
-                    // ignore: ['**/node_modules/**', '**/.env'] here it takes time, as ignore still enters directories.
-                    // Using skip instead, which is way faster because directories are skipped completely in this
-                    // case (https://github.com/yqnn/node-readdir-glob#options). Unfortunately, @types/glob -> IOptions
-                    // hasn't skip defined. It works as it is supported by node-readdir-glob. Define it here as 'unknown'
-                    const globOptions = {
-                        cwd: projectRoot,
-                        ignore: ['**/.env', '**/node_modules'],
-                        skip: ['**/node_modules/**']
-                    };
-                    zip.glob('**', globOptions, {})
-                        .on('error', (error) => reject(error))
-                        .pipe(writeStream);
-                    writeStream.on('close', () => resolve({ path: targetPath, size: byteNumberToSizeString(zip.pointer()) }));
-                    zip.finalize();
-                }
-                catch (error) {
-                    reject(error);
-                }
-            }
-            else {
-                reject(new Error(i18n_1.t('error.noProjectRoot', { projectRoot })));
-            }
-        });
-    });
-}
-exports.archiveProject = archiveProject;
 //# sourceMappingURL=zip.js.map

package/dist/output/zip.js.map

@@ -1 +1 @@
-{"version":3,"file":"zip.js","sourceRoot":"","sources":["../../src/output/zip.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2BAAmD;AACnD,+BAA+C;AAC/C,mDAAqC;AAErC,yCAAsD;AACtD,kCAA4B;AAC5B;;;;;GAKG;AACH,SAAS,sBAAsB,CAAC,UAAkB;IAC9C,IAAI,UAAU,KAAK,CAAC,EAAE;QAClB,OAAO,SAAS,CAAC;KACpB;IACD,MAAM,KAAK,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACxE,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IAC5D,OAAO,GAAG,UAAU,CAAC,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;AACpF,CAAC;AAED;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,OAA+B,EAAE,UAAU,GAAG,sBAAsB;IAChG,MAAM,GAAG,GAAG,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAC5D,MAAM,WAAW,GAAG,sBAAiB,CAAC,UAAU,CAAC,CAAC;IAClD,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;QACzB,OAAO,CAAC,GAAG,CAAC,4BAA4B,UAAU,KAAK,sBAAsB,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;IACpG,CAAC,CAAC,CAAC;IACH,GAAG,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE;QACxB,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;YACzB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACvB;aAAM;YACH,MAAM,KAAK,CAAC;SACf;IACL,CAAC,CAAC,CAAC;IACH,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;QACtB,MAAM,KAAK,CAAC;IAChB,CAAC,CAAC,CAAC;IACH,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAEtB,qCAAqC;IACrC,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,mCAAwB,CAAC,OAAO,CAAC,CAAC,CAAC;IAChE,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAC,CAAC;IAEtD,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACjE,GAAG,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC,CAAC;IAE1D,GAAG,CAAC,QAAQ,EAAE,CAAC;AACnB,CAAC;AA1BD,0CA0BC;AAED;;;;;GAKG;AACH,SAAsB,cAAc,CAChC,WAAmB,EACnB,cAAuB;;QAEvB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,eAAU,CAAC,WAAW,CAAC,EAAE;gBACzB,IAAI;oBACA,MAAM,GAAG,GAAG,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;oBAC5D,IAAI,UAAU,GAAG,EAAE,CAAC;oBACpB,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE;wBACpC,UAAU,GAAG,cAAc,CAAC,iBAAiB,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC;4BAC5D,CAAC,CAAC,cAAc;4BAChB,CAAC,CAAC,cAAc,GAAG,MAAM,CAAC;qBACjC;yBAAM;wBACH,UAAU,GAAG,GAAG,eAAQ,CAAC,WAAW,CAAC,IAAI,IAAI,IAAI,EAAE;6BAC9C,WAAW,EAAE;6BACb,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC;6BAChB,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC;6BAChB,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC;qBAC/B;oBACD,MAAM,UAAU,GAAG,WAAI,CAAC,cAAO,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC,CAAC;oBAC1D,MAAM,WAAW,GAAG,sBAAiB,CAAC,UAAU,CAAC,CAAC;oBAClD,sFAAsF;oBACtF,oGAAoG;oBACpG,6FAA6F;oBAC7F,mGAAmG;oBACnG,qGAAqG;oBACrG,MAAM,WAAW,GAAG;wBAChB,GAAG,EAAE,WAAW;wBAChB,MAAM,EAAE,CAAC,SAAS,EAAE,iBAAiB,CAAC;wBACtC,IAAI,EAAE,CAAC,oBAAoB,CAAC;qBACpB,CAAC;oBACb,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,EAAE,CAAC;yBAC1B,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;yBACrC,IAAI,CAAC,WAAW,CAAC,CAAC;oBACvB,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CACzB,OAAO,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,sBAAsB,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAC7E,CAAC;oBACF,GAAG,CAAC,QAAQ,EAAE,CAAC;iBAClB;gBAAC,OAAO,KAAK,EAAE;oBACZ,MAAM,CAAC,KAAK,CAAC,CAAC;iBACjB;aACJ;iBAAM;gBACH,MAAM,CAAC,IAAI,KAAK,CAAC,QAAC,CAAC,qBAAqB,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;aAChE;QACL,CAAC,CAAC,CAAC;IACP,CAAC;CAAA;AA9CD,wCA8CC"}
+{"version":3,"file":"zip.js","sourceRoot":"","sources":["../../src/output/zip.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,2BAAuC;AACvC,mDAAqC;AAErC,4CAAsD;AACtD,yCAAsD;AAEtD;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,OAA+B,EAAE,UAAU,GAAG,sBAAsB;IAChG,MAAM,GAAG,GAAG,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAC5D,MAAM,WAAW,GAAG,sBAAiB,CAAC,UAAU,CAAC,CAAC;IAClD,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;QACzB,OAAO,CAAC,GAAG,CAAC,4BAA4B,UAAU,KAAK,kCAAsB,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;IACpG,CAAC,CAAC,CAAC;IACH,GAAG,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE;QACxB,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;YACzB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACvB;aAAM;YACH,MAAM,KAAK,CAAC;SACf;IACL,CAAC,CAAC,CAAC;IACH,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;QACtB,MAAM,KAAK,CAAC;IAChB,CAAC,CAAC,CAAC;IACH,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAEtB,qCAAqC;IACrC,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,mCAAwB,CAAC,OAAO,CAAC,CAAC,CAAC;IAChE,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAC,CAAC;IAEtD,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACjE,GAAG,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC,CAAC;IAE1D,GAAG,CAAC,QAAQ,EAAE,CAAC;AACnB,CAAC;AA1BD,0CA0BC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/environment-check",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "description": "SAP Fiori environment check",
   "license": "Apache-2.0",
   "bin": {
@@ -16,16 +16,17 @@
     "@sap-ux/store": "0.3.8",
     "@sap-ux/ui5-config": "0.16.1",
     "@sap/bas-sdk": "3.1.0",
-    "archiver": "5.3.0",
+    "archiver": "5.3.1",
     "axios": "0.24.0",
-    "findit2": "2.2.3",
+    "glob-gitignore": "1.0.14",
     "i18next": "20.3.2",
+    "ignore": "5.2.4",
     "minimist": "1.2.6",
     "prompts": "2.4.2",
     "yamljs": "0.3.0"
   },
   "devDependencies": {
-    "@types/archiver": "5.1.1",
+    "@types/archiver": "5.3.1",
     "@types/minimist": "1.2.2",
     "@types/prompts": "2.0.14",
     "@types/vscode": "1.39.0"