just-scripts 2.4.1 → 2.5.0

package/lib/utils/exec.js

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.spawn = exports.execSync = exports.encodeArgs = exports.exec = void 0;
+const cp = require("child_process");
+const path_1 = require("path");
+const SEPARATOR = process.platform === 'win32' ? ';' : ':';
+/**
+ * Execute a command.
+ *
+ * @param cmd Command to execute
+ * @param opts Normal exec options plus stdout/stderr for piping output. Can pass `process` for this param.
+ * @returns Promise which will settle when the command completes. If output was not piped, it will be
+ * returned as the promise's value. If the promise was rejected, the error will be of type `ExecError`.
+ */
+function exec(cmd, opts = {}) {
+    return new Promise((resolve, reject) => {
+        var _a, _b;
+        const child = cp.exec(cmd, opts, (error, stdout, stderr) => {
+            if (error) {
+                error.stdout = stdout;
+                error.stderr = stderr;
+                reject(error);
+            }
+            else {
+                resolve(stdout);
+            }
+        });
+        if (opts.stdout) {
+            (_a = child.stdout) === null || _a === void 0 ? void 0 : _a.pipe(opts.stdout);
+        }
+        if (opts.stderr) {
+            (_b = child.stderr) === null || _b === void 0 ? void 0 : _b.pipe(opts.stderr);
+        }
+    });
+}
+exports.exec = exec;
+/**
+ * Encode args for a shell command.
+ * @param cmdArgs Args to encode
+ * @returns Encoded args
+ */
+function encodeArgs(cmdArgs) {
+    // Taken from https://github.com/xxorax/node-shell-escape/blob/master/shell-escape.js
+    // However, we needed to use double quotes because that's the norm in more platforms
+    if (!cmdArgs) {
+        return cmdArgs;
+    }
+    return cmdArgs.map(arg => {
+        if (/[^\w/:=-]/.test(arg)) {
+            arg = `"${arg.replace(/"/g, '"\\"')}"`;
+            arg = arg.replace(/^(?:"")+/g, '').replace(/\\"""/g, '\\"');
+        }
+        return arg;
+    });
+}
+exports.encodeArgs = encodeArgs;
+/**
+ * Execute a command synchronously.
+ *
+ * @param cmd  Command to execute
+ * @param cwd Working directory in which to run the command (default: `process.cwd()`)
+ * @param returnOutput If true, return the command's output. If false/unspecified,
+ * inherit stdio from the parent process (so the child's output goes to the console).
+ * @returns If `returnOutput` is true, returns the command's output. Otherwise returns undefined.
+ */
+function execSync(cmd, cwd, returnOutput) {
+    cwd = cwd || process.cwd();
+    const env = { ...process.env };
+    env.PATH = (0, path_1.resolve)('./node_modules/.bin') + SEPARATOR + env.PATH;
+    const output = cp.execSync(cmd, {
+        cwd,
+        env,
+        stdio: returnOutput ? undefined : 'inherit',
+    });
+    return returnOutput ? (output || '').toString('utf8') : undefined;
+}
+exports.execSync = execSync;
+/**
+ * Execute a command in a new process.
+ *
+ * @param cmd Command to execute
+ * @param args Args for the command
+ * @param opts Normal spawn options plus stdout/stderr for piping output. Can pass `process` for this param.
+ * @returns Promise which will settle when the command completes. If the promise is rejected, the error will
+ * include the child process's exit code.
+ */
+function spawn(cmd, args = [], opts = {}) {
+    return new Promise((resolve, reject) => {
+        var _a, _b;
+        const child = cp.spawn(cmd, args, opts);
+        child.on('exit', (code, signal) => {
+            if (code) {
+                const error = new Error('Command failed: ' + [cmd, ...args].join(' '));
+                error.code = code;
+                reject(error);
+            }
+            else if (signal) {
+                const error = new Error(`Command terminated by signal ${signal}: ` + [cmd, ...args].join(' '));
+                error.signal = signal;
+                reject(error);
+            }
+            else {
+                resolve();
+            }
+        });
+        if (opts.stdout) {
+            (_a = child.stdout) === null || _a === void 0 ? void 0 : _a.pipe(opts.stdout);
+        }
+        if (opts.stderr) {
+            (_b = child.stderr) === null || _b === void 0 ? void 0 : _b.pipe(opts.stderr);
+        }
+    });
+}
+exports.spawn = spawn;
+//# sourceMappingURL=exec.js.map

package/lib/utils/exec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exec.js","sourceRoot":"","sources":["../../src/utils/exec.ts"],"names":[],"mappings":";;;AAAA,oCAAoC;AACpC,+BAA+B;AAO/B,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;AAE3D;;;;;;;GAOG;AACH,SAAgB,IAAI,CAClB,GAAW,EACX,OAA4F,EAAE;IAE9F,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;;QACrC,MAAM,KAAK,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,KAAuB,EAAE,MAAe,EAAE,MAAe,EAAE,EAAE;YAC7F,IAAI,KAAK,EAAE;gBACT,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;gBACtB,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;gBACtB,MAAM,CAAC,KAAK,CAAC,CAAC;aACf;iBAAM;gBACL,OAAO,CAAC,MAAM,CAAC,CAAC;aACjB;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,MAAA,KAAK,CAAC,MAAM,0CAAE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACjC;QAED,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,MAAA,KAAK,CAAC,MAAM,0CAAE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACjC;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAvBD,oBAuBC;AAED;;;;GAIG;AACH,SAAgB,UAAU,CAAC,OAAiB;IAC1C,qFAAqF;IACrF,oFAAoF;IACpF,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,OAAO,CAAC;KAChB;IAED,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;QACvB,IAAI,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YACzB,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC;YACvC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;SAC7D;QAED,OAAO,GAAG,CAAC;IACb,CAAC,CAAC,CAAC;AACL,CAAC;AAfD,gCAeC;AAED;;;;;;;;GAQG;AACH,SAAgB,QAAQ,CAAC,GAAW,EAAE,GAAY,EAAE,YAAsB;IACxE,GAAG,GAAG,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IAE3B,MAAM,GAAG,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAC/B,GAAG,CAAC,IAAI,GAAG,IAAA,cAAO,EAAC,qBAAqB,CAAC,GAAG,SAAS,GAAG,GAAG,CAAC,IAAI,CAAC;IAEjE,MAAM,MAAM,GAAG,EAAE,CAAC,QAAQ,CAAC,GAAG,EAAE;QAC9B,GAAG;QACH,GAAG;QACH,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;KAC5C,CAAC,CAAC;IACH,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACpE,CAAC;AAZD,4BAYC;AAED;;;;;;;;GAQG;AACH,SAAgB,KAAK,CACnB,GAAW,EACX,OAA8B,EAAE,EAChC,OAA6F,EAAE;IAE/F,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;;QACrC,MAAM,KAAK,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QACxC,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAmB,EAAE,MAAqB,EAAE,EAAE;YAC9D,IAAI,IAAI,EAAE;gBACR,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,kBAAkB,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;gBACtE,KAAa,CAAC,IAAI,GAAG,IAAI,CAAC;gBAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;aACf;iBAAM,IAAI,MAAM,EAAE;gBACjB,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,gCAAgC,MAAM,IAAI,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;gBAC9F,KAAa,CAAC,MAAM,GAAG,MAAM,CAAC;gBAC/B,MAAM,CAAC,KAAK,CAAC,CAAC;aACf;iBAAM;gBACL,OAAO,EAAE,CAAC;aACX;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,MAAA,KAAK,CAAC,MAAM,0CAAE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACjC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,MAAA,KAAK,CAAC,MAAM,0CAAE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACjC;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AA5BD,sBA4BC"}

package/lib/utils/index.d.ts

@@ -0,0 +1,5 @@
+export * from './exec';
+export { mergePackageJson } from './mergePackageJson';
+export * from './paths';
+export * from './readPackageJson';
+//# sourceMappingURL=index.d.ts.map

package/lib/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,cAAc,SAAS,CAAC;AACxB,cAAc,mBAAmB,CAAC"}

package/lib/utils/index.js

@@ -0,0 +1,19 @@
+"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 __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.mergePackageJson = void 0;
+__exportStar(require("./exec"), exports);
+var mergePackageJson_1 = require("./mergePackageJson");
+Object.defineProperty(exports, "mergePackageJson", { enumerable: true, get: function () { return mergePackageJson_1.mergePackageJson; } });
+__exportStar(require("./paths"), exports);
+__exportStar(require("./readPackageJson"), exports);
+//# sourceMappingURL=index.js.map

package/lib/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,yCAAuB;AACvB,uDAAsD;AAA7C,oHAAA,gBAAgB,OAAA;AACzB,0CAAwB;AACxB,oDAAkC"}

package/lib/utils/mergePackageJson.d.ts

@@ -0,0 +1,20 @@
+import { PackageJson } from '../interfaces/PackageJson';
+/**
+ * Merges an incoming package.json with an original semantically. It can only handle merging
+ * dependencies and devDependencies for ranges that look like "^x.y.z" or "~x.y.z" or "x.y.z".
+ *
+ * @param original Original package.json contents.
+ * @param incoming Incoming package.json contents.
+ * @returns Returns a new package.json object if any changes were needed, or returns `original`
+ * if not. (You can tell if changes were made by checking the object identity.)
+ */
+export declare function mergePackageJson(original: PackageJson, incoming: PackageJson): PackageJson;
+/**
+ * Exported for testing only. Determines whether a dep should be updated.
+ * Returns false if either version includes semver elements we don't understand
+ * (any characters besides number and ~ ^).
+ * @param originalVersion The original dep version (default 0.0.0)
+ * @param incomingVersion The incoming dep version
+ */
+export declare function _shouldUpdateDep(originalVersion: string | undefined, incomingVersion: string): boolean;
+//# sourceMappingURL=mergePackageJson.d.ts.map

package/lib/utils/mergePackageJson.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mergePackageJson.d.ts","sourceRoot":"","sources":["../../src/utils/mergePackageJson.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAGxD;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,GAAG,WAAW,CA4B1F;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CActG"}

package/lib/utils/mergePackageJson.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._shouldUpdateDep = exports.mergePackageJson = void 0;
+const semver = require("semver");
+/**
+ * Merges an incoming package.json with an original semantically. It can only handle merging
+ * dependencies and devDependencies for ranges that look like "^x.y.z" or "~x.y.z" or "x.y.z".
+ *
+ * @param original Original package.json contents.
+ * @param incoming Incoming package.json contents.
+ * @returns Returns a new package.json object if any changes were needed, or returns `original`
+ * if not. (You can tell if changes were made by checking the object identity.)
+ */
+function mergePackageJson(original, incoming) {
+    if (!original.just) {
+        return original;
+    }
+    // deep copy the deps and devDeps
+    const newPackageJson = {
+        ...original,
+        dependencies: { ...(original.dependencies || {}) },
+        devDependencies: { ...(original.devDependencies || {}) },
+    };
+    const depTypes = ['dependencies', 'devDependencies'];
+    let packageJsonModified = false;
+    depTypes.forEach(depType => {
+        const incomingDeps = incoming[depType] || {};
+        const originalDeps = original[depType] || {};
+        Object.keys(incomingDeps).forEach(dep => {
+            // TODO: should this handle deleting deps that exist in originalDeps but not incomingDeps?
+            if (_shouldUpdateDep(originalDeps[dep], incomingDeps[dep])) {
+                newPackageJson[depType][dep] = incomingDeps[dep];
+                packageJsonModified = true;
+            }
+        });
+    });
+    return packageJsonModified ? newPackageJson : original;
+}
+exports.mergePackageJson = mergePackageJson;
+/**
+ * Exported for testing only. Determines whether a dep should be updated.
+ * Returns false if either version includes semver elements we don't understand
+ * (any characters besides number and ~ ^).
+ * @param originalVersion The original dep version (default 0.0.0)
+ * @param incomingVersion The incoming dep version
+ */
+function _shouldUpdateDep(originalVersion, incomingVersion) {
+    const strippedOriginalVersion = (originalVersion || '0.0.0').replace(/^[~^]/, '');
+    const strippedIncomingVersion = incomingVersion.replace(/^[~^]/, '');
+    // semver.valid only returns true for a valid SINGLE version, not any type of range
+    if (!semver.valid(strippedOriginalVersion) || !semver.valid(strippedIncomingVersion)) {
+        // The original and/or incoming versions (with ~ and ^ removed) can't be understood as a single
+        // semver version. They might be valid ranges of some other form (like with x or ||), but we
+        // don't currently handle those. Do nothing.
+        return false;
+    }
+    // Modify the version if the range is comparable and is greater
+    return semver.gt(strippedIncomingVersion, strippedOriginalVersion);
+}
+exports._shouldUpdateDep = _shouldUpdateDep;
+//# sourceMappingURL=mergePackageJson.js.map

package/lib/utils/mergePackageJson.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mergePackageJson.js","sourceRoot":"","sources":["../../src/utils/mergePackageJson.ts"],"names":[],"mappings":";;;AACA,iCAAkC;AAElC;;;;;;;;GAQG;AACH,SAAgB,gBAAgB,CAAC,QAAqB,EAAE,QAAqB;IAC3E,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE;QAClB,OAAO,QAAQ,CAAC;KACjB;IAED,iCAAiC;IACjC,MAAM,cAAc,GAAgB;QAClC,GAAG,QAAQ;QACX,YAAY,EAAE,EAAE,GAAG,CAAC,QAAQ,CAAC,YAAY,IAAI,EAAE,CAAC,EAAE;QAClD,eAAe,EAAE,EAAE,GAAG,CAAC,QAAQ,CAAC,eAAe,IAAI,EAAE,CAAC,EAAE;KACzD,CAAC;IAEF,MAAM,QAAQ,GAAG,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC;IACrD,IAAI,mBAAmB,GAAG,KAAK,CAAC;IAChC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;QACzB,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAC7C,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAE7C,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACtC,0FAA0F;YAC1F,IAAI,gBAAgB,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE;gBAC1D,cAAc,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;gBACjD,mBAAmB,GAAG,IAAI,CAAC;aAC5B;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO,mBAAmB,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC;AACzD,CAAC;AA5BD,4CA4BC;AAED;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAAC,eAAmC,EAAE,eAAuB;IAC3F,MAAM,uBAAuB,GAAG,CAAC,eAAe,IAAI,OAAO,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAClF,MAAM,uBAAuB,GAAG,eAAe,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAErE,mFAAmF;IACnF,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,EAAE;QACpF,+FAA+F;QAC/F,4FAA4F;QAC5F,4CAA4C;QAC5C,OAAO,KAAK,CAAC;KACd;IAED,+DAA+D;IAC/D,OAAO,MAAM,CAAC,EAAE,CAAC,uBAAuB,EAAE,uBAAuB,CAAC,CAAC;AACrE,CAAC;AAdD,4CAcC"}

package/lib/utils/paths.d.ts

@@ -0,0 +1,13 @@
+export declare const paths: {
+    /**
+     * Location where the generated project will go. Defaults to `process.cwd()`.
+     */
+    projectPath: string;
+    /**
+     * Gets a directory path under `${os.tmpdir()}/just-stack` for temporarily storing files.
+     * @param segments Names of extra directory segments to include.
+     * @returns The directory path.
+     */
+    tempPath(...segments: string[]): string;
+};
+//# sourceMappingURL=paths.d.ts.map

package/lib/utils/paths.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paths.d.ts","sourceRoot":"","sources":["../../src/utils/paths.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,KAAK;IAChB;;OAEG;;IASH;;;;OAIG;0BACmB,MAAM,EAAE,GAAG,MAAM;CAGxC,CAAC"}

package/lib/utils/paths.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.paths = void 0;
+const path = require("path");
+const os = require("os");
+let projectPath = '';
+exports.paths = {
+    /**
+     * Location where the generated project will go. Defaults to `process.cwd()`.
+     */
+    get projectPath() {
+        return projectPath || process.cwd();
+    },
+    set projectPath(value) {
+        projectPath = value;
+    },
+    /**
+     * Gets a directory path under `${os.tmpdir()}/just-stack` for temporarily storing files.
+     * @param segments Names of extra directory segments to include.
+     * @returns The directory path.
+     */
+    tempPath(...segments) {
+        return path.resolve(os.tmpdir(), 'just-stack', ...segments);
+    },
+};
+//# sourceMappingURL=paths.js.map

package/lib/utils/paths.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paths.js","sourceRoot":"","sources":["../../src/utils/paths.ts"],"names":[],"mappings":";;;AAAA,6BAA6B;AAC7B,yBAAyB;AAEzB,IAAI,WAAW,GAAG,EAAE,CAAC;AAER,QAAA,KAAK,GAAG;IACnB;;OAEG;IACH,IAAI,WAAW;QACb,OAAO,WAAW,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IACtC,CAAC;IAED,IAAI,WAAW,CAAC,KAAa;QAC3B,WAAW,GAAG,KAAK,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,GAAG,QAAkB;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,YAAY,EAAE,GAAG,QAAQ,CAAC,CAAC;IAC9D,CAAC;CACF,CAAC"}

package/lib/utils/readPackageJson.d.ts

@@ -0,0 +1,8 @@
+import { PackageJson } from '../interfaces/PackageJson';
+/**
+ * Reads and parses the package.json file from the given folder.
+ * @param folderPath The folder path to look for a package.json in.
+ * @returns The parsed file contents, or undefined if the file doesn't exist.
+ */
+export declare function readPackageJson(folderPath: string): PackageJson | undefined;
+//# sourceMappingURL=readPackageJson.d.ts.map

package/lib/utils/readPackageJson.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"readPackageJson.d.ts","sourceRoot":"","sources":["../../src/utils/readPackageJson.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAGxD;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS,CAM3E"}

package/lib/utils/readPackageJson.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readPackageJson = void 0;
+const path = require("path");
+const fse = require("fs-extra");
+/**
+ * Reads and parses the package.json file from the given folder.
+ * @param folderPath The folder path to look for a package.json in.
+ * @returns The parsed file contents, or undefined if the file doesn't exist.
+ */
+function readPackageJson(folderPath) {
+    const packageJsonPath = path.join(folderPath, 'package.json');
+    if (fse.existsSync(packageJsonPath)) {
+        return fse.readJsonSync(packageJsonPath, { throws: false }) || undefined;
+    }
+    return undefined;
+}
+exports.readPackageJson = readPackageJson;
+//# sourceMappingURL=readPackageJson.js.map

package/lib/utils/readPackageJson.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"readPackageJson.js","sourceRoot":"","sources":["../../src/utils/readPackageJson.ts"],"names":[],"mappings":";;;AAAA,6BAA6B;AAE7B,gCAAiC;AAEjC;;;;GAIG;AACH,SAAgB,eAAe,CAAC,UAAkB;IAChD,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IAC9D,IAAI,GAAG,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE;QACnC,OAAO,GAAG,CAAC,YAAY,CAAC,eAAe,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,IAAI,SAAS,CAAC;KAC1E;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAND,0CAMC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "just-scripts",
-  "version": "2.4.1",
+  "version": "2.5.0",
   "description": "Just Stack Scripts",
   "keywords": [],
   "repository": {
@@ -31,8 +31,7 @@
     "diff-match-patch": "1.0.5",
     "fs-extra": "^11.0.0",
     "glob": "^7.1.3",
-    "just-scripts-utils": "^2.1.0",
-    "just-task": ">=1.12.0 <2.0.0",
+    "just-task": ">=1.13.0 <2.0.0",
     "prompts": "^2.4.0",
     "run-parallel-limit": "^1.0.6",
     "semver": "^7.0.0",

package/src/index.ts

@@ -43,4 +43,4 @@ export { copyInstructions };
 
 export * from 'just-task';
 
-export { spawn } from 'just-scripts-utils';
+export { encodeArgs, spawn } from './utils';

package/src/interfaces/PackageJson.ts

@@ -0,0 +1,16 @@
+export interface Dependencies {
+  [key: string]: string;
+}
+
+export interface PackageJson {
+  name: string;
+  description?: string;
+  dependencies?: Dependencies;
+  devDependencies?: Dependencies;
+  keywords?: string;
+  just?: {
+    /** Stack that the package is tracking */
+    stack?: string;
+  };
+  [key: string]: any;
+}

package/src/tasks/eslintTask.ts

@@ -1,5 +1,5 @@
 import { resolve, logger, resolveCwd, TaskFunction } from 'just-task';
-import { encodeArgs, spawn } from 'just-scripts-utils';
+import { encodeArgs, spawn } from '../utils';
 import * as fs from 'fs';
 
 /**
@@ -33,6 +33,10 @@ export interface EsLintTaskOptions {
    * This will be passed as an environment variable to eslint with the value ESLINT_USE_FLAT_CONFIG (https://eslint.org/blog/2024/04/eslint-v9.0.0-released/#flat-config-is-now-the-default-and-has-some-changes).
    */
   useFlatConfig?: boolean;
+  /**
+   * When set to true, eslint will report any eslint-disable comments that are not used as an error.
+   */
+  reportUnusedDisableDirectives?: boolean;
 }
 
 export function eslintTask(options: EsLintTaskOptions = {}): TaskFunction {
@@ -77,6 +81,7 @@ export function eslintTask(options: EsLintTaskOptions = {}): TaskFunction {
         ...(outputFile ? ['--output-file', outputFile] : []),
         ...(format ? ['--format', format] : []),
         ...(quiet ? ['--quiet'] : []),
+        ...(options.reportUnusedDisableDirectives ? ['--report-unused-disable-directives'] : []),
         '--color',
       ];
 

package/src/tasks/jestTask.ts

@@ -1,5 +1,5 @@
 import { resolve, logger, resolveCwd, TaskFunction, argv } from 'just-task';
-import { spawn, encodeArgs, readPackageJson } from 'just-scripts-utils';
+import { spawn, encodeArgs, readPackageJson } from '../utils';
 import { existsSync } from 'fs';
 import * as supportsColor from 'supports-color';
 
@@ -72,7 +72,7 @@ export function jestTask(options: JestTaskOptions = {}): TaskFunction {
         ...(options.silent ? ['--silent'] : []),
         ...(options.testPathPattern ? ['--testPathPattern', options.testPathPattern] : []),
         ...(options.testNamePattern ? ['--testNamePattern', options.testNamePattern] : []),
-        ...(options.maxWorkers ? ['--maxWorkers', options.maxWorkers]: []),
+        ...(options.maxWorkers ? ['--maxWorkers', options.maxWorkers] : []),
         ...(options.u || options.updateSnapshot ? ['--updateSnapshot'] : ['']),
         // Only include the positional args if `options._` wasn't specified
         // (to avoid possibly including them twice)

package/src/tasks/nodeExecTask.ts

@@ -1,5 +1,5 @@
 import { SpawnOptions } from 'child_process';
-import { spawn } from 'just-scripts-utils';
+import { spawn } from '../utils';
 import { logger, TaskFunction } from 'just-task';
 import { resolveCwd, _tryResolve } from 'just-task/lib/resolve';
 import { getTsNodeEnv } from '../typescript/getTsNodeEnv';

package/src/tasks/prettierTask.ts

@@ -1,5 +1,5 @@
 import { logger, resolve, TaskFunction } from 'just-task';
-import { spawn } from 'just-scripts-utils';
+import { spawn } from '../utils';
 import { splitArrayIntoChunks } from '../arrayUtils/splitArrayIntoChunks';
 import * as path from 'path';
 import { arrayify } from '../arrayUtils/arrayify';

package/src/tasks/tscTask.ts

@@ -1,6 +1,6 @@
 import * as ts from 'typescript';
 import { resolve, logger, resolveCwd, TaskFunction } from 'just-task';
-import { exec, encodeArgs, spawn } from 'just-scripts-utils';
+import { exec, encodeArgs, spawn } from '../utils';
 import * as fs from 'fs';
 
 export type TscTaskOptions = { [key in keyof ts.CompilerOptions]?: string | boolean | string[] } & {

package/src/tasks/tslintTask.ts

@@ -1,5 +1,5 @@
 import { resolve, logger, resolveCwd, TaskFunction } from 'just-task';
-import { exec, encodeArgs } from 'just-scripts-utils';
+import { exec, encodeArgs } from '../utils';
 import * as path from 'path';
 import * as fs from 'fs';
 

package/src/tasks/webpackCliTask.ts

@@ -1,5 +1,5 @@
 import { logger, TaskFunction, resolve } from 'just-task';
-import { spawn } from 'just-scripts-utils';
+import { spawn } from '../utils';
 import { getTsNodeEnv } from '../typescript/getTsNodeEnv';
 import { findWebpackConfig } from '../webpack/findWebpackConfig';
 

package/src/tasks/webpackDevServerTask.ts

@@ -1,6 +1,6 @@
 // // WARNING: Careful about add more imports - only import types from webpack
 import { Configuration } from 'webpack';
-import { encodeArgs, spawn } from 'just-scripts-utils';
+import { encodeArgs, spawn } from '../utils';
 import { logger, resolve, resolveCwd, TaskFunction } from 'just-task';
 import * as fs from 'fs';
 import * as path from 'path';

package/src/utils/exec.ts

@@ -0,0 +1,126 @@
+import * as cp from 'child_process';
+import { resolve } from 'path';
+
+export interface ExecError extends cp.ExecException {
+  stdout?: string;
+  stderr?: string;
+}
+
+const SEPARATOR = process.platform === 'win32' ? ';' : ':';
+
+/**
+ * Execute a command.
+ *
+ * @param cmd Command to execute
+ * @param opts Normal exec options plus stdout/stderr for piping output. Can pass `process` for this param.
+ * @returns Promise which will settle when the command completes. If output was not piped, it will be
+ * returned as the promise's value. If the promise was rejected, the error will be of type `ExecError`.
+ */
+export function exec(
+  cmd: string,
+  opts: cp.ExecOptions & { stdout?: NodeJS.WritableStream; stderr?: NodeJS.WritableStream } = {},
+): Promise<string | undefined> {
+  return new Promise((resolve, reject) => {
+    const child = cp.exec(cmd, opts, (error: ExecError | null, stdout?: string, stderr?: string) => {
+      if (error) {
+        error.stdout = stdout;
+        error.stderr = stderr;
+        reject(error);
+      } else {
+        resolve(stdout);
+      }
+    });
+
+    if (opts.stdout) {
+      child.stdout?.pipe(opts.stdout);
+    }
+
+    if (opts.stderr) {
+      child.stderr?.pipe(opts.stderr);
+    }
+  });
+}
+
+/**
+ * Encode args for a shell command.
+ * @param cmdArgs Args to encode
+ * @returns Encoded args
+ */
+export function encodeArgs(cmdArgs: string[]): string[] {
+  // Taken from https://github.com/xxorax/node-shell-escape/blob/master/shell-escape.js
+  // However, we needed to use double quotes because that's the norm in more platforms
+  if (!cmdArgs) {
+    return cmdArgs;
+  }
+
+  return cmdArgs.map(arg => {
+    if (/[^\w/:=-]/.test(arg)) {
+      arg = `"${arg.replace(/"/g, '"\\"')}"`;
+      arg = arg.replace(/^(?:"")+/g, '').replace(/\\"""/g, '\\"');
+    }
+
+    return arg;
+  });
+}
+
+/**
+ * Execute a command synchronously.
+ *
+ * @param cmd  Command to execute
+ * @param cwd Working directory in which to run the command (default: `process.cwd()`)
+ * @param returnOutput If true, return the command's output. If false/unspecified,
+ * inherit stdio from the parent process (so the child's output goes to the console).
+ * @returns If `returnOutput` is true, returns the command's output. Otherwise returns undefined.
+ */
+export function execSync(cmd: string, cwd?: string, returnOutput?: boolean): string | undefined {
+  cwd = cwd || process.cwd();
+
+  const env = { ...process.env };
+  env.PATH = resolve('./node_modules/.bin') + SEPARATOR + env.PATH;
+
+  const output = cp.execSync(cmd, {
+    cwd,
+    env,
+    stdio: returnOutput ? undefined : 'inherit',
+  });
+  return returnOutput ? (output || '').toString('utf8') : undefined;
+}
+
+/**
+ * Execute a command in a new process.
+ *
+ * @param cmd Command to execute
+ * @param args Args for the command
+ * @param opts Normal spawn options plus stdout/stderr for piping output. Can pass `process` for this param.
+ * @returns Promise which will settle when the command completes. If the promise is rejected, the error will
+ * include the child process's exit code.
+ */
+export function spawn(
+  cmd: string,
+  args: ReadonlyArray<string> = [],
+  opts: cp.SpawnOptions & { stdout?: NodeJS.WritableStream; stderr?: NodeJS.WritableStream } = {},
+): Promise<void> {
+  return new Promise((resolve, reject) => {
+    const child = cp.spawn(cmd, args, opts);
+    child.on('exit', (code: number | null, signal: string | null) => {
+      if (code) {
+        const error = new Error('Command failed: ' + [cmd, ...args].join(' '));
+        (error as any).code = code;
+        reject(error);
+      } else if (signal) {
+        const error = new Error(`Command terminated by signal ${signal}: ` + [cmd, ...args].join(' '));
+        (error as any).signal = signal;
+        reject(error);
+      } else {
+        resolve();
+      }
+    });
+
+    if (opts.stdout) {
+      child.stdout?.pipe(opts.stdout);
+    }
+    if (opts.stderr) {
+      child.stderr?.pipe(opts.stderr);
+    }
+  });
+}

package/src/utils/index.ts

@@ -0,0 +1,4 @@
+export * from './exec';
+export { mergePackageJson } from './mergePackageJson';
+export * from './paths';
+export * from './readPackageJson';