@shopify/cli-kit 0.0.0-nightly-20230110194301

package/dist/public/node/error-handler.js

@@ -0,0 +1,198 @@
+import { reportAnalyticsEvent } from './analytics.js';
+import { getEnvironmentData } from '../../private/node/analytics.js';
+import { AbortSilent, CancelExecution, mapper as errorMapper, shouldReport as shouldReportError, handler, cleanSingleStackTracePath, } from '../../error.js';
+import { debug, info } from '../../output.js';
+import * as path from '../../path.js';
+import * as metadata from '../../metadata.js';
+import { fanoutHooks } from '../../plugins.js';
+import constants, { bugsnagApiKey } from '../../constants.js';
+import { settings } from '@oclif/core';
+import StackTracey from 'stacktracey';
+import Bugsnag from '@bugsnag/js';
+import { realpath } from 'fs/promises';
+export function errorHandler(error, config) {
+    if (error instanceof CancelExecution) {
+        if (error.message && error.message !== '') {
+            info(`✨  ${error.message}`);
+        }
+    }
+    else if (error instanceof AbortSilent) {
+        process.exit(1);
+    }
+    else {
+        return errorMapper(error)
+            .then((error) => {
+            return handler(error);
+        })
+            .then((mappedError) => reportError(mappedError, config))
+            .then(() => {
+            process.exit(1);
+        });
+    }
+}
+const reportError = async (error, config) => {
+    if (config !== undefined) {
+        // Log an analytics event when there's an error
+        await reportAnalyticsEvent({ config, errorMessage: error instanceof Error ? error.message : undefined });
+    }
+    await sendErrorToBugsnag(error);
+};
+/**
+ * Sends an error to Bugsnag. This is configured automatically for uncaught errors from CLI commands, but can also be used to manually record an error.
+ *
+ * @returns the reported error (this may have been tweaked for better reporting), and a bool to indicate if the error was actually submitted or not
+ */
+export async function sendErrorToBugsnag(error) {
+    if (settings.debug || !shouldReportError(error))
+        return { reported: false, error };
+    let reportableError;
+    let stacktrace;
+    let report = false;
+    if (error instanceof Error) {
+        report = true;
+        reportableError = new Error(error.message);
+        stacktrace = error.stack;
+        /**
+         * Some errors that reach this point have an empty string. For example:
+         * https://app.bugsnag.com/shopify/cli/errors/62cd5d31fd5040000814086c?filters[event.since]=30d&filters[error.status]=new&filters[release.seen_in]=3.1.0
+         *
+         * Because at this point we have neither the error message nor a stack trace reporting them
+         * to Bugsnag is pointless and adds noise.
+         */
+    }
+    else if (typeof error === 'string' && error.trim().length !== 0) {
+        report = true;
+        reportableError = new Error(error);
+        stacktrace = reportableError.stack;
+    }
+    else {
+        report = false;
+        reportableError = new Error('Unknown error');
+    }
+    const formattedStacktrace = new StackTracey(stacktrace ?? '')
+        .clean()
+        .items.map((item) => {
+        const filePath = cleanSingleStackTracePath(item.file);
+        return `    at ${item.callee} (${filePath}:${item.line}:${item.column})`;
+    })
+        .join('\n');
+    reportableError.stack = `Error: ${reportableError.message}\n${formattedStacktrace}`;
+    if (report) {
+        await initializeBugsnag();
+        await new Promise((resolve, reject) => {
+            Bugsnag.notify(reportableError, undefined, (error, event) => {
+                if (error) {
+                    reject(error);
+                }
+                else {
+                    resolve(reportableError);
+                }
+            });
+        });
+    }
+    return { error: reportableError, reported: report };
+}
+/**
+ * If the given file path is within a node_modules folder, remove prefix up
+ * to and including the node_modules folder.
+ *
+ * This gives us very consistent paths for errors generated by the CLI.
+ */
+export function cleanStackFrameFilePath({ currentFilePath, projectRoot, pluginLocations, }) {
+    const fullLocation = path.isAbsolute(currentFilePath) ? currentFilePath : path.join(projectRoot, currentFilePath);
+    const matchingPluginPath = pluginLocations.filter(({ pluginPath }) => fullLocation.indexOf(pluginPath) === 0)[0];
+    if (matchingPluginPath !== undefined) {
+        // the plugin name (e.g. @shopify/cli-kit), plus the relative path of the error line from within the plugin's code (e.g. dist/something.js )
+        return path.join(matchingPluginPath.name, path.relative(matchingPluginPath.pluginPath, fullLocation));
+    }
+    // strip prefix up to node_modules folder, so we can normalize error reporting
+    return currentFilePath.replace(/.*node_modules\//, '');
+}
+/**
+ * Register a Bugsnag error listener to clean up stack traces for errors within plugin code.
+ *
+ */
+export async function registerCleanBugsnagErrorsFromWithinPlugins(config) {
+    // Bugsnag have their own plug-ins that use this private field
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const bugsnagConfigProjectRoot = Bugsnag?._client?._config?.projectRoot ?? process.cwd();
+    const projectRoot = path.normalize(bugsnagConfigProjectRoot);
+    const pluginLocations = await Promise.all(config.plugins.map(async (plugin) => {
+        const followSymlinks = await realpath(plugin.root);
+        return { name: plugin.name, pluginPath: path.normalize(followSymlinks) };
+    }));
+    await initializeBugsnag();
+    Bugsnag.addOnError(async (event) => {
+        event.errors.forEach((error) => {
+            error.stacktrace.forEach((stackFrame) => {
+                stackFrame.file = cleanStackFrameFilePath({ currentFilePath: stackFrame.file, projectRoot, pluginLocations });
+            });
+        });
+        try {
+            await addBugsnagMetadata(event, config);
+            // eslint-disable-next-line no-catch-all/no-catch-all
+        }
+        catch (metadataError) {
+            debug(`There was an error adding metadata to the Bugsnag report; Ignoring and carrying on ${metadataError}`);
+        }
+    });
+}
+export async function addBugsnagMetadata(event, config) {
+    const publicData = metadata.getAllPublic();
+    const { commandStartOptions } = metadata.getAllSensitive();
+    const { startCommand } = commandStartOptions ?? {};
+    const { '@shopify/app': appPublic, ...otherPluginsPublic } = await fanoutHooks(config, 'public_command_metadata', {});
+    const environment = await getEnvironmentData(config);
+    const allMetadata = {
+        command: startCommand,
+        ...appPublic,
+        ...publicData,
+        ...environment,
+        pluginData: otherPluginsPublic,
+    };
+    const appData = {};
+    const commandData = {};
+    const environmentData = {};
+    const miscData = {};
+    const appKeys = ['api_key', 'partner_id', 'project_type'];
+    const commandKeys = ['command'];
+    const environmentKeys = ['cli_version', 'node_version', 'ruby_version', 'uname'];
+    Object.entries(allMetadata).forEach(([key, value]) => {
+        if (key.startsWith('app_') || appKeys.includes(key)) {
+            appData[key] = value;
+        }
+        else if (key.startsWith('cmd_') || commandKeys.includes(key)) {
+            commandData[key] = value;
+        }
+        else if (key.startsWith('env_') || environmentKeys) {
+            environmentData[key] = value;
+        }
+        else {
+            miscData[key] = value;
+        }
+    });
+    // app, command, environment, misc
+    const bugsnagMetadata = {
+        'Shopify App': appData,
+        Command: commandData,
+        Environment: environmentData,
+        Misc: miscData,
+    };
+    Object.entries(bugsnagMetadata).forEach(([section, values]) => {
+        event.addMetadata(section, values);
+    });
+}
+async function initializeBugsnag() {
+    if (Bugsnag.isStarted()) {
+        return;
+    }
+    Bugsnag.start({
+        appType: 'node',
+        apiKey: bugsnagApiKey,
+        logger: null,
+        appVersion: await constants.versions.cliKit(),
+        autoTrackSessions: false,
+        autoDetectErrors: false,
+    });
+}
+//# sourceMappingURL=error-handler.js.map

package/dist/public/node/error-handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-handler.js","sourceRoot":"","sources":["../../../src/public/node/error-handler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,oBAAoB,EAAC,MAAM,gBAAgB,CAAA;AACnD,OAAO,EAAC,kBAAkB,EAAC,MAAM,iCAAiC,CAAA;AAClE,OAAO,EACL,WAAW,EACX,eAAe,EACf,MAAM,IAAI,WAAW,EACrB,YAAY,IAAI,iBAAiB,EACjC,OAAO,EACP,yBAAyB,GAC1B,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAC,KAAK,EAAE,IAAI,EAAC,MAAM,iBAAiB,CAAA;AAC3C,OAAO,KAAK,IAAI,MAAM,eAAe,CAAA;AACrC,OAAO,KAAK,QAAQ,MAAM,mBAAmB,CAAA;AAC7C,OAAO,EAAC,WAAW,EAAC,MAAM,kBAAkB,CAAA;AAC5C,OAAO,SAAS,EAAE,EAAC,aAAa,EAAC,MAAM,oBAAoB,CAAA;AAC3D,OAAO,EAAC,QAAQ,EAAa,MAAM,aAAa,CAAA;AAChD,OAAO,WAAW,MAAM,aAAa,CAAA;AACrC,OAAO,OAAgB,MAAM,aAAa,CAAA;AAC1C,OAAO,EAAC,QAAQ,EAAC,MAAM,aAAa,CAAA;AAOpC,MAAM,UAAU,YAAY,CAAC,KAA8C,EAAE,MAA0B;IACrG,IAAI,KAAK,YAAY,eAAe,EAAE;QACpC,IAAI,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,KAAK,EAAE,EAAE;YACzC,IAAI,CAAC,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;SAC5B;KACF;SAAM,IAAI,KAAK,YAAY,WAAW,EAAE;QACvC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;KAChB;SAAM;QACL,OAAO,WAAW,CAAC,KAAK,CAAC;aACtB,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;YACd,OAAO,OAAO,CAAC,KAAK,CAAC,CAAA;QACvB,CAAC,CAAC;aACD,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;aACvD,IAAI,CAAC,GAAG,EAAE;YACT,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACjB,CAAC,CAAC,CAAA;KACL;AACH,CAAC;AAED,MAAM,WAAW,GAAG,KAAK,EAAE,KAAc,EAAE,MAA0B,EAAiB,EAAE;IACtF,IAAI,MAAM,KAAK,SAAS,EAAE;QACxB,+CAA+C;QAC/C,MAAM,oBAAoB,CAAC,EAAC,MAAM,EAAE,YAAY,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,EAAC,CAAC,CAAA;KACvG;IACD,MAAM,kBAAkB,CAAC,KAAK,CAAC,CAAA;AACjC,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,KAAc;IAEd,IAAI,QAAQ,CAAC,KAAK,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC;QAAE,OAAO,EAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAC,CAAA;IAEhF,IAAI,eAAsB,CAAA;IAC1B,IAAI,UAA8B,CAAA;IAClC,IAAI,MAAM,GAAG,KAAK,CAAA;IAElB,IAAI,KAAK,YAAY,KAAK,EAAE;QAC1B,MAAM,GAAG,IAAI,CAAA;QACb,eAAe,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QAC1C,UAAU,GAAG,KAAK,CAAC,KAAK,CAAA;QAExB;;;;;;WAMG;KACJ;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE;QACjE,MAAM,GAAG,IAAI,CAAA;QACb,eAAe,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,CAAA;QAClC,UAAU,GAAG,eAAe,CAAC,KAAK,CAAA;KACnC;SAAM;QACL,MAAM,GAAG,KAAK,CAAA;QACd,eAAe,GAAG,IAAI,KAAK,CAAC,eAAe,CAAC,CAAA;KAC7C;IAED,MAAM,mBAAmB,GAAG,IAAI,WAAW,CAAC,UAAU,IAAI,EAAE,CAAC;SAC1D,KAAK,EAAE;SACP,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QAClB,MAAM,QAAQ,GAAG,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACrD,OAAO,UAAU,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAA;IAC1E,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAA;IACb,eAAe,CAAC,KAAK,GAAG,UAAU,eAAe,CAAC,OAAO,KAAK,mBAAmB,EAAE,CAAA;IAEnF,IAAI,MAAM,EAAE;QACV,MAAM,iBAAiB,EAAE,CAAA;QACzB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACpC,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;gBAC1D,IAAI,KAAK,EAAE;oBACT,MAAM,CAAC,KAAK,CAAC,CAAA;iBACd;qBAAM;oBACL,OAAO,CAAC,eAAe,CAAC,CAAA;iBACzB;YACH,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;KACH;IACD,OAAO,EAAC,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,EAAC,CAAA;AACnD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CAAC,EACtC,eAAe,EACf,WAAW,EACX,eAAe,GAKhB;IACC,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,eAAe,CAAC,CAAA;IAEjH,MAAM,kBAAkB,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,EAAC,UAAU,EAAC,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAE9G,IAAI,kBAAkB,KAAK,SAAS,EAAE;QACpC,4IAA4I;QAC5I,OAAO,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,CAAA;KACtG;IAED,8EAA8E;IAC9E,OAAO,eAAe,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAA;AACxD,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,2CAA2C,CAAC,MAAyB;IACzF,8DAA8D;IAC9D,8DAA8D;IAC9D,MAAM,wBAAwB,GAAY,OAAe,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,IAAI,OAAO,CAAC,GAAG,EAAE,CAAA;IACzG,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,wBAAwB,CAAC,CAAA;IAC5D,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,GAAG,CACvC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;QAClC,MAAM,cAAc,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QAClD,OAAO,EAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,EAAC,CAAA;IACxE,CAAC,CAAC,CACH,CAAA;IACD,MAAM,iBAAiB,EAAE,CAAA;IACzB,OAAO,CAAC,UAAU,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QACjC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC7B,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;gBACtC,UAAU,CAAC,IAAI,GAAG,uBAAuB,CAAC,EAAC,eAAe,EAAE,UAAU,CAAC,IAAI,EAAE,WAAW,EAAE,eAAe,EAAC,CAAC,CAAA;YAC7G,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QACF,IAAI;YACF,MAAM,kBAAkB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;YACvC,qDAAqD;SACtD;QAAC,OAAO,aAAa,EAAE;YACtB,KAAK,CAAC,sFAAsF,aAAa,EAAE,CAAC,CAAA;SAC7G;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,KAAY,EAAE,MAAyB;IAC9E,MAAM,UAAU,GAAG,QAAQ,CAAC,YAAY,EAAE,CAAA;IAC1C,MAAM,EAAC,mBAAmB,EAAC,GAAG,QAAQ,CAAC,eAAe,EAAE,CAAA;IACxD,MAAM,EAAC,YAAY,EAAC,GAAG,mBAAmB,IAAI,EAAE,CAAA;IAEhD,MAAM,EAAC,cAAc,EAAE,SAAS,EAAE,GAAG,kBAAkB,EAAC,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,yBAAyB,EAAE,EAAE,CAAC,CAAA;IAEnH,MAAM,WAAW,GAAG,MAAM,kBAAkB,CAAC,MAAM,CAAC,CAAA;IAEpD,MAAM,WAAW,GAAG;QAClB,OAAO,EAAE,YAAY;QACrB,GAAG,SAAS;QACZ,GAAG,UAAU;QACb,GAAG,WAAW;QACd,UAAU,EAAE,kBAAkB;KAC/B,CAAA;IAED,MAAM,OAAO,GAAG,EAA8B,CAAA;IAC9C,MAAM,WAAW,GAAG,EAA8B,CAAA;IAClD,MAAM,eAAe,GAAG,EAA8B,CAAA;IACtD,MAAM,QAAQ,GAAG,EAA8B,CAAA;IAC/C,MAAM,OAAO,GAAG,CAAC,SAAS,EAAE,YAAY,EAAE,cAAc,CAAC,CAAA;IACzD,MAAM,WAAW,GAAG,CAAC,SAAS,CAAC,CAAA;IAC/B,MAAM,eAAe,GAAG,CAAC,aAAa,EAAE,cAAc,EAAE,cAAc,EAAE,OAAO,CAAC,CAAA;IAEhF,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACnD,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACnD,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;SACrB;aAAM,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC9D,WAAW,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;SACzB;aAAM,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,eAAe,EAAE;YACpD,eAAe,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;SAC7B;aAAM;YACL,QAAQ,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;SACtB;IACH,CAAC,CAAC,CAAA;IAEF,kCAAkC;IAClC,MAAM,eAAe,GAAG;QACtB,aAAa,EAAE,OAAO;QACtB,OAAO,EAAE,WAAW;QACpB,WAAW,EAAE,eAAe;QAC5B,IAAI,EAAE,QAAQ;KACf,CAAA;IACD,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,EAAE;QAC5D,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;IACpC,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,KAAK,UAAU,iBAAiB;IAC9B,IAAI,OAAO,CAAC,SAAS,EAAE,EAAE;QACvB,OAAM;KACP;IACD,OAAO,CAAC,KAAK,CAAC;QACZ,OAAO,EAAE,MAAM;QACf,MAAM,EAAE,aAAa;QACrB,MAAM,EAAE,IAAI;QACZ,UAAU,EAAE,MAAM,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;QAC7C,iBAAiB,EAAE,KAAK;QACxB,gBAAgB,EAAE,KAAK;KACxB,CAAC,CAAA;AACJ,CAAC","sourcesContent":["import {reportAnalyticsEvent} from './analytics.js'\nimport {getEnvironmentData} from '../../private/node/analytics.js'\nimport {\n  AbortSilent,\n  CancelExecution,\n  mapper as errorMapper,\n  shouldReport as shouldReportError,\n  handler,\n  cleanSingleStackTracePath,\n} from '../../error.js'\nimport {debug, info} from '../../output.js'\nimport * as path from '../../path.js'\nimport * as metadata from '../../metadata.js'\nimport {fanoutHooks} from '../../plugins.js'\nimport constants, {bugsnagApiKey} from '../../constants.js'\nimport {settings, Interfaces} from '@oclif/core'\nimport StackTracey from 'stacktracey'\nimport Bugsnag, {Event} from '@bugsnag/js'\nimport {realpath} from 'fs/promises'\n\nexport function errorHandler(\n  error: (CancelExecution | AbortSilent) & {exitCode?: number | undefined},\n  config?: Interfaces.Config,\n): void\nexport function errorHandler(error: Error & {exitCode?: number | undefined}, config?: Interfaces.Config): Promise<void>\nexport function errorHandler(error: Error & {exitCode?: number | undefined}, config?: Interfaces.Config): unknown {\n  if (error instanceof CancelExecution) {\n    if (error.message && error.message !== '') {\n      info(`✨  ${error.message}`)\n    }\n  } else if (error instanceof AbortSilent) {\n    process.exit(1)\n  } else {\n    return errorMapper(error)\n      .then((error) => {\n        return handler(error)\n      })\n      .then((mappedError) => reportError(mappedError, config))\n      .then(() => {\n        process.exit(1)\n      })\n  }\n}\n\nconst reportError = async (error: unknown, config?: Interfaces.Config): Promise<void> => {\n  if (config !== undefined) {\n    // Log an analytics event when there's an error\n    await reportAnalyticsEvent({config, errorMessage: error instanceof Error ? error.message : undefined})\n  }\n  await sendErrorToBugsnag(error)\n}\n\n/**\n * Sends an error to Bugsnag. This is configured automatically for uncaught errors from CLI commands, but can also be used to manually record an error.\n *\n * @returns the reported error (this may have been tweaked for better reporting), and a bool to indicate if the error was actually submitted or not\n */\nexport async function sendErrorToBugsnag(\n  error: unknown,\n): Promise<{reported: false; error: unknown} | {error: Error; reported: true}> {\n  if (settings.debug || !shouldReportError(error)) return {reported: false, error}\n\n  let reportableError: Error\n  let stacktrace: string | undefined\n  let report = false\n\n  if (error instanceof Error) {\n    report = true\n    reportableError = new Error(error.message)\n    stacktrace = error.stack\n\n    /**\n     * Some errors that reach this point have an empty string. For example:\n     * https://app.bugsnag.com/shopify/cli/errors/62cd5d31fd5040000814086c?filters[event.since]=30d&filters[error.status]=new&filters[release.seen_in]=3.1.0\n     *\n     * Because at this point we have neither the error message nor a stack trace reporting them\n     * to Bugsnag is pointless and adds noise.\n     */\n  } else if (typeof error === 'string' && error.trim().length !== 0) {\n    report = true\n    reportableError = new Error(error)\n    stacktrace = reportableError.stack\n  } else {\n    report = false\n    reportableError = new Error('Unknown error')\n  }\n\n  const formattedStacktrace = new StackTracey(stacktrace ?? '')\n    .clean()\n    .items.map((item) => {\n      const filePath = cleanSingleStackTracePath(item.file)\n      return `    at ${item.callee} (${filePath}:${item.line}:${item.column})`\n    })\n    .join('\\n')\n  reportableError.stack = `Error: ${reportableError.message}\\n${formattedStacktrace}`\n\n  if (report) {\n    await initializeBugsnag()\n    await new Promise((resolve, reject) => {\n      Bugsnag.notify(reportableError, undefined, (error, event) => {\n        if (error) {\n          reject(error)\n        } else {\n          resolve(reportableError)\n        }\n      })\n    })\n  }\n  return {error: reportableError, reported: report}\n}\n\n/**\n * If the given file path is within a node_modules folder, remove prefix up\n * to and including the node_modules folder.\n *\n * This gives us very consistent paths for errors generated by the CLI.\n */\nexport function cleanStackFrameFilePath({\n  currentFilePath,\n  projectRoot,\n  pluginLocations,\n}: {\n  currentFilePath: string\n  projectRoot: string\n  pluginLocations: {name: string; pluginPath: string}[]\n}): string {\n  const fullLocation = path.isAbsolute(currentFilePath) ? currentFilePath : path.join(projectRoot, currentFilePath)\n\n  const matchingPluginPath = pluginLocations.filter(({pluginPath}) => fullLocation.indexOf(pluginPath) === 0)[0]\n\n  if (matchingPluginPath !== undefined) {\n    // the plugin name (e.g. @shopify/cli-kit), plus the relative path of the error line from within the plugin's code (e.g. dist/something.js )\n    return path.join(matchingPluginPath.name, path.relative(matchingPluginPath.pluginPath, fullLocation))\n  }\n\n  // strip prefix up to node_modules folder, so we can normalize error reporting\n  return currentFilePath.replace(/.*node_modules\\//, '')\n}\n\n/**\n * Register a Bugsnag error listener to clean up stack traces for errors within plugin code.\n *\n */\nexport async function registerCleanBugsnagErrorsFromWithinPlugins(config: Interfaces.Config): Promise<void> {\n  // Bugsnag have their own plug-ins that use this private field\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  const bugsnagConfigProjectRoot: string = (Bugsnag as any)?._client?._config?.projectRoot ?? process.cwd()\n  const projectRoot = path.normalize(bugsnagConfigProjectRoot)\n  const pluginLocations = await Promise.all(\n    config.plugins.map(async (plugin) => {\n      const followSymlinks = await realpath(plugin.root)\n      return {name: plugin.name, pluginPath: path.normalize(followSymlinks)}\n    }),\n  )\n  await initializeBugsnag()\n  Bugsnag.addOnError(async (event) => {\n    event.errors.forEach((error) => {\n      error.stacktrace.forEach((stackFrame) => {\n        stackFrame.file = cleanStackFrameFilePath({currentFilePath: stackFrame.file, projectRoot, pluginLocations})\n      })\n    })\n    try {\n      await addBugsnagMetadata(event, config)\n      // eslint-disable-next-line no-catch-all/no-catch-all\n    } catch (metadataError) {\n      debug(`There was an error adding metadata to the Bugsnag report; Ignoring and carrying on ${metadataError}`)\n    }\n  })\n}\n\nexport async function addBugsnagMetadata(event: Event, config: Interfaces.Config): Promise<void> {\n  const publicData = metadata.getAllPublic()\n  const {commandStartOptions} = metadata.getAllSensitive()\n  const {startCommand} = commandStartOptions ?? {}\n\n  const {'@shopify/app': appPublic, ...otherPluginsPublic} = await fanoutHooks(config, 'public_command_metadata', {})\n\n  const environment = await getEnvironmentData(config)\n\n  const allMetadata = {\n    command: startCommand,\n    ...appPublic,\n    ...publicData,\n    ...environment,\n    pluginData: otherPluginsPublic,\n  }\n\n  const appData = {} as {[key: string]: unknown}\n  const commandData = {} as {[key: string]: unknown}\n  const environmentData = {} as {[key: string]: unknown}\n  const miscData = {} as {[key: string]: unknown}\n  const appKeys = ['api_key', 'partner_id', 'project_type']\n  const commandKeys = ['command']\n  const environmentKeys = ['cli_version', 'node_version', 'ruby_version', 'uname']\n\n  Object.entries(allMetadata).forEach(([key, value]) => {\n    if (key.startsWith('app_') || appKeys.includes(key)) {\n      appData[key] = value\n    } else if (key.startsWith('cmd_') || commandKeys.includes(key)) {\n      commandData[key] = value\n    } else if (key.startsWith('env_') || environmentKeys) {\n      environmentData[key] = value\n    } else {\n      miscData[key] = value\n    }\n  })\n\n  // app, command, environment, misc\n  const bugsnagMetadata = {\n    'Shopify App': appData,\n    Command: commandData,\n    Environment: environmentData,\n    Misc: miscData,\n  }\n  Object.entries(bugsnagMetadata).forEach(([section, values]) => {\n    event.addMetadata(section, values)\n  })\n}\n\nasync function initializeBugsnag() {\n  if (Bugsnag.isStarted()) {\n    return\n  }\n  Bugsnag.start({\n    appType: 'node',\n    apiKey: bugsnagApiKey,\n    logger: null,\n    appVersion: await constants.versions.cliKit(),\n    autoTrackSessions: false,\n    autoDetectErrors: false,\n  })\n}\n"]}

package/dist/public/node/error.d.ts

@@ -0,0 +1,4 @@
+export { Fatal as FatalError } from '../../error.js';
+export { Abort as AbortError } from '../../error.js';
+export { Bug as BugError } from '../../error.js';
+export { AbortSilent as AbortSilentError } from '../../error.js';

package/dist/public/node/error.js

@@ -0,0 +1,5 @@
+export { Fatal as FatalError } from '../../error.js';
+export { Abort as AbortError } from '../../error.js';
+export { Bug as BugError } from '../../error.js';
+export { AbortSilent as AbortSilentError } from '../../error.js';
+//# sourceMappingURL=error.js.map

package/dist/public/node/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../../src/public/node/error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,IAAI,UAAU,EAAC,MAAM,gBAAgB,CAAA;AAClD,OAAO,EAAC,KAAK,IAAI,UAAU,EAAC,MAAM,gBAAgB,CAAA;AAClD,OAAO,EAAC,GAAG,IAAI,QAAQ,EAAC,MAAM,gBAAgB,CAAA;AAC9C,OAAO,EAAC,WAAW,IAAI,gBAAgB,EAAC,MAAM,gBAAgB,CAAA","sourcesContent":["export {Fatal as FatalError} from '../../error.js'\nexport {Abort as AbortError} from '../../error.js'\nexport {Bug as BugError} from '../../error.js'\nexport {AbortSilent as AbortSilentError} from '../../error.js'\n"]}

package/dist/public/node/framework.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Tries to identify the using of a framework analyzing the existence and/or content of different files inside a
+ * specific directory.
+ *
+ * @param rootDirectory - Directory from which the files required for each framework are searched
+ * @returns The name of the framework used or 'unknown' otherwise
+ */
+export declare function resolveFramework(rootDirectory: string): Promise<string>;

package/dist/public/node/framework.js

@@ -0,0 +1,135 @@
+import { join as pathJoin } from '../../path.js';
+import { existsSync, readFileSync } from 'fs';
+const frameworks = [
+    {
+        name: 'remix',
+        detectors: {
+            every: [
+                {
+                    path: 'package.json',
+                    matchContent: '"(dev)?(d|D)ependencies":\\s*{[^}]*"@remix-run\\/.*":\\s*".+?"[^}]*}',
+                },
+                {
+                    path: 'package.json',
+                    matchContent: '"(dev)?(d|D)ependencies":\\s*{[^}]*"react":\\s*".+?"[^}]*}',
+                },
+            ],
+        },
+    },
+    {
+        name: 'nextjs',
+        detectors: {
+            every: [
+                {
+                    path: 'package.json',
+                    matchContent: '"(dev)?(d|D)ependencies":\\s*{[^}]*"next":\\s*".+?"[^}]*}',
+                },
+                {
+                    path: 'package.json',
+                    matchContent: '"(dev)?(d|D)ependencies":\\s*{[^}]*"react":\\s*".+?"[^}]*}',
+                },
+            ],
+        },
+    },
+    {
+        name: 'express',
+        detectors: {
+            every: [
+                {
+                    path: 'package.json',
+                    matchContent: '"(dev)?(d|D)ependencies":\\s*{[^}]*"express":\\s*".+?"[^}]*}',
+                },
+            ],
+        },
+    },
+    {
+        name: 'rails',
+        detectors: {
+            every: [
+                {
+                    path: 'Gemfile',
+                    matchContent: 'gem "rails"',
+                },
+            ],
+        },
+    },
+    {
+        name: 'flask',
+        detectors: {
+            every: [
+                {
+                    path: 'Pipfile',
+                    matchContent: 'flask',
+                },
+            ],
+        },
+    },
+    {
+        name: 'django',
+        detectors: {
+            every: [
+                {
+                    path: 'Pipfile',
+                    matchContent: 'django',
+                },
+            ],
+        },
+    },
+    {
+        name: 'laravel',
+        detectors: {
+            every: [
+                {
+                    path: 'composer.json',
+                    matchContent: '"require":\\s*{[^}]*"laravel/framework":\\s*".+?"[^}]*}',
+                },
+            ],
+        },
+    },
+    {
+        name: 'symfony',
+        detectors: {
+            every: [
+                {
+                    path: 'composer.json',
+                    matchContent: '"require":\\s*{[^}]*"symfony\\/.*":\\s*".+?"[^}]*}',
+                },
+            ],
+        },
+    },
+];
+/**
+ * Tries to identify the using of a framework analyzing the existence and/or content of different files inside a
+ * specific directory.
+ *
+ * @param rootDirectory - Directory from which the files required for each framework are searched
+ * @returns The name of the framework used or 'unknown' otherwise
+ */
+export async function resolveFramework(rootDirectory) {
+    const fwConfigFiles = {};
+    const matchedFramework = frameworks.find((framework) => (!framework.detectors?.some ||
+        framework.detectors?.some?.reduce((_previousDetectorsMatch, detector) => matchDetector(detector, loadFwConfigFile(rootDirectory, detector.path, fwConfigFiles)), false)) &&
+        (!framework.detectors?.every ||
+            framework.detectors?.every?.reduce((previousDetectorsMatch, detector) => previousDetectorsMatch
+                ? matchDetector(detector, loadFwConfigFile(rootDirectory, detector.path, fwConfigFiles))
+                : false, true)));
+    return matchedFramework ? matchedFramework.name : 'unknown';
+}
+function matchDetector(detector, fwConfigFiles = {}) {
+    if (!fwConfigFiles[detector.path])
+        return false;
+    return !detector.matchContent || new RegExp(detector.matchContent).test(fwConfigFiles[detector.path]);
+}
+function loadFwConfigFile(rootPath, fwConfigFileName, fwConfigFiles = {}) {
+    if (fwConfigFiles[fwConfigFileName]) {
+        return fwConfigFiles;
+    }
+    const fwConfigFilePath = pathJoin(rootPath, fwConfigFileName);
+    if (!existsSync(fwConfigFilePath)) {
+        return fwConfigFiles;
+    }
+    const rawContent = readFileSync(fwConfigFilePath, { encoding: 'utf8' });
+    fwConfigFiles[fwConfigFileName] = rawContent;
+    return fwConfigFiles;
+}
+//# sourceMappingURL=framework.js.map

package/dist/public/node/framework.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"framework.js","sourceRoot":"","sources":["../../../src/public/node/framework.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,IAAI,QAAQ,EAAC,MAAM,eAAe,CAAA;AAC9C,OAAO,EAAC,UAAU,EAAE,YAAY,EAAC,MAAM,IAAI,CAAA;AA2C3C,MAAM,UAAU,GAAgB;IAC9B;QACE,IAAI,EAAE,OAAO;QACb,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,cAAc;oBACpB,YAAY,EAAE,sEAAsE;iBACrF;gBACD;oBACE,IAAI,EAAE,cAAc;oBACpB,YAAY,EAAE,4DAA4D;iBAC3E;aACF;SACF;KACF;IACD;QACE,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,cAAc;oBACpB,YAAY,EAAE,2DAA2D;iBAC1E;gBACD;oBACE,IAAI,EAAE,cAAc;oBACpB,YAAY,EAAE,4DAA4D;iBAC3E;aACF;SACF;KACF;IACD;QACE,IAAI,EAAE,SAAS;QACf,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,cAAc;oBACpB,YAAY,EAAE,8DAA8D;iBAC7E;aACF;SACF;KACF;IACD;QACE,IAAI,EAAE,OAAO;QACb,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,SAAS;oBACf,YAAY,EAAE,aAAa;iBAC5B;aACF;SACF;KACF;IACD;QACE,IAAI,EAAE,OAAO;QACb,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,SAAS;oBACf,YAAY,EAAE,OAAO;iBACtB;aACF;SACF;KACF;IACD;QACE,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,SAAS;oBACf,YAAY,EAAE,QAAQ;iBACvB;aACF;SACF;KACF;IACD;QACE,IAAI,EAAE,SAAS;QACf,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,eAAe;oBACrB,YAAY,EAAE,yDAAyD;iBACxE;aACF;SACF;KACF;IACD;QACE,IAAI,EAAE,SAAS;QACf,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,eAAe;oBACrB,YAAY,EAAE,oDAAoD;iBACnE;aACF;SACF;KACF;CACF,CAAA;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,aAAqB;IAC1D,MAAM,aAAa,GAAwC,EAAE,CAAA;IAE7D,MAAM,gBAAgB,GAAG,UAAU,CAAC,IAAI,CACtC,CAAC,SAAS,EAAE,EAAE,CACZ,CAAC,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI;QACzB,SAAS,CAAC,SAAS,EAAE,IAAI,EAAE,MAAM,CAC/B,CAAC,uBAAgC,EAAE,QAAQ,EAAE,EAAE,CAC7C,aAAa,CAAC,QAAQ,EAAE,gBAAgB,CAAC,aAAa,EAAE,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,EACxF,KAAK,CACN,CAAC;QACJ,CAAC,CAAC,SAAS,CAAC,SAAS,EAAE,KAAK;YAC1B,SAAS,CAAC,SAAS,EAAE,KAAK,EAAE,MAAM,CAChC,CAAC,sBAA+B,EAAE,QAAQ,EAAE,EAAE,CAC5C,sBAAsB;gBACpB,CAAC,CAAC,aAAa,CAAC,QAAQ,EAAE,gBAAgB,CAAC,aAAa,EAAE,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;gBACxF,CAAC,CAAC,KAAK,EACX,IAAI,CACL,CAAC,CACP,CAAA;IAED,OAAO,gBAAgB,CAAC,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAA;AAC7D,CAAC;AAED,SAAS,aAAa,CAAC,QAAmC,EAAE,gBAAqD,EAAE;IACjH,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAA;IAE/C,OAAO,CAAC,QAAQ,CAAC,YAAY,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAE,CAAC,CAAA;AACxG,CAAC;AAED,SAAS,gBAAgB,CACvB,QAAgB,EAChB,gBAAwB,EACxB,gBAAqD,EAAE;IAEvD,IAAI,aAAa,CAAC,gBAAgB,CAAC,EAAE;QACnC,OAAO,aAAa,CAAA;KACrB;IAED,MAAM,gBAAgB,GAAG,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAA;IAC7D,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE;QACjC,OAAO,aAAa,CAAA;KACrB;IAED,MAAM,UAAU,GAAG,YAAY,CAAC,gBAAgB,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAAA;IAErE,aAAa,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAA;IAC5C,OAAO,aAAa,CAAA;AACtB,CAAC","sourcesContent":["import {join as pathJoin} from '../../path.js'\nimport {existsSync, readFileSync} from 'fs'\n\ninterface FrameworkDetectionPattern {\n  /**\n   * @example A file path\n   * ```\n   * \"package.json\"\n   * ```\n   */\n  path: string\n  /**\n   * @example A matcher\n   * ```\n   * \"\\\"(dev)?(d|D)ependencies\\\":\\\\s*{[^}]*\\\"next\\\":\\\\s*\\\".+?\\\"[^}]*}\"\n   * ```\n   */\n  matchContent?: string\n}\n\ninterface Framework {\n  /**\n   * Name of the framework\n   * @example \"nextjs\"\n   */\n  name: string\n\n  /**\n   * Detectors used to find out the framework\n   */\n  detectors: {\n    /**\n     * Collection of detectors that must be matched for the framework\n     * to be detected.\n     */\n    every?: FrameworkDetectionPattern[]\n    /**\n     * Collection of detectors where one match triggers the framework\n     * to be detected.\n     */\n    some?: FrameworkDetectionPattern[]\n  }\n}\n\nconst frameworks: Framework[] = [\n  {\n    name: 'remix',\n    detectors: {\n      every: [\n        {\n          path: 'package.json',\n          matchContent: '\"(dev)?(d|D)ependencies\":\\\\s*{[^}]*\"@remix-run\\\\/.*\":\\\\s*\".+?\"[^}]*}',\n        },\n        {\n          path: 'package.json',\n          matchContent: '\"(dev)?(d|D)ependencies\":\\\\s*{[^}]*\"react\":\\\\s*\".+?\"[^}]*}',\n        },\n      ],\n    },\n  },\n  {\n    name: 'nextjs',\n    detectors: {\n      every: [\n        {\n          path: 'package.json',\n          matchContent: '\"(dev)?(d|D)ependencies\":\\\\s*{[^}]*\"next\":\\\\s*\".+?\"[^}]*}',\n        },\n        {\n          path: 'package.json',\n          matchContent: '\"(dev)?(d|D)ependencies\":\\\\s*{[^}]*\"react\":\\\\s*\".+?\"[^}]*}',\n        },\n      ],\n    },\n  },\n  {\n    name: 'express',\n    detectors: {\n      every: [\n        {\n          path: 'package.json',\n          matchContent: '\"(dev)?(d|D)ependencies\":\\\\s*{[^}]*\"express\":\\\\s*\".+?\"[^}]*}',\n        },\n      ],\n    },\n  },\n  {\n    name: 'rails',\n    detectors: {\n      every: [\n        {\n          path: 'Gemfile',\n          matchContent: 'gem \"rails\"',\n        },\n      ],\n    },\n  },\n  {\n    name: 'flask',\n    detectors: {\n      every: [\n        {\n          path: 'Pipfile',\n          matchContent: 'flask',\n        },\n      ],\n    },\n  },\n  {\n    name: 'django',\n    detectors: {\n      every: [\n        {\n          path: 'Pipfile',\n          matchContent: 'django',\n        },\n      ],\n    },\n  },\n  {\n    name: 'laravel',\n    detectors: {\n      every: [\n        {\n          path: 'composer.json',\n          matchContent: '\"require\":\\\\s*{[^}]*\"laravel/framework\":\\\\s*\".+?\"[^}]*}',\n        },\n      ],\n    },\n  },\n  {\n    name: 'symfony',\n    detectors: {\n      every: [\n        {\n          path: 'composer.json',\n          matchContent: '\"require\":\\\\s*{[^}]*\"symfony\\\\/.*\":\\\\s*\".+?\"[^}]*}',\n        },\n      ],\n    },\n  },\n]\n\n/**\n * Tries to identify the using of a framework analyzing the existence and/or content of different files inside a\n * specific directory.\n *\n * @param rootDirectory - Directory from which the files required for each framework are searched\n * @returns The name of the framework used or 'unknown' otherwise\n */\nexport async function resolveFramework(rootDirectory: string): Promise<string> {\n  const fwConfigFiles: {[key: string]: string | undefined} = {}\n\n  const matchedFramework = frameworks.find(\n    (framework) =>\n      (!framework.detectors?.some ||\n        framework.detectors?.some?.reduce(\n          (_previousDetectorsMatch: boolean, detector) =>\n            matchDetector(detector, loadFwConfigFile(rootDirectory, detector.path, fwConfigFiles)),\n          false,\n        )) &&\n      (!framework.detectors?.every ||\n        framework.detectors?.every?.reduce(\n          (previousDetectorsMatch: boolean, detector) =>\n            previousDetectorsMatch\n              ? matchDetector(detector, loadFwConfigFile(rootDirectory, detector.path, fwConfigFiles))\n              : false,\n          true,\n        )),\n  )\n\n  return matchedFramework ? matchedFramework.name : 'unknown'\n}\n\nfunction matchDetector(detector: FrameworkDetectionPattern, fwConfigFiles: {[key: string]: string | undefined} = {}) {\n  if (!fwConfigFiles[detector.path]) return false\n\n  return !detector.matchContent || new RegExp(detector.matchContent).test(fwConfigFiles[detector.path]!)\n}\n\nfunction loadFwConfigFile(\n  rootPath: string,\n  fwConfigFileName: string,\n  fwConfigFiles: {[key: string]: string | undefined} = {},\n) {\n  if (fwConfigFiles[fwConfigFileName]) {\n    return fwConfigFiles\n  }\n\n  const fwConfigFilePath = pathJoin(rootPath, fwConfigFileName)\n  if (!existsSync(fwConfigFilePath)) {\n    return fwConfigFiles\n  }\n\n  const rawContent = readFileSync(fwConfigFilePath, {encoding: 'utf8'})\n\n  fwConfigFiles[fwConfigFileName] = rawContent\n  return fwConfigFiles\n}\n"]}

package/dist/public/node/fs.d.ts

@@ -0,0 +1,17 @@
+import type { RandomNameFamily } from '../common/string.js';
+interface GenerateRandomDirectoryOptions {
+    /** Suffix to include in the randomly generated directory name */
+    suffix: string;
+    /** Absolute path to the directory where the random directory will be created. */
+    directory: string;
+    /** Type of word to use for random name */
+    family?: RandomNameFamily;
+}
+/**
+ * It generates a random directory directory name for a sub-directory.
+ * It ensures that the returned directory name doesn't exist.
+ *
+ * @returns It returns the name of the directory.
+ */
+export declare function generateRandomNameForSubdirectory(options: GenerateRandomDirectoryOptions): Promise<string>;
+export {};

package/dist/public/node/fs.js

@@ -0,0 +1,21 @@
+import { exists as fileExists } from '../../file.js';
+import { join as joinPath } from '../../path.js';
+import { getRandomName } from '../common/string.js';
+/**
+ * It generates a random directory directory name for a sub-directory.
+ * It ensures that the returned directory name doesn't exist.
+ *
+ * @returns It returns the name of the directory.
+ */
+export async function generateRandomNameForSubdirectory(options) {
+    const generated = `${getRandomName(options.family ?? 'business')}-${options.suffix}`;
+    const randomDirectoryPath = joinPath(options.directory, generated);
+    const isAppDirectoryTaken = await fileExists(randomDirectoryPath);
+    if (isAppDirectoryTaken) {
+        return generateRandomNameForSubdirectory(options);
+    }
+    else {
+        return generated;
+    }
+}
+//# sourceMappingURL=fs.js.map

package/dist/public/node/fs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs.js","sourceRoot":"","sources":["../../../src/public/node/fs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,MAAM,IAAI,UAAU,EAAC,MAAM,eAAe,CAAA;AAClD,OAAO,EAAC,IAAI,IAAI,QAAQ,EAAC,MAAM,eAAe,CAAA;AAC9C,OAAO,EAAC,aAAa,EAAC,MAAM,qBAAqB,CAAA;AAcjD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,iCAAiC,CAAC,OAAuC;IAC7F,MAAM,SAAS,GAAG,GAAG,aAAa,CAAC,OAAO,CAAC,MAAM,IAAI,UAAU,CAAC,IAAI,OAAO,CAAC,MAAM,EAAE,CAAA;IACpF,MAAM,mBAAmB,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;IAClE,MAAM,mBAAmB,GAAG,MAAM,UAAU,CAAC,mBAAmB,CAAC,CAAA;IAEjE,IAAI,mBAAmB,EAAE;QACvB,OAAO,iCAAiC,CAAC,OAAO,CAAC,CAAA;KAClD;SAAM;QACL,OAAO,SAAS,CAAA;KACjB;AACH,CAAC","sourcesContent":["import {exists as fileExists} from '../../file.js'\nimport {join as joinPath} from '../../path.js'\nimport {getRandomName} from '../common/string.js'\nimport type {RandomNameFamily} from '../common/string.js'\n\ninterface GenerateRandomDirectoryOptions {\n  /** Suffix to include in the randomly generated directory name */\n  suffix: string\n\n  /** Absolute path to the directory where the random directory will be created. */\n  directory: string\n\n  /** Type of word to use for random name */\n  family?: RandomNameFamily\n}\n\n/**\n * It generates a random directory directory name for a sub-directory.\n * It ensures that the returned directory name doesn't exist.\n *\n * @returns It returns the name of the directory.\n */\nexport async function generateRandomNameForSubdirectory(options: GenerateRandomDirectoryOptions): Promise<string> {\n  const generated = `${getRandomName(options.family ?? 'business')}-${options.suffix}`\n  const randomDirectoryPath = joinPath(options.directory, generated)\n  const isAppDirectoryTaken = await fileExists(randomDirectoryPath)\n\n  if (isAppDirectoryTaken) {\n    return generateRandomNameForSubdirectory(options)\n  } else {\n    return generated\n  }\n}\n"]}

package/dist/public/node/github.d.ts

@@ -0,0 +1,50 @@
+import { Result } from './result.js';
+export interface GithubRelease {
+    id: number;
+    url: string;
+    tag_name: string;
+    name: string;
+    body: string;
+    draft: boolean;
+    prerelease: boolean;
+    created_at: string;
+    published_at: string;
+    tarball_url: string;
+}
+interface GetLatestGitHubReleaseOptions {
+    filter: (release: GithubRelease) => boolean;
+}
+/**
+ * Given a GitHub repository it obtains the latest release.
+ * @param owner - Repository owner (e.g., shopify)
+ * @param repo - Repository name (e.g., cli)
+ * @param options - Options
+ */
+export declare function getLatestGitHubRelease(owner: string, repo: string, options?: GetLatestGitHubReleaseOptions): Promise<GithubRelease>;
+interface ParseRepositoryURLOutput {
+    full: string;
+    site: string;
+    user: string;
+    name: string;
+    ref: string;
+    subDirectory: string;
+    ssh: string;
+    http: string;
+}
+/**
+ * Given a GitHub repository URL, it parses it and returns its coomponents.
+ * @param url - The GitHub repository URL
+ */
+export declare function parseGitHubRepositoryURL(url: string): Result<ParseRepositoryURLOutput, Error>;
+export interface GithubRepositoryReference {
+    baseURL: string;
+    branch?: string;
+    filePath?: string;
+}
+/**
+ * Given a GitHub repository URL it parses it and extracts the branch, file path,
+ * and base URL components
+ * @param reference - A GitHub repository URL (e.g. https://github.com/Shopify/cli/blob/main/package.json)
+ */
+export declare function parseGitHubRepositoryReference(reference: string): GithubRepositoryReference;
+export {};

package/dist/public/node/github.js

@@ -0,0 +1,71 @@
+import { err, ok } from './result.js';
+import { fetch } from '../../http.js';
+import { content, debug } from '../../output.js';
+class GitHubClientError extends Error {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    constructor(url, statusCode, bodyJson) {
+        super(`The request to GitHub API URL ${url} failed with status code ${statusCode} and the following error message: ${bodyJson.message}`);
+    }
+}
+/**
+ * Given a GitHub repository it obtains the latest release.
+ * @param owner - Repository owner (e.g., shopify)
+ * @param repo - Repository name (e.g., cli)
+ * @param options - Options
+ */
+export async function getLatestGitHubRelease(owner, repo, options = { filter: () => true }) {
+    debug(content `Getting the latest release of GitHub repository ${owner}/${repo}...`);
+    const url = `https://api.github.com/repos/${owner}/${repo}/releases`;
+    const fetchResult = await fetch(url);
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const jsonBody = await fetchResult.json();
+    if (fetchResult.status !== 200) {
+        throw new GitHubClientError(url, fetchResult.status, jsonBody);
+    }
+    return jsonBody.find(options.filter);
+}
+/**
+ * Given a GitHub repository URL, it parses it and returns its coomponents.
+ * @param url - The GitHub repository URL
+ */
+export function parseGitHubRepositoryURL(url) {
+    const match = /^(?:(?:https:\/\/)?([^:/]+\.[^:/]+)\/|git@([^:/]+)[:/]|([^/]+):)?([^/\s]+)\/([^/\s#]+)(?:((?:\/[^/\s#]+)+))?(?:\/)?(?:#(.+))?/.exec(url);
+    if (!match) {
+        const exampleFormats = [
+            'github:user/repo',
+            'user/repo/subdirectory',
+            'git@github.com:user/repo',
+            'user/repo#dev',
+            'https://github.com/user/repo',
+        ];
+        return err(new Error(`Parsing the url ${url} failed. Supported formats are ${exampleFormats.join(', ')}.`));
+    }
+    const site = match[1] || match[2] || match[3] || 'github.com';
+    const normalizedSite = site === 'github' ? 'github.com' : site;
+    const user = match[4];
+    const name = match[5].replace(/\.git$/, '');
+    const subDirectory = match[6]?.slice(1);
+    const ref = match[7];
+    const branch = ref ? `#${ref}` : '';
+    const ssh = `git@${normalizedSite}:${user}/${name}`;
+    const http = `https://${normalizedSite}/${user}/${name}`;
+    const full = ['https:/', normalizedSite, user, name, subDirectory].join('/').concat(branch);
+    return ok({ full, site: normalizedSite, user, name, ref, subDirectory, ssh, http });
+}
+/**
+ * Given a GitHub repository URL it parses it and extracts the branch, file path,
+ * and base URL components
+ * @param reference - A GitHub repository URL (e.g. https://github.com/Shopify/cli/blob/main/package.json)
+ */
+export function parseGitHubRepositoryReference(reference) {
+    const url = new URL(reference);
+    const branch = url.hash ? url.hash.slice(1) : undefined;
+    const [_, user, repo, ...repoPath] = url.pathname.split('/');
+    const filePath = repoPath.length > 0 ? repoPath.join('/') : undefined;
+    return {
+        baseURL: `${url.origin}/${user}/${repo}`,
+        branch,
+        filePath,
+    };
+}
+//# sourceMappingURL=github.js.map

package/dist/public/node/github.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"github.js","sourceRoot":"","sources":["../../../src/public/node/github.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,GAAG,EAAE,EAAE,EAAS,MAAM,aAAa,CAAA;AAC3C,OAAO,EAAC,KAAK,EAAC,MAAM,eAAe,CAAA;AACnC,OAAO,EAAC,OAAO,EAAE,KAAK,EAAC,MAAM,iBAAiB,CAAA;AAE9C,MAAM,iBAAkB,SAAQ,KAAK;IACnC,8DAA8D;IAC9D,YAAY,GAAW,EAAE,UAAkB,EAAE,QAAa;QACxD,KAAK,CACH,iCAAiC,GAAG,4BAA4B,UAAU,qCAAqC,QAAQ,CAAC,OAAO,EAAE,CAClI,CAAA;IACH,CAAC;CACF;AAmBD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,KAAa,EACb,IAAY,EACZ,UAAyC,EAAC,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,EAAC;IAE7D,KAAK,CAAC,OAAO,CAAA,mDAAmD,KAAK,IAAI,IAAI,KAAK,CAAC,CAAA;IACnF,MAAM,GAAG,GAAG,gCAAgC,KAAK,IAAI,IAAI,WAAW,CAAA;IACpE,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAA;IACpC,8DAA8D;IAC9D,MAAM,QAAQ,GAAQ,MAAM,WAAW,CAAC,IAAI,EAAE,CAAA;IAE9C,IAAI,WAAW,CAAC,MAAM,KAAK,GAAG,EAAE;QAC9B,MAAM,IAAI,iBAAiB,CAAC,GAAG,EAAE,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;KAC/D;IAED,OAAO,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;AACtC,CAAC;AAaD;;;GAGG;AACH,MAAM,UAAU,wBAAwB,CAAC,GAAW;IAClD,MAAM,KAAK,GACT,+HAA+H,CAAC,IAAI,CAClI,GAAG,CACJ,CAAA;IAEH,IAAI,CAAC,KAAK,EAAE;QACV,MAAM,cAAc,GAAG;YACrB,kBAAkB;YAClB,wBAAwB;YACxB,0BAA0B;YAC1B,eAAe;YACf,8BAA8B;SAC/B,CAAA;QAED,OAAO,GAAG,CAAC,IAAI,KAAK,CAAC,mBAAmB,GAAG,kCAAkC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;KAC5G;IAED,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,IAAI,YAAY,CAAA;IAC7D,MAAM,cAAc,GAAG,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAA;IAC9D,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAE,CAAA;IACtB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;IAC5C,MAAM,YAAY,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAE,CAAA;IACxC,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAE,CAAA;IACrB,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;IACnC,MAAM,GAAG,GAAG,OAAO,cAAc,IAAI,IAAI,IAAI,IAAI,EAAE,CAAA;IACnD,MAAM,IAAI,GAAG,WAAW,cAAc,IAAI,IAAI,IAAI,IAAI,EAAE,CAAA;IACxD,MAAM,IAAI,GAAG,CAAC,SAAS,EAAE,cAAc,EAAE,IAAI,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAE3F,OAAO,EAAE,CAAC,EAAC,IAAI,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,EAAE,IAAI,EAAC,CAAC,CAAA;AACnF,CAAC;AAQD;;;;GAIG;AACH,MAAM,UAAU,8BAA8B,CAAC,SAAiB;IAC9D,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAA;IAC9B,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IACvD,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAC5D,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAErE,OAAO;QACL,OAAO,EAAE,GAAG,GAAG,CAAC,MAAM,IAAI,IAAI,IAAI,IAAI,EAAE;QACxC,MAAM;QACN,QAAQ;KACT,CAAA;AACH,CAAC","sourcesContent":["import {err, ok, Result} from './result.js'\nimport {fetch} from '../../http.js'\nimport {content, debug} from '../../output.js'\n\nclass GitHubClientError extends Error {\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  constructor(url: string, statusCode: number, bodyJson: any) {\n    super(\n      `The request to GitHub API URL ${url} failed with status code ${statusCode} and the following error message: ${bodyJson.message}`,\n    )\n  }\n}\n\nexport interface GithubRelease {\n  id: number\n  url: string\n  tag_name: string\n  name: string\n  body: string\n  draft: boolean\n  prerelease: boolean\n  created_at: string\n  published_at: string\n  tarball_url: string\n}\n\ninterface GetLatestGitHubReleaseOptions {\n  filter: (release: GithubRelease) => boolean\n}\n\n/**\n * Given a GitHub repository it obtains the latest release.\n * @param owner - Repository owner (e.g., shopify)\n * @param repo - Repository name (e.g., cli)\n * @param options - Options\n */\nexport async function getLatestGitHubRelease(\n  owner: string,\n  repo: string,\n  options: GetLatestGitHubReleaseOptions = {filter: () => true},\n): Promise<GithubRelease> {\n  debug(content`Getting the latest release of GitHub repository ${owner}/${repo}...`)\n  const url = `https://api.github.com/repos/${owner}/${repo}/releases`\n  const fetchResult = await fetch(url)\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  const jsonBody: any = await fetchResult.json()\n\n  if (fetchResult.status !== 200) {\n    throw new GitHubClientError(url, fetchResult.status, jsonBody)\n  }\n\n  return jsonBody.find(options.filter)\n}\n\ninterface ParseRepositoryURLOutput {\n  full: string\n  site: string\n  user: string\n  name: string\n  ref: string\n  subDirectory: string\n  ssh: string\n  http: string\n}\n\n/**\n * Given a GitHub repository URL, it parses it and returns its coomponents.\n * @param url - The GitHub repository URL\n */\nexport function parseGitHubRepositoryURL(url: string): Result<ParseRepositoryURLOutput, Error> {\n  const match =\n    /^(?:(?:https:\\/\\/)?([^:/]+\\.[^:/]+)\\/|git@([^:/]+)[:/]|([^/]+):)?([^/\\s]+)\\/([^/\\s#]+)(?:((?:\\/[^/\\s#]+)+))?(?:\\/)?(?:#(.+))?/.exec(\n      url,\n    )\n\n  if (!match) {\n    const exampleFormats = [\n      'github:user/repo',\n      'user/repo/subdirectory',\n      'git@github.com:user/repo',\n      'user/repo#dev',\n      'https://github.com/user/repo',\n    ]\n\n    return err(new Error(`Parsing the url ${url} failed. Supported formats are ${exampleFormats.join(', ')}.`))\n  }\n\n  const site = match[1] || match[2] || match[3] || 'github.com'\n  const normalizedSite = site === 'github' ? 'github.com' : site\n  const user = match[4]!\n  const name = match[5]!.replace(/\\.git$/, '')\n  const subDirectory = match[6]?.slice(1)!\n  const ref = match[7]!\n  const branch = ref ? `#${ref}` : ''\n  const ssh = `git@${normalizedSite}:${user}/${name}`\n  const http = `https://${normalizedSite}/${user}/${name}`\n  const full = ['https:/', normalizedSite, user, name, subDirectory].join('/').concat(branch)\n\n  return ok({full, site: normalizedSite, user, name, ref, subDirectory, ssh, http})\n}\n\nexport interface GithubRepositoryReference {\n  baseURL: string\n  branch?: string\n  filePath?: string\n}\n\n/**\n * Given a GitHub repository URL it parses it and extracts the branch, file path,\n * and base URL components\n * @param reference - A GitHub repository URL (e.g. https://github.com/Shopify/cli/blob/main/package.json)\n */\nexport function parseGitHubRepositoryReference(reference: string): GithubRepositoryReference {\n  const url = new URL(reference)\n  const branch = url.hash ? url.hash.slice(1) : undefined\n  const [_, user, repo, ...repoPath] = url.pathname.split('/')\n  const filePath = repoPath.length > 0 ? repoPath.join('/') : undefined\n\n  return {\n    baseURL: `${url.origin}/${user}/${repo}`,\n    branch,\n    filePath,\n  }\n}\n"]}

package/dist/public/node/hooks/postrun.d.ts

@@ -0,0 +1,2 @@
+import { Hook } from '@oclif/core';
+export declare const hookPost: Hook.Postrun;

package/dist/public/node/hooks/postrun.js

@@ -0,0 +1,9 @@
+import { reportAnalyticsEvent } from '../analytics.js';
+import { debug } from '../../../output.js';
+// This hook is called after each successful command run. More info: https://oclif.io/docs/hooks
+export const hookPost = async ({ config, Command }) => {
+    await reportAnalyticsEvent({ config });
+    const command = Command?.id?.replace(/:/g, ' ');
+    debug(`Completed command ${command}`);
+};
+//# sourceMappingURL=postrun.js.map

package/dist/public/node/hooks/postrun.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"postrun.js","sourceRoot":"","sources":["../../../../src/public/node/hooks/postrun.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,oBAAoB,EAAC,MAAM,iBAAiB,CAAA;AACpD,OAAO,EAAC,KAAK,EAAC,MAAM,oBAAoB,CAAA;AAGxC,gGAAgG;AAChG,MAAM,CAAC,MAAM,QAAQ,GAAiB,KAAK,EAAE,EAAC,MAAM,EAAE,OAAO,EAAC,EAAE,EAAE;IAChE,MAAM,oBAAoB,CAAC,EAAC,MAAM,EAAC,CAAC,CAAA;IACpC,MAAM,OAAO,GAAG,OAAO,EAAE,EAAE,EAAE,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;IAC/C,KAAK,CAAC,qBAAqB,OAAO,EAAE,CAAC,CAAA;AACvC,CAAC,CAAA","sourcesContent":["import {reportAnalyticsEvent} from '../analytics.js'\nimport {debug} from '../../../output.js'\nimport {Hook} from '@oclif/core'\n\n// This hook is called after each successful command run. More info: https://oclif.io/docs/hooks\nexport const hookPost: Hook.Postrun = async ({config, Command}) => {\n  await reportAnalyticsEvent({config})\n  const command = Command?.id?.replace(/:/g, ' ')\n  debug(`Completed command ${command}`)\n}\n"]}

package/dist/public/node/hooks/prerun.d.ts

@@ -0,0 +1,12 @@
+import { Hook } from '@oclif/core';
+export declare interface CommandContent {
+    command: string;
+    topic?: string;
+    alias?: string;
+}
+export declare const hook: Hook.Prerun;
+export declare function parseCommandContent(cmdInfo: {
+    id: string;
+    aliases: string[];
+    pluginAlias?: string;
+}): CommandContent;