@shopify/cli-kit 0.0.0-nightly-20230110194301

package/dist/environment/spin.js

@@ -0,0 +1,99 @@
+import { isTruthy } from './utilities.js';
+import { getCachedSpinFqdn, setCachedSpinFqdn } from './spin-cache.js';
+import constants from '../constants.js';
+import { captureOutput } from '../system.js';
+import { Abort } from '../error.js';
+import { content, token } from '../output.js';
+import { exists, readSync } from '../file.js';
+export const SpinInstanceNotFound = (spinInstance, error) => {
+    const errorMessage = content `${token.genericShellCommand(`spin`)} yielded the following error trying to obtain the fully qualified domain name of the Spin instance:
+${error}
+  `;
+    let nextSteps;
+    if (spinInstance) {
+        nextSteps = `Make sure ${spinInstance} is the instance name and not a fully qualified domain name`;
+    }
+    return new Abort(errorMessage, nextSteps);
+};
+const spinFqdnFilePath = '/etc/spin/machine/fqdn';
+/**
+ * When ran in a Spin environment, it returns the fqdn of the instance.
+ *
+ * Will cache the value of the Spin FQDN during the execution of the CLI.
+ * To avoid multiple calls to `readSync` or `show`
+ * @returns fqdn of the Spin environment.
+ */
+export async function fqdn(env = process.env) {
+    let spinFqdn = getCachedSpinFqdn();
+    if (spinFqdn)
+        return spinFqdn;
+    if (await exists(spinFqdnFilePath)) {
+        spinFqdn = await readSync(spinFqdnFilePath).toString();
+    }
+    else {
+        const spinInstance = await instance(env);
+        const showResponse = await show(spinInstance, env);
+        spinFqdn = showResponse.fqdn;
+    }
+    setCachedSpinFqdn(spinFqdn);
+    return spinFqdn;
+}
+/**
+ * Runs "spin show" and returns the JSON-parsed output.
+ * @param spinInstance - When it's undefined, we'll fetch the latest one.
+ * @returns The JSON-parsed output of the Spin CLI.
+ * @throws Any error raised from the underlying Spin CLI.
+ */
+export async function show(spinInstance, env = process.env) {
+    const latest = spinInstance === undefined;
+    const args = latest ? ['show', '--latest', '--json'] : ['show', '--json'];
+    const output = await captureOutput('spin', args, { env });
+    const json = JSON.parse(output);
+    if (json.error) {
+        throw SpinInstanceNotFound(spinInstance, json.error);
+    }
+    else {
+        return json;
+    }
+}
+/**
+ * Returns true if the CLI is running in a Spin environment.
+ * @param env - Environment variables
+ * @returns True if the CLI is running in a Spin environment.
+ */
+export function isSpin(env = process.env) {
+    return isTruthy(env[constants.environmentVariables.spin]);
+}
+/**
+ * Returns the value of the SPIN_INSTANCE environment variable.
+ * @param env - Environment variables
+ * @returns The value of the SPIN_INSTANCE environment variable.
+ */
+export function instance(env = process.env) {
+    return env[constants.environmentVariables.spinInstance];
+}
+/**
+ * Returns the value of the SPIN_WORKSPACE environment variable.
+ * @param env - Environment variables
+ * @returns The value of the SPIN_WORKSPACE environment variable.
+ */
+export function workspace(env = process.env) {
+    return env[constants.environmentVariables.spinWorkspace];
+}
+/**
+ * Returns the value of the SPIN_NAMESPACE environment variable.
+ * @param env - Environment variables
+ * @returns The value of the SPIN_NAMESPACE environment variable.
+ */
+export function namespace(env = process.env) {
+    return env[constants.environmentVariables.spinNamespace];
+}
+/**
+ * Returns the value of the SPIN_HOST environment variable.
+ * @param env - Environment variables
+ * @returns The value of the SPIN_HOST environment variable.
+ */
+export function host(env = process.env) {
+    return env[constants.environmentVariables.spinHost];
+}
+//# sourceMappingURL=spin.js.map

package/dist/environment/spin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spin.js","sourceRoot":"","sources":["../../src/environment/spin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,gBAAgB,CAAA;AACvC,OAAO,EAAC,iBAAiB,EAAE,iBAAiB,EAAC,MAAM,iBAAiB,CAAA;AACpE,OAAO,SAAS,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAC,aAAa,EAAC,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAC,KAAK,EAAC,MAAM,aAAa,CAAA;AACjC,OAAO,EAAC,OAAO,EAAE,KAAK,EAAC,MAAM,cAAc,CAAA;AAC3C,OAAO,EAAC,MAAM,EAAE,QAAQ,EAAC,MAAM,YAAY,CAAA;AAE3C,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,YAAgC,EAAE,KAAa,EAAE,EAAE;IACtF,MAAM,YAAY,GAAG,OAAO,CAAA,GAAG,KAAK,CAAC,mBAAmB,CACtD,MAAM,CACP;EACD,KAAK;GACJ,CAAA;IACD,IAAI,SAA6B,CAAA;IACjC,IAAI,YAAY,EAAE;QAChB,SAAS,GAAG,aAAa,YAAY,6DAA6D,CAAA;KACnG;IACD,OAAO,IAAI,KAAK,CAAC,YAAY,EAAE,SAAS,CAAC,CAAA;AAC3C,CAAC,CAAA;AAED,MAAM,gBAAgB,GAAG,wBAAwB,CAAA;AAEjD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IAC1C,IAAI,QAAQ,GAAG,iBAAiB,EAAE,CAAA;IAClC,IAAI,QAAQ;QAAE,OAAO,QAAQ,CAAA;IAE7B,IAAI,MAAM,MAAM,CAAC,gBAAgB,CAAC,EAAE;QAClC,QAAQ,GAAG,MAAM,QAAQ,CAAC,gBAAgB,CAAC,CAAC,QAAQ,EAAE,CAAA;KACvD;SAAM;QACL,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,CAAA;QACxC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,YAAY,EAAE,GAAG,CAAC,CAAA;QAElD,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAA;KAC7B;IACD,iBAAiB,CAAC,QAAQ,CAAC,CAAA;IAC3B,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,YAAgC,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG;IAC5E,MAAM,MAAM,GAAG,YAAY,KAAK,SAAS,CAAA;IACzC,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;IACzE,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,MAAM,EAAE,IAAI,EAAE,EAAC,GAAG,EAAC,CAAC,CAAA;IACvD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;IAC/B,IAAI,IAAI,CAAC,KAAK,EAAE;QACd,MAAM,oBAAoB,CAAC,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;KACrD;SAAM;QACL,OAAO,IAAI,CAAA;KACZ;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,MAAM,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACtC,OAAO,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAA;AAC3D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,QAAQ,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACxC,OAAO,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAA;AACzD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACzC,OAAO,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAA;AAC1D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACzC,OAAO,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAA;AAC1D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACpC,OAAO,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAA;AACrD,CAAC","sourcesContent":["import {isTruthy} from './utilities.js'\nimport {getCachedSpinFqdn, setCachedSpinFqdn} from './spin-cache.js'\nimport constants from '../constants.js'\nimport {captureOutput} from '../system.js'\nimport {Abort} from '../error.js'\nimport {content, token} from '../output.js'\nimport {exists, readSync} from '../file.js'\n\nexport const SpinInstanceNotFound = (spinInstance: string | undefined, error: string) => {\n  const errorMessage = content`${token.genericShellCommand(\n    `spin`,\n  )} yielded the following error trying to obtain the fully qualified domain name of the Spin instance:\n${error}\n  `\n  let nextSteps: string | undefined\n  if (spinInstance) {\n    nextSteps = `Make sure ${spinInstance} is the instance name and not a fully qualified domain name`\n  }\n  return new Abort(errorMessage, nextSteps)\n}\n\nconst spinFqdnFilePath = '/etc/spin/machine/fqdn'\n\n/**\n * When ran in a Spin environment, it returns the fqdn of the instance.\n *\n * Will cache the value of the Spin FQDN during the execution of the CLI.\n * To avoid multiple calls to `readSync` or `show`\n * @returns fqdn of the Spin environment.\n */\nexport async function fqdn(env = process.env): Promise<string> {\n  let spinFqdn = getCachedSpinFqdn()\n  if (spinFqdn) return spinFqdn\n\n  if (await exists(spinFqdnFilePath)) {\n    spinFqdn = await readSync(spinFqdnFilePath).toString()\n  } else {\n    const spinInstance = await instance(env)\n    const showResponse = await show(spinInstance, env)\n\n    spinFqdn = showResponse.fqdn\n  }\n  setCachedSpinFqdn(spinFqdn)\n  return spinFqdn\n}\n\n/**\n * Runs \"spin show\" and returns the JSON-parsed output.\n * @param spinInstance - When it's undefined, we'll fetch the latest one.\n * @returns The JSON-parsed output of the Spin CLI.\n * @throws Any error raised from the underlying Spin CLI.\n */\nexport async function show(spinInstance: string | undefined, env = process.env): Promise<{fqdn: string}> {\n  const latest = spinInstance === undefined\n  const args = latest ? ['show', '--latest', '--json'] : ['show', '--json']\n  const output = await captureOutput('spin', args, {env})\n  const json = JSON.parse(output)\n  if (json.error) {\n    throw SpinInstanceNotFound(spinInstance, json.error)\n  } else {\n    return json\n  }\n}\n\n/**\n * Returns true if the CLI is running in a Spin environment.\n * @param env - Environment variables\n * @returns True if the CLI is running in a Spin environment.\n */\nexport function isSpin(env = process.env): boolean {\n  return isTruthy(env[constants.environmentVariables.spin])\n}\n\n/**\n * Returns the value of the SPIN_INSTANCE environment variable.\n * @param env - Environment variables\n * @returns The value of the SPIN_INSTANCE environment variable.\n */\nexport function instance(env = process.env): string | undefined {\n  return env[constants.environmentVariables.spinInstance]\n}\n\n/**\n * Returns the value of the SPIN_WORKSPACE environment variable.\n * @param env - Environment variables\n * @returns The value of the SPIN_WORKSPACE environment variable.\n */\nexport function workspace(env = process.env): string | undefined {\n  return env[constants.environmentVariables.spinWorkspace]\n}\n\n/**\n * Returns the value of the SPIN_NAMESPACE environment variable.\n * @param env - Environment variables\n * @returns The value of the SPIN_NAMESPACE environment variable.\n */\nexport function namespace(env = process.env): string | undefined {\n  return env[constants.environmentVariables.spinNamespace]\n}\n\n/**\n * Returns the value of the SPIN_HOST environment variable.\n * @param env - Environment variables\n * @returns The value of the SPIN_HOST environment variable.\n */\nexport function host(env = process.env): string | undefined {\n  return env[constants.environmentVariables.spinHost]\n}\n"]}

package/dist/environment/utilities.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Returns whether an environment variable value represents a truthy value.
+ */
+export declare function isTruthy(variable: string | undefined): boolean;
+/**
+ * Returns whether an environment variable has been set and is non-empty
+ */
+export declare function isSet(variable: string | undefined): boolean;

package/dist/environment/utilities.js

@@ -0,0 +1,19 @@
+/**
+ * Returns whether an environment variable value represents a truthy value.
+ */
+export function isTruthy(variable) {
+    if (!variable) {
+        return false;
+    }
+    return ['1', 'true', 'TRUE', 'yes', 'YES'].includes(variable);
+}
+/**
+ * Returns whether an environment variable has been set and is non-empty
+ */
+export function isSet(variable) {
+    if (variable === undefined || variable.trim() === '') {
+        return false;
+    }
+    return true;
+}
+//# sourceMappingURL=utilities.js.map

package/dist/environment/utilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utilities.js","sourceRoot":"","sources":["../../src/environment/utilities.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,UAAU,QAAQ,CAAC,QAA4B;IACnD,IAAI,CAAC,QAAQ,EAAE;QACb,OAAO,KAAK,CAAA;KACb;IACD,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;AAC/D,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,KAAK,CAAC,QAA4B;IAChD,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QACpD,OAAO,KAAK,CAAA;KACb;IACD,OAAO,IAAI,CAAA;AACb,CAAC","sourcesContent":["/**\n * Returns whether an environment variable value represents a truthy value.\n */\nexport function isTruthy(variable: string | undefined): boolean {\n  if (!variable) {\n    return false\n  }\n  return ['1', 'true', 'TRUE', 'yes', 'YES'].includes(variable)\n}\n\n/**\n * Returns whether an environment variable has been set and is non-empty\n */\nexport function isSet(variable: string | undefined): boolean {\n  if (variable === undefined || variable.trim() === '') {\n    return false\n  }\n  return true\n}\n"]}

package/dist/environment.d.ts

@@ -0,0 +1,7 @@
+import * as local from './environment/local.js';
+import * as service from './environment/service.js';
+import * as fqdn from './environment/fqdn.js';
+import * as utilities from './environment/utilities.js';
+import * as spin from './environment/spin.js';
+import * as network from './network/service.js';
+export { local, service, fqdn, utilities, spin, network };

package/dist/environment.js

@@ -0,0 +1,8 @@
+import * as local from './environment/local.js';
+import * as service from './environment/service.js';
+import * as fqdn from './environment/fqdn.js';
+import * as utilities from './environment/utilities.js';
+import * as spin from './environment/spin.js';
+import * as network from './network/service.js';
+export { local, service, fqdn, utilities, spin, network };
+//# sourceMappingURL=environment.js.map

package/dist/environment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"environment.js","sourceRoot":"","sources":["../src/environment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,wBAAwB,CAAA;AAC/C,OAAO,KAAK,OAAO,MAAM,0BAA0B,CAAA;AACnD,OAAO,KAAK,IAAI,MAAM,uBAAuB,CAAA;AAC7C,OAAO,KAAK,SAAS,MAAM,4BAA4B,CAAA;AACvD,OAAO,KAAK,IAAI,MAAM,uBAAuB,CAAA;AAC7C,OAAO,KAAK,OAAO,MAAM,sBAAsB,CAAA;AAE/C,OAAO,EAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAC,CAAA","sourcesContent":["import * as local from './environment/local.js'\nimport * as service from './environment/service.js'\nimport * as fqdn from './environment/fqdn.js'\nimport * as utilities from './environment/utilities.js'\nimport * as spin from './environment/spin.js'\nimport * as network from './network/service.js'\n\nexport {local, service, fqdn, utilities, spin, network}\n"]}

package/dist/error.d.ts

@@ -0,0 +1,68 @@
+import { Message } from './output.js';
+import { TokenItem } from './private/node/ui/components/TokenizedText.js';
+export { ExtendableError } from 'ts-error';
+declare enum FatalErrorType {
+    Abort = 0,
+    AbortSilent = 1,
+    Bug = 2
+}
+export declare class CancelExecution extends Error {
+}
+/**
+ * A fatal error represents an error shouldn't be rescued and that causes the execution to terminate.
+ * There shouldn't be code that catches fatal errors.
+ */
+export declare abstract class Fatal extends Error {
+    tryMessage: TokenItem | null;
+    type: FatalErrorType;
+    nextSteps?: TokenItem[];
+    /**
+     *
+     * @param message - The error message
+     * @param type - The type of fatal error
+     * @param tryMessage - The message that recommends next steps to the user.
+     *                     You can pass a string a {@link TokenizedString} or a {@link TokenItem}
+     *                     if you need to style the message inside the error Banner component.
+     */
+    constructor(message: Message, type: FatalErrorType, tryMessage?: TokenItem | Message | null, nextSteps?: TokenItem[]);
+}
+/**
+ * An abort error is a fatal error that shouldn't be reported as a bug.
+ * Those usually represent unexpected scenarios that we can't handle and that usually require some action from the developer
+ */
+export declare class Abort extends Fatal {
+    nextSteps?: TokenItem[];
+    constructor(message: Message, tryMessage?: TokenItem | Message | null, nextSteps?: TokenItem[]);
+}
+/**
+ * An external error is similar to Abort but has extra command and args attributes.
+ * This is useful to represent errors coming from external commands, usually executed by execa.
+ */
+export declare class ExternalError extends Fatal {
+    command: string;
+    args: string[];
+    constructor(message: Message, command: string, args: string[], tryMessage?: TokenItem | Message | null);
+}
+export declare class AbortSilent extends Fatal {
+    constructor();
+}
+/**
+ * A bug error is an error that represents a bug and therefore should be reported.
+ */
+export declare class Bug extends Fatal {
+    constructor(message: Message, tryMessage?: TokenItem | null);
+}
+/**
+ * A function that handles errors that blow up in the CLI.
+ * @param error - Error to be handled.
+ * @returns A promise that resolves with the error passed.
+ */
+export declare function handler(error: unknown): Promise<unknown>;
+export declare function mapper(error: unknown): Promise<unknown>;
+export declare function isFatal(error: unknown): error is Fatal;
+export declare function shouldReport(error: unknown): boolean;
+/**
+ * Stack traces usually have file:// - we strip that and also remove the Windows drive designation
+ *
+ */
+export declare function cleanSingleStackTracePath(filePath: string): string;

package/dist/error.js

@@ -0,0 +1,143 @@
+import { stringifyMessage, TokenizedString } from './output.js';
+import { normalize } from './path.js';
+import { renderFatalError } from './public/node/ui.js';
+import { Errors } from '@oclif/core';
+export { ExtendableError } from 'ts-error';
+var FatalErrorType;
+(function (FatalErrorType) {
+    FatalErrorType[FatalErrorType["Abort"] = 0] = "Abort";
+    FatalErrorType[FatalErrorType["AbortSilent"] = 1] = "AbortSilent";
+    FatalErrorType[FatalErrorType["Bug"] = 2] = "Bug";
+})(FatalErrorType || (FatalErrorType = {}));
+export class CancelExecution extends Error {
+}
+/**
+ * A fatal error represents an error shouldn't be rescued and that causes the execution to terminate.
+ * There shouldn't be code that catches fatal errors.
+ */
+export class Fatal extends Error {
+    /**
+     *
+     * @param message - The error message
+     * @param type - The type of fatal error
+     * @param tryMessage - The message that recommends next steps to the user.
+     *                     You can pass a string a {@link TokenizedString} or a {@link TokenItem}
+     *                     if you need to style the message inside the error Banner component.
+     */
+    constructor(message, type, tryMessage = null, nextSteps) {
+        super(stringifyMessage(message));
+        if (tryMessage) {
+            if (tryMessage instanceof TokenizedString) {
+                this.tryMessage = stringifyMessage(tryMessage);
+            }
+            else {
+                this.tryMessage = tryMessage;
+            }
+        }
+        else {
+            this.tryMessage = null;
+        }
+        this.type = type;
+        this.nextSteps = nextSteps;
+    }
+}
+/**
+ * An abort error is a fatal error that shouldn't be reported as a bug.
+ * Those usually represent unexpected scenarios that we can't handle and that usually require some action from the developer
+ */
+export class Abort extends Fatal {
+    constructor(message, tryMessage = null, nextSteps) {
+        super(message, FatalErrorType.Abort, tryMessage, nextSteps);
+    }
+}
+/**
+ * An external error is similar to Abort but has extra command and args attributes.
+ * This is useful to represent errors coming from external commands, usually executed by execa.
+ */
+export class ExternalError extends Fatal {
+    constructor(message, command, args, tryMessage = null) {
+        super(message, FatalErrorType.Abort, tryMessage);
+        this.command = command;
+        this.args = args;
+    }
+}
+export class AbortSilent extends Fatal {
+    constructor() {
+        super('', FatalErrorType.AbortSilent);
+    }
+}
+/**
+ * A bug error is an error that represents a bug and therefore should be reported.
+ */
+export class Bug extends Fatal {
+    constructor(message, tryMessage = null) {
+        super(message, FatalErrorType.Bug, tryMessage);
+    }
+}
+/**
+ * A function that handles errors that blow up in the CLI.
+ * @param error - Error to be handled.
+ * @returns A promise that resolves with the error passed.
+ */
+export async function handler(error) {
+    let fatal;
+    if (isFatal(error)) {
+        fatal = error;
+    }
+    else if (typeof error === 'string') {
+        fatal = new Bug(error);
+    }
+    else if (error instanceof Error) {
+        fatal = new Bug(error.message);
+        fatal.stack = error.stack;
+    }
+    else {
+        // errors can come in all shapes and sizes...
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const maybeError = error;
+        fatal = new Bug(maybeError?.message ?? 'Unknown error');
+        if (maybeError?.stack) {
+            fatal.stack = maybeError?.stack;
+        }
+    }
+    renderFatalError(fatal);
+    return Promise.resolve(error);
+}
+export function mapper(error) {
+    if (error instanceof Errors.CLIError) {
+        const mappedError = new Abort(error.message);
+        mappedError.stack = error.stack;
+        return Promise.resolve(mappedError);
+    }
+    else {
+        return Promise.resolve(error);
+    }
+}
+export function isFatal(error) {
+    try {
+        return Object.prototype.hasOwnProperty.call(error, 'type');
+        // eslint-disable-next-line no-catch-all/no-catch-all
+    }
+    catch {
+        return false;
+    }
+}
+export function shouldReport(error) {
+    if (!isFatal(error)) {
+        return true;
+    }
+    if (error.type === FatalErrorType.Bug) {
+        return true;
+    }
+    return false;
+}
+/**
+ * Stack traces usually have file:// - we strip that and also remove the Windows drive designation
+ *
+ */
+export function cleanSingleStackTracePath(filePath) {
+    return normalize(filePath)
+        .replace('file:/', '/')
+        .replace(/^\/?[A-Z]:/, '');
+}
+//# sourceMappingURL=error.js.map

package/dist/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,gBAAgB,EAAE,eAAe,EAAC,MAAM,aAAa,CAAA;AACtE,OAAO,EAAC,SAAS,EAAC,MAAM,WAAW,CAAA;AACnC,OAAO,EAAC,gBAAgB,EAAC,MAAM,qBAAqB,CAAA;AAEpD,OAAO,EAAC,MAAM,EAAC,MAAM,aAAa,CAAA;AAElC,OAAO,EAAC,eAAe,EAAC,MAAM,UAAU,CAAA;AAExC,IAAK,cAIJ;AAJD,WAAK,cAAc;IACjB,qDAAK,CAAA;IACL,iEAAW,CAAA;IACX,iDAAG,CAAA;AACL,CAAC,EAJI,cAAc,KAAd,cAAc,QAIlB;AAED,MAAM,OAAO,eAAgB,SAAQ,KAAK;CAAG;AAE7C;;;GAGG;AACH,MAAM,OAAgB,KAAM,SAAQ,KAAK;IAIvC;;;;;;;OAOG;IACH,YACE,OAAgB,EAChB,IAAoB,EACpB,aAAyC,IAAI,EAC7C,SAAuB;QAEvB,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAA;QAEhC,IAAI,UAAU,EAAE;YACd,IAAI,UAAU,YAAY,eAAe,EAAE;gBACzC,IAAI,CAAC,UAAU,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAA;aAC/C;iBAAM;gBACL,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;aAC7B;SACF;aAAM;YACL,IAAI,CAAC,UAAU,GAAG,IAAI,CAAA;SACvB;QAED,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,KAAM,SAAQ,KAAK;IAE9B,YAAY,OAAgB,EAAE,aAAyC,IAAI,EAAE,SAAuB;QAClG,KAAK,CAAC,OAAO,EAAE,cAAc,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,CAAC,CAAA;IAC7D,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,aAAc,SAAQ,KAAK;IAItC,YAAY,OAAgB,EAAE,OAAe,EAAE,IAAc,EAAE,aAAyC,IAAI;QAC1G,KAAK,CAAC,OAAO,EAAE,cAAc,CAAC,KAAK,EAAE,UAAU,CAAC,CAAA;QAChD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;CACF;AAED,MAAM,OAAO,WAAY,SAAQ,KAAK;IACpC;QACE,KAAK,CAAC,EAAE,EAAE,cAAc,CAAC,WAAW,CAAC,CAAA;IACvC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,GAAI,SAAQ,KAAK;IAC5B,YAAY,OAAgB,EAAE,aAA+B,IAAI;QAC/D,KAAK,CAAC,OAAO,EAAE,cAAc,CAAC,GAAG,EAAE,UAAU,CAAC,CAAA;IAChD,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,KAAc;IAC1C,IAAI,KAAY,CAAA;IAChB,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE;QAClB,KAAK,GAAG,KAAK,CAAA;KACd;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QACpC,KAAK,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAA;KACvB;SAAM,IAAI,KAAK,YAAY,KAAK,EAAE;QACjC,KAAK,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QAC9B,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAA;KAC1B;SAAM;QACL,6CAA6C;QAC7C,8DAA8D;QAC9D,MAAM,UAAU,GAAG,KAAY,CAAA;QAC/B,KAAK,GAAG,IAAI,GAAG,CAAC,UAAU,EAAE,OAAO,IAAI,eAAe,CAAC,CAAA;QACvD,IAAI,UAAU,EAAE,KAAK,EAAE;YACrB,KAAK,CAAC,KAAK,GAAG,UAAU,EAAE,KAAK,CAAA;SAChC;KACF;IAED,gBAAgB,CAAC,KAAK,CAAC,CAAA;IACvB,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;AAC/B,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,KAAc;IACnC,IAAI,KAAK,YAAY,MAAM,CAAC,QAAQ,EAAE;QACpC,MAAM,WAAW,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QAC5C,WAAW,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAA;QAC/B,OAAO,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;KACpC;SAAM;QACL,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;KAC9B;AACH,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,KAAc;IACpC,IAAI;QACF,OAAO,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;QAC1D,qDAAqD;KACtD;IAAC,MAAM;QACN,OAAO,KAAK,CAAA;KACb;AACH,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,KAAc;IACzC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACnB,OAAO,IAAI,CAAA;KACZ;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,CAAC,GAAG,EAAE;QACrC,OAAO,IAAI,CAAA;KACZ;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,yBAAyB,CAAC,QAAgB;IACxD,OAAO,SAAS,CAAC,QAAQ,CAAC;SACvB,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC;SACtB,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAA;AAC9B,CAAC","sourcesContent":["import {Message, stringifyMessage, TokenizedString} from './output.js'\nimport {normalize} from './path.js'\nimport {renderFatalError} from './public/node/ui.js'\nimport {TokenItem} from './private/node/ui/components/TokenizedText.js'\nimport {Errors} from '@oclif/core'\n\nexport {ExtendableError} from 'ts-error'\n\nenum FatalErrorType {\n  Abort,\n  AbortSilent,\n  Bug,\n}\n\nexport class CancelExecution extends Error {}\n\n/**\n * A fatal error represents an error shouldn't be rescued and that causes the execution to terminate.\n * There shouldn't be code that catches fatal errors.\n */\nexport abstract class Fatal extends Error {\n  tryMessage: TokenItem | null\n  type: FatalErrorType\n  nextSteps?: TokenItem[]\n  /**\n   *\n   * @param message - The error message\n   * @param type - The type of fatal error\n   * @param tryMessage - The message that recommends next steps to the user.\n   *                     You can pass a string a {@link TokenizedString} or a {@link TokenItem}\n   *                     if you need to style the message inside the error Banner component.\n   */\n  constructor(\n    message: Message,\n    type: FatalErrorType,\n    tryMessage: TokenItem | Message | null = null,\n    nextSteps?: TokenItem[],\n  ) {\n    super(stringifyMessage(message))\n\n    if (tryMessage) {\n      if (tryMessage instanceof TokenizedString) {\n        this.tryMessage = stringifyMessage(tryMessage)\n      } else {\n        this.tryMessage = tryMessage\n      }\n    } else {\n      this.tryMessage = null\n    }\n\n    this.type = type\n    this.nextSteps = nextSteps\n  }\n}\n\n/**\n * An abort error is a fatal error that shouldn't be reported as a bug.\n * Those usually represent unexpected scenarios that we can't handle and that usually require some action from the developer\n */\nexport class Abort extends Fatal {\n  nextSteps?: TokenItem[]\n  constructor(message: Message, tryMessage: TokenItem | Message | null = null, nextSteps?: TokenItem[]) {\n    super(message, FatalErrorType.Abort, tryMessage, nextSteps)\n  }\n}\n\n/**\n * An external error is similar to Abort but has extra command and args attributes.\n * This is useful to represent errors coming from external commands, usually executed by execa.\n */\nexport class ExternalError extends Fatal {\n  command: string\n  args: string[]\n\n  constructor(message: Message, command: string, args: string[], tryMessage: TokenItem | Message | null = null) {\n    super(message, FatalErrorType.Abort, tryMessage)\n    this.command = command\n    this.args = args\n  }\n}\n\nexport class AbortSilent extends Fatal {\n  constructor() {\n    super('', FatalErrorType.AbortSilent)\n  }\n}\n\n/**\n * A bug error is an error that represents a bug and therefore should be reported.\n */\nexport class Bug extends Fatal {\n  constructor(message: Message, tryMessage: TokenItem | null = null) {\n    super(message, FatalErrorType.Bug, tryMessage)\n  }\n}\n\n/**\n * A function that handles errors that blow up in the CLI.\n * @param error - Error to be handled.\n * @returns A promise that resolves with the error passed.\n */\nexport async function handler(error: unknown): Promise<unknown> {\n  let fatal: Fatal\n  if (isFatal(error)) {\n    fatal = error\n  } else if (typeof error === 'string') {\n    fatal = new Bug(error)\n  } else if (error instanceof Error) {\n    fatal = new Bug(error.message)\n    fatal.stack = error.stack\n  } else {\n    // errors can come in all shapes and sizes...\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    const maybeError = error as any\n    fatal = new Bug(maybeError?.message ?? 'Unknown error')\n    if (maybeError?.stack) {\n      fatal.stack = maybeError?.stack\n    }\n  }\n\n  renderFatalError(fatal)\n  return Promise.resolve(error)\n}\n\nexport function mapper(error: unknown): Promise<unknown> {\n  if (error instanceof Errors.CLIError) {\n    const mappedError = new Abort(error.message)\n    mappedError.stack = error.stack\n    return Promise.resolve(mappedError)\n  } else {\n    return Promise.resolve(error)\n  }\n}\n\nexport function isFatal(error: unknown): error is Fatal {\n  try {\n    return Object.prototype.hasOwnProperty.call(error, 'type')\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch {\n    return false\n  }\n}\n\nexport function shouldReport(error: unknown): boolean {\n  if (!isFatal(error)) {\n    return true\n  }\n  if (error.type === FatalErrorType.Bug) {\n    return true\n  }\n  return false\n}\n\n/**\n * Stack traces usually have file:// - we strip that and also remove the Windows drive designation\n *\n */\nexport function cleanSingleStackTracePath(filePath: string): string {\n  return normalize(filePath)\n    .replace('file:/', '/')\n    .replace(/^\\/?[A-Z]:/, '')\n}\n"]}

package/dist/file.d.ts

@@ -0,0 +1,98 @@
+/// <reference types="node" />
+/// <reference types="node" />
+export declare function stripUp(path: string, strip: number): string;
+/**
+ * Creates a temporary directory and ties its lifecycle to the lifecycle of the callback.
+ * @param callback - The callback that receives the temporary directory.
+ */
+export declare function inTemporaryDirectory<T>(callback: (tmpDir: string) => T | Promise<T>): Promise<T>;
+/**
+ * It reads a file and returns its content as a string using the
+ * utf-8 encoding
+ * @param path - Path to the file to read.
+ * @returns A promise that resolves with the content of the file.
+ */
+export declare type ReadOptions = undefined | {
+    flag?: string | undefined;
+} | {
+    encoding: BufferEncoding | string;
+    flag?: string | undefined;
+};
+export declare function read(path: string, options?: ReadOptions): Promise<string>;
+export declare function read(path: string, options?: ReadOptions): Promise<Buffer>;
+/**
+ * Given a path, it determines the actual path. This is useful when working
+ * with paths that represent symlinks.
+ * @param path - Path whose real path will be returned.
+ */
+export declare function realpath(path: string): Promise<string>;
+export declare function readSync(path: string, options?: object): string;
+/**
+ * Copies a file
+ * @param from - Path to the directory or file to be copied.
+ * @param to - Destination path.
+ */
+export declare function copy(from: string, to: string): Promise<void>;
+export declare function touch(path: string): Promise<void>;
+export declare function appendFile(path: string, content: string): Promise<void>;
+export declare function touchSync(path: string): void;
+export declare function write(path: string, data: string): Promise<void>;
+export declare function writeSync(path: string, data: string): void;
+export declare function append(path: string, data: string): Promise<void>;
+export declare function appendSync(path: string, data: string): void;
+export declare function mkdir(path: string): Promise<void>;
+export declare function mkdirSync(path: string): void;
+export declare function remove(path: string): Promise<void>;
+export declare function removeSync(path: string): void;
+export declare function rmdir(path: string, { force }?: {
+    force?: boolean;
+}): Promise<void>;
+export declare function mkTmpDir(): Promise<string>;
+export declare function isDirectory(path: string): Promise<boolean>;
+export declare function size(path: string): Promise<number>;
+export declare function sizeSync(path: string): number;
+export declare function createReadStream(path: string): import("fs").ReadStream;
+/**
+ * Returns the Date object for the last modification of a file.
+ * @param path - Path to the directory or file.
+ * @returns A unix timestamp.
+ */
+export declare function lastUpdated(path: string): Promise<Date>;
+/**
+ * Returns the unix timestamp of the last modification of a file.
+ * @param path - Path to the directory or file.
+ * @returns A unix timestamp.
+ */
+export declare function lastUpdatedTimestamp(path: string): Promise<number | undefined>;
+/**
+ * Moves a file.
+ * @param src - File to be moved.
+ * @param dest - Path to be moved to.
+ * @param options - Moving options.
+ */
+export declare function move(src: string, dest: string, options?: {
+    overwrite?: boolean;
+}): Promise<void>;
+/**
+ * Changes the permissions of a directory or file.
+ * @param path - Path to the file or directory whose permissions will be modified.
+ * @param mode - Permissions to set to the file or directory.
+ */
+export declare function chmod(path: string, mode: number | string): Promise<void>;
+/**
+ * Checks if a file has executable permissions.
+ * @param path - Path to the file whose permissions will be checked.
+ */
+export declare function hasExecutablePermissions(path: string): Promise<boolean>;
+/**
+ * Returns true if a file or directory exists
+ * @param path - Path to the directory or file.
+ * @returns True if it exists.
+ */
+export declare function exists(path: string): Promise<boolean>;
+/**
+ * Format a string using prettier. Return the formatted content.
+ */
+export declare function format(content: string, options: {
+    path: string;
+}): Promise<string>;