@shopify/cli-kit 3.0.26 → 3.2.0

package/dist/node/error-handler.js

@@ -0,0 +1,79 @@
+import { AbortSilent, CancelExecution, mapper as errorMapper, shouldReport as shouldReportError, handler, } from '../error.js';
+import { info } from '../output.js';
+import { reportEvent } from '../analytics.js';
+import { normalize } from '../path.js';
+import { settings } from '@oclif/core';
+import StackTracey from 'stacktracey';
+import Bugsnag from '@bugsnag/js';
+export function errorHandler(error) {
+    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(reportError)
+            .then(() => {
+            process.exit(1);
+        });
+    }
+}
+const reportError = async (error) => {
+    await reportEvent({ errorMessage: error.message });
+    if (settings.debug || !shouldReportError(error))
+        return error;
+    let reportableError;
+    let stacktrace;
+    let report = false;
+    // eslint-disable-next-line no-prototype-builtins
+    if (Error.prototype.isPrototypeOf(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 = normalize(item.file).replace('file:/', '/').replace('C:/', '');
+        return `    at ${item.callee} (${filePath}:${item.line}:${item.column})`;
+    })
+        .join('\n');
+    reportableError.stack = `Error: ${reportableError.message}\n${formattedStacktrace}`;
+    if (report) {
+        await new Promise((resolve, reject) => {
+            Bugsnag.notify(reportableError, undefined, (error, event) => {
+                if (error) {
+                    reject(error);
+                }
+                else {
+                    resolve(reportableError);
+                }
+            });
+        });
+    }
+    return reportableError;
+};
+//# sourceMappingURL=error-handler.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"error-handler.js","sourceRoot":"","sources":["../../src/node/error-handler.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,eAAe,EACf,MAAM,IAAI,WAAW,EACrB,YAAY,IAAI,iBAAiB,EACjC,OAAO,GACR,MAAM,aAAa,CAAA;AACpB,OAAO,EAAC,IAAI,EAAC,MAAM,cAAc,CAAA;AACjC,OAAO,EAAC,WAAW,EAAC,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAC,SAAS,EAAC,MAAM,YAAY,CAAA;AACpC,OAAO,EAAC,QAAQ,EAAC,MAAM,aAAa,CAAA;AACpC,OAAO,WAAW,MAAM,aAAa,CAAA;AACrC,OAAO,OAAO,MAAM,aAAa,CAAA;AAEjC,MAAM,UAAU,YAAY,CAAC,KAA8C;IACzE,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,KAAY,EAAE,EAAE;YACrB,OAAO,OAAO,CAAC,KAAK,CAAC,CAAA;QACvB,CAAC,CAAC;aACD,IAAI,CAAC,WAAW,CAAC;aACjB,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,KAAY,EAAkB,EAAE;IACzD,MAAM,WAAW,CAAC,EAAC,YAAY,EAAE,KAAK,CAAC,OAAO,EAAC,CAAC,CAAA;IAChD,IAAI,QAAQ,CAAC,KAAK,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAA;IAE7D,IAAI,eAAsB,CAAA;IAC1B,IAAI,UAA8B,CAAA;IAClC,IAAI,MAAM,GAAG,KAAK,CAAA;IAElB,iDAAiD;IACjD,IAAI,KAAK,CAAC,SAAS,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE;QACxC,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,IAAK,KAAgB,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE;QAC7E,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,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QAC/E,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,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,eAAe,CAAA;AACxB,CAAC,CAAA","sourcesContent":["import {\n  AbortSilent,\n  CancelExecution,\n  mapper as errorMapper,\n  shouldReport as shouldReportError,\n  handler,\n} from '../error.js'\nimport {info} from '../output.js'\nimport {reportEvent} from '../analytics.js'\nimport {normalize} from '../path.js'\nimport {settings} from '@oclif/core'\nimport StackTracey from 'stacktracey'\nimport Bugsnag from '@bugsnag/js'\n\nexport function errorHandler(error: Error & {exitCode?: number | undefined}) {\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: Error) => {\n        return handler(error)\n      })\n      .then(reportError)\n      .then(() => {\n        process.exit(1)\n      })\n  }\n}\n\nconst reportError = async (error: Error): Promise<Error> => {\n  await reportEvent({errorMessage: error.message})\n  if (settings.debug || !shouldReportError(error)) return error\n\n  let reportableError: Error\n  let stacktrace: string | undefined\n  let report = false\n\n  // eslint-disable-next-line no-prototype-builtins\n  if (Error.prototype.isPrototypeOf(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 as string).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 = normalize(item.file).replace('file:/', '/').replace('C:/', '')\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 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 reportableError\n}\n"]}

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

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

package/dist/node/hooks/postrun.js

@@ -0,0 +1,6 @@
+import { reportEvent } from '../../analytics.js';
+// This hook is called after each successful command run. More info: https://oclif.io/docs/hooks
+export const hookPost = async (_options) => {
+    await reportEvent();
+};
+//# sourceMappingURL=postrun.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"postrun.js","sourceRoot":"","sources":["../../../src/node/hooks/postrun.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,oBAAoB,CAAA;AAG9C,gGAAgG;AAChG,MAAM,CAAC,MAAM,QAAQ,GAAiB,KAAK,EAAE,QAAQ,EAAE,EAAE;IACvD,MAAM,WAAW,EAAE,CAAA;AACrB,CAAC,CAAA","sourcesContent":["import {reportEvent} from '../../analytics.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 (_options) => {\n  await reportEvent()\n}\n"]}

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

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

package/dist/node/hooks/prerun.js

@@ -0,0 +1,9 @@
+import { start } from '../../analytics.js';
+// This hook is called before each command run. More info: https://oclif.io/docs/hooks
+export const hook = async (options) => {
+    const cmd = options.Command.aliases.length === 0 ? options.Command.id : options.Command.aliases[0];
+    const command = cmd.replace(/:/g, ' ');
+    const args = options.argv;
+    start({ command, args });
+};
+//# sourceMappingURL=prerun.js.map

package/dist/node/hooks/prerun.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prerun.js","sourceRoot":"","sources":["../../../src/node/hooks/prerun.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAC,MAAM,oBAAoB,CAAA;AAGxC,sFAAsF;AACtF,MAAM,CAAC,MAAM,IAAI,GAAgB,KAAK,EAAE,OAAO,EAAE,EAAE;IACjD,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;IAClG,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;IACtC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;IACzB,KAAK,CAAC,EAAC,OAAO,EAAE,IAAI,EAAC,CAAC,CAAA;AACxB,CAAC,CAAA","sourcesContent":["import {start} from '../../analytics.js'\nimport {Hook} from '@oclif/core'\n\n// This hook is called before each command run. More info: https://oclif.io/docs/hooks\nexport const hook: Hook.Prerun = async (options) => {\n  const cmd = options.Command.aliases.length === 0 ? options.Command.id : options.Command.aliases[0]\n  const command = cmd.replace(/:/g, ' ')\n  const args = options.argv\n  start({command, args})\n}\n"]}

package/dist/{dependency.d.ts → node/node-package-manager.d.ts}

@@ -1,37 +1,57 @@
 /// <reference types="node" />
 /// <reference types="node" />
-import { Abort, Bug } from './error.js';
+import { Abort, Bug } from '../error.js';
 import { AbortSignal } from 'abort-controller';
 import type { Writable } from 'node:stream';
-export declare const genericConfigurationFileNames: {
-    readonly yarn: {
-        readonly lockfile: "yarn.lock";
-    };
-    readonly pnpm: {
-        readonly lockfile: "pnpm-lock.yaml";
-    };
-};
-export declare const dependencyManager: readonly ["yarn", "npm", "pnpm"];
-export declare type DependencyManager = typeof dependencyManager[number];
+/** The name of the Yarn lock file */
+export declare const yarnLockfile = "yarn.lock";
+/** The name of the pnpm lock file */
+export declare const pnpmLockfile = "pnpm-lock.yaml";
+/** An array containing the lockfiles from all the package managers */
+export declare const lockfiles: string[];
+/**
+ * A union type that represents the type of dependencies in the package.json
+ * - dev: devDependencies
+ * - prod: dependencies
+ * - peer: peerDependencies
+ */
+export declare type DependencyType = 'dev' | 'prod' | 'peer';
+/**
+ * A union that represents the package managers available.
+ */
+export declare const packageManager: readonly ["yarn", "npm", "pnpm"];
+export declare type PackageManager = typeof packageManager[number];
+/**
+ * Returns an abort error that's thrown when a directory that's expected to have
+ * a package.json doesn't have it.
+ * @param directory {string} The path to the directory that should contain a package.json
+ * @returns {Abort} An abort error.
+ */
 export declare const PackageJsonNotFoundError: (directory: string) => Abort;
+/**
+ * Returns a bug error that's thrown when the lookup of the package.json traversing the directory
+ * hierarchy up can't find a package.json
+ * @param directory {string} The directory from which the traverse has been done
+ * @returns {Abort} An abort error.
+ */
 export declare const FindUpAndReadPackageJsonNotFoundError: (directory: string) => Bug;
 /**
  * Returns the dependency manager used to run the create workflow.
  * @param env {Object} The environment variables of the process in which the CLI runs.
  * @returns The dependency manager
  */
-export declare function dependencyManagerUsedForCreating(env?: NodeJS.ProcessEnv): DependencyManager;
+export declare function packageManagerUsedForCreating(env?: NodeJS.ProcessEnv): PackageManager;
 /**
  * Returns the dependency manager used by an existing project.
  * @param directory {string} The root directory of the project.
  * @returns The dependency manager
  */
-export declare function getDependencyManager(directory: string): Promise<DependencyManager>;
+export declare function getPackageManager(directory: string): Promise<PackageManager>;
 interface InstallNPMDependenciesRecursivelyOptions {
     /**
      * The dependency manager to use to install the dependencies.
      */
-    dependencyManager: DependencyManager;
+    packageManager: PackageManager;
     /**
      * The directory from where we'll find package.json's recursively
      */
@@ -51,13 +71,13 @@ export declare function installNPMDependenciesRecursively(options: InstallNPMDep
 /**
  * Installs the dependencies in the given directory.
  * @param directory {string} The directory that contains the package.json
- * @param dependencyManager {DependencyManager} The dependency manager to use to install the dependencies.
+ * @param packageManager {PackageManager} The package manager to use to install the dependencies.
  * @param stdout {Writable} Standard output stream.
  * @param stderr {Writable} Standard error stream.
  * @param signal {AbortSignal} Abort signal.
  * @returns stderr {Writable} Standard error stream.
  */
-export declare function install(directory: string, dependencyManager: DependencyManager, stdout?: Writable, stderr?: Writable, signal?: AbortSignal): Promise<void>;
+export declare function installNodeModules(directory: string, packageManager: PackageManager, stdout?: Writable, stderr?: Writable, signal?: AbortSignal): Promise<void>;
 /**
  * Returns the name of the package configured in its package.json
  * @param packageJsonPath {string} Path to the package.json file
@@ -72,25 +92,55 @@ export declare function getPackageName(packageJsonPath: string): Promise<string>
 export declare function getDependencies(packageJsonPath: string): Promise<{
     [key: string]: string;
 }>;
+/**
+ * Given an NPM dependency, it checks if there's a more recent version, and if there is, it returns its value.
+ * @param dependency {string} The dependency name (e.g. react)
+ * @param currentVersion {string} The current version.
+ * @returns {Promise<string>} A promise that resolves with a more recent version or undefined if there's no more recent version.
+ */
 export declare function checkForNewVersion(dependency: string, currentVersion: string): Promise<string | undefined>;
-export declare function getOutputUpdateCLIReminder(dependencyManager: DependencyManager, version: string): string;
-interface PackageJSONContents {
+/**
+ * An interface that represents a package.json
+ */
+interface PackageJson {
+    /**
+     * The absolute path to the package.json
+     */
+    path: string;
+    /**
+     * The name attribute of the package.json
+     */
     name: string;
+    /**
+     * The version attribute of the package.json
+     */
     version?: string;
+    /**
+     * The dependencies attribute of the package.json
+     */
     dependencies?: {
         [key: string]: string;
     };
+    /**
+     * The devDependencies attribute of the package.json
+     */
     devDependencies?: {
         [key: string]: string;
     };
 }
-export declare function packageJSONContents(packageJsonPath: string): Promise<PackageJSONContents>;
-export declare type DependencyType = 'dev' | 'prod' | 'peer';
+/**
+ * Reads and parses a package.json
+ * @param packageJsonPath {string} Path to the package.json
+ * @returns {Promise<PackageJson>} An promise that resolves with an in-memory representation
+ *    of the package.json or rejects with an error if the file is not found or the content is
+ *    not decodable.
+ */
+export declare function readAndParsePackageJson(packageJsonPath: string): Promise<PackageJson>;
 interface AddNPMDependenciesIfNeededOptions {
     /** How dependencies should be added */
     type: DependencyType;
     /** The dependency manager to use to add dependencies */
-    dependencyManager: DependencyManager;
+    packageManager: PackageManager;
     /** The directory that contains the package.json where dependencies will be added */
     directory: string;
     /** Standard output coming from the underlying installation process */
@@ -100,8 +150,29 @@ interface AddNPMDependenciesIfNeededOptions {
     /** Abort signal to stop the process */
     signal?: AbortSignal;
 }
+/**
+ * An interface that represents a dependency name with its version
+ */
 export interface DependencyVersion {
+    /**
+     * The name of the NPM dependency as it's reflected in the package.json:
+     *
+     * @example
+     *  In the example below name would be "react"
+     *  {
+     *    "react": "1.2.3"
+     *  }
+     */
     name: string;
+    /**
+     * The version of the NPM dependency as it's reflected in the package.json:
+     *
+     * @example
+     *  In the example below version would be "1.2.3"
+     *  {
+     *    "react": "1.2.3"
+     *  }
+     */
     version: string | undefined;
 }
 /**
@@ -112,8 +183,6 @@ export interface DependencyVersion {
 export declare function addNPMDependenciesIfNeeded(dependencies: DependencyVersion[], options: AddNPMDependenciesIfNeededOptions, force?: boolean): Promise<void>;
 export declare function addNPMDependenciesWithoutVersionIfNeeded(dependencies: string[], options: AddNPMDependenciesIfNeededOptions): Promise<void>;
 export declare function addLatestNPMDependencies(dependencies: string[], options: AddNPMDependenciesIfNeededOptions): Promise<void>;
-export declare type ProjectType = 'node' | 'php' | 'ruby' | undefined;
-export declare function getProjectType(directory: string): Promise<ProjectType>;
 /**
  * Given a directory it traverses the directory up looking for a package.json and if found, it reads it
  * decodes the JSON, and returns its content as a Javascript object.

package/dist/{dependency.js → node/node-package-manager.js}

@@ -1,23 +1,36 @@
-import { exec } from './system.js';
-import { exists as fileExists, read as readFile } from './file.js';
-import { glob, dirname, join as pathJoin, findUp } from './path.js';
-import { Abort, Bug } from './error.js';
-import { latestNpmPackageVersion } from './version.js';
-import { Version } from './semver.js';
-import { content, token, debug } from './output.js';
+import { exec } from '../system.js';
+import { exists as fileExists, read as readFile } from '../file.js';
+import { glob, dirname, join as pathJoin, findUp } from '../path.js';
+import { Abort, Bug } from '../error.js';
+import { latestNpmPackageVersion } from '../version.js';
+import { Version } from '../semver.js';
+import { content, token, debug } from '../output.js';
 import { AbortController } from 'abort-controller';
-export const genericConfigurationFileNames = {
-    yarn: {
-        lockfile: 'yarn.lock',
-    },
-    pnpm: {
-        lockfile: 'pnpm-lock.yaml',
-    },
-};
-export const dependencyManager = ['yarn', 'npm', 'pnpm'];
+/** The name of the Yarn lock file */
+export const yarnLockfile = 'yarn.lock';
+/** The name of the pnpm lock file */
+export const pnpmLockfile = 'pnpm-lock.yaml';
+/** An array containing the lockfiles from all the package managers */
+export const lockfiles = [yarnLockfile, pnpmLockfile];
+/**
+ * A union that represents the package managers available.
+ */
+export const packageManager = ['yarn', 'npm', 'pnpm'];
+/**
+ * Returns an abort error that's thrown when a directory that's expected to have
+ * a package.json doesn't have it.
+ * @param directory {string} The path to the directory that should contain a package.json
+ * @returns {Abort} An abort error.
+ */
 export const PackageJsonNotFoundError = (directory) => {
     return new Abort(`The directory ${directory} doesn't have a package.json.`);
 };
+/**
+ * Returns a bug error that's thrown when the lookup of the package.json traversing the directory
+ * hierarchy up can't find a package.json
+ * @param directory {string} The directory from which the traverse has been done
+ * @returns {Abort} An abort error.
+ */
 export const FindUpAndReadPackageJsonNotFoundError = (directory) => {
     return new Bug(content `Couldn't find a a package.json traversing directories from ${token.path(directory)}`);
 };
@@ -26,7 +39,7 @@ export const FindUpAndReadPackageJsonNotFoundError = (directory) => {
  * @param env {Object} The environment variables of the process in which the CLI runs.
  * @returns The dependency manager
  */
-export function dependencyManagerUsedForCreating(env = process.env) {
+export function packageManagerUsedForCreating(env = process.env) {
     if (env.npm_config_user_agent?.includes('yarn')) {
         return 'yarn';
     }
@@ -42,10 +55,10 @@ export function dependencyManagerUsedForCreating(env = process.env) {
  * @param directory {string} The root directory of the project.
  * @returns The dependency manager
  */
-export async function getDependencyManager(directory) {
+export async function getPackageManager(directory) {
     debug(content `Obtaining the dependency manager in directory ${token.path(directory)}...`);
-    const yarnLockPath = pathJoin(directory, genericConfigurationFileNames.yarn.lockfile);
-    const pnpmLockPath = pathJoin(directory, genericConfigurationFileNames.pnpm.lockfile);
+    const yarnLockPath = pathJoin(directory, yarnLockfile);
+    const pnpmLockPath = pathJoin(directory, pnpmLockfile);
     if (await fileExists(yarnLockPath)) {
         return 'yarn';
     }
@@ -73,7 +86,7 @@ export async function installNPMDependenciesRecursively(options) {
     try {
         await Promise.all(packageJsons.map(async (packageJsonPath) => {
             const directory = dirname(packageJsonPath);
-            await install(directory, options.dependencyManager, undefined, undefined, abortController.signal);
+            await installNodeModules(directory, options.packageManager, undefined, undefined, abortController.signal);
         }));
     }
     catch (error) {
@@ -84,15 +97,15 @@ export async function installNPMDependenciesRecursively(options) {
 /**
  * Installs the dependencies in the given directory.
  * @param directory {string} The directory that contains the package.json
- * @param dependencyManager {DependencyManager} The dependency manager to use to install the dependencies.
+ * @param packageManager {PackageManager} The package manager to use to install the dependencies.
  * @param stdout {Writable} Standard output stream.
  * @param stderr {Writable} Standard error stream.
  * @param signal {AbortSignal} Abort signal.
  * @returns stderr {Writable} Standard error stream.
  */
-export async function install(directory, dependencyManager, stdout, stderr, signal) {
+export async function installNodeModules(directory, packageManager, stdout, stderr, signal) {
     const options = { cwd: directory, stdin: undefined, stdout, stderr, signal };
-    await exec(dependencyManager, ['install'], options);
+    await exec(packageManager, ['install'], options);
 }
 /**
  * Returns the name of the package configured in its package.json
@@ -100,7 +113,7 @@ export async function install(directory, dependencyManager, stdout, stderr, sign
  * @returns A promise that resolves with the name.
  */
 export async function getPackageName(packageJsonPath) {
-    const packageJsonContent = await packageJSONContents(packageJsonPath);
+    const packageJsonContent = await readAndParsePackageJson(packageJsonPath);
     return packageJsonContent.name;
 }
 /**
@@ -109,11 +122,17 @@ export async function getPackageName(packageJsonPath) {
  * @returns A promise that resolves with the list of dependencies.
  */
 export async function getDependencies(packageJsonPath) {
-    const packageJsonContent = await packageJSONContents(packageJsonPath);
+    const packageJsonContent = await readAndParsePackageJson(packageJsonPath);
     const dependencies = packageJsonContent.dependencies ?? {};
     const devDependencies = packageJsonContent.devDependencies ?? {};
     return { ...dependencies, ...devDependencies };
 }
+/**
+ * Given an NPM dependency, it checks if there's a more recent version, and if there is, it returns its value.
+ * @param dependency {string} The dependency name (e.g. react)
+ * @param currentVersion {string} The current version.
+ * @returns {Promise<string>} A promise that resolves with a more recent version or undefined if there's no more recent version.
+ */
 export async function checkForNewVersion(dependency, currentVersion) {
     debug(content `Checking if there's a version of ${dependency} newer than ${currentVersion}`);
     try {
@@ -130,11 +149,14 @@ export async function checkForNewVersion(dependency, currentVersion) {
         return undefined;
     }
 }
-export function getOutputUpdateCLIReminder(dependencyManager, version) {
-    const updateCommand = token.packagejsonScript(dependencyManager, 'shopify', 'upgrade');
-    return content `💡 Version ${version} available! Run ${updateCommand}`.value;
-}
-export async function packageJSONContents(packageJsonPath) {
+/**
+ * Reads and parses a package.json
+ * @param packageJsonPath {string} Path to the package.json
+ * @returns {Promise<PackageJson>} An promise that resolves with an in-memory representation
+ *    of the package.json or rejects with an error if the file is not found or the content is
+ *    not decodable.
+ */
+export async function readAndParsePackageJson(packageJsonPath) {
     if (!(await fileExists(packageJsonPath))) {
         throw PackageJsonNotFoundError(dirname(packageJsonPath));
     }
@@ -169,7 +191,7 @@ ${token.json(options)}
     const depedenciesWithVersion = dependenciesToAdd.map((dep) => {
         return dep.version ? `${dep.name}@${dep.version}` : dep.name;
     });
-    switch (options.dependencyManager) {
+    switch (options.packageManager) {
         case 'npm':
             args = argumentsToAddDependenciesWithNPM(depedenciesWithVersion, options.type);
             break;
@@ -181,7 +203,7 @@ ${token.json(options)}
             break;
     }
     options.stdout?.write(`Executing...${args.join(' ')}`);
-    await exec(options.dependencyManager, args, {
+    await exec(options.packageManager, args, {
         cwd: options.directory,
         stdout: options.stdout,
         stderr: options.stderr,
@@ -267,21 +289,6 @@ function argumentsToAddDependenciesWithPNPM(dependencies, type) {
     }
     return command;
 }
-export async function getProjectType(directory) {
-    const nodeConfigFile = pathJoin(directory, 'package.json');
-    const rubyConfigFile = pathJoin(directory, 'Gemfile');
-    const phpConfigFile = pathJoin(directory, 'composer.json');
-    if (await fileExists(nodeConfigFile)) {
-        return 'node';
-    }
-    else if (await fileExists(rubyConfigFile)) {
-        return 'ruby';
-    }
-    else if (await fileExists(phpConfigFile)) {
-        return 'php';
-    }
-    return undefined;
-}
 /**
  * Given a directory it traverses the directory up looking for a package.json and if found, it reads it
  * decodes the JSON, and returns its content as a Javascript object.
@@ -299,4 +306,4 @@ export async function findUpAndReadPackageJson(fromDirectory) {
         throw FindUpAndReadPackageJsonNotFoundError(fromDirectory);
     }
 }
-//# sourceMappingURL=dependency.js.map
+//# sourceMappingURL=node-package-manager.js.map

package/dist/node/node-package-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"node-package-manager.js","sourceRoot":"","sources":["../../src/node/node-package-manager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,cAAc,CAAA;AACjC,OAAO,EAAC,MAAM,IAAI,UAAU,EAAE,IAAI,IAAI,QAAQ,EAAC,MAAM,YAAY,CAAA;AACjE,OAAO,EAAC,IAAI,EAAE,OAAO,EAAE,IAAI,IAAI,QAAQ,EAAE,MAAM,EAAC,MAAM,YAAY,CAAA;AAClE,OAAO,EAAC,KAAK,EAAE,GAAG,EAAC,MAAM,aAAa,CAAA;AACtC,OAAO,EAAC,uBAAuB,EAAC,MAAM,eAAe,CAAA;AACrD,OAAO,EAAC,OAAO,EAAC,MAAM,cAAc,CAAA;AACpC,OAAO,EAAC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAC,MAAM,cAAc,CAAA;AAClD,OAAO,EAAC,eAAe,EAAc,MAAM,kBAAkB,CAAA;AAI7D,qCAAqC;AACrC,MAAM,CAAC,MAAM,YAAY,GAAG,WAAW,CAAA;AAEvC,qCAAqC;AACrC,MAAM,CAAC,MAAM,YAAY,GAAG,gBAAgB,CAAA;AAE5C,sEAAsE;AACtE,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,YAAY,EAAE,YAAY,CAAC,CAAA;AAUrD;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAU,CAAA;AAG9D;;;;;GAKG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,SAAiB,EAAE,EAAE;IAC5D,OAAO,IAAI,KAAK,CAAC,iBAAiB,SAAS,+BAA+B,CAAC,CAAA;AAC7E,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qCAAqC,GAAG,CAAC,SAAiB,EAAE,EAAE;IACzE,OAAO,IAAI,GAAG,CAAC,OAAO,CAAA,8DAA8D,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAA;AAC9G,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,UAAU,6BAA6B,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IAC7D,IAAI,GAAG,CAAC,qBAAqB,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE;QAC/C,OAAO,MAAM,CAAA;KACd;SAAM,IAAI,GAAG,CAAC,qBAAqB,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE;QACtD,OAAO,MAAM,CAAA;KACd;SAAM;QACL,OAAO,KAAK,CAAA;KACb;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,SAAiB;IACvD,KAAK,CAAC,OAAO,CAAA,iDAAiD,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;IACzF,MAAM,YAAY,GAAG,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC,CAAA;IACtD,MAAM,YAAY,GAAG,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC,CAAA;IACtD,IAAI,MAAM,UAAU,CAAC,YAAY,CAAC,EAAE;QAClC,OAAO,MAAM,CAAA;KACd;SAAM,IAAI,MAAM,UAAU,CAAC,YAAY,CAAC,EAAE;QACzC,OAAO,MAAM,CAAA;KACd;SAAM;QACL,OAAO,KAAK,CAAA;KACb;AACH,CAAC;AAkBD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,iCAAiC,CAAC,OAAiD;IACvG,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,iBAAiB,CAAC,EAAE;QAC9E,MAAM,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,8BAA8B,CAAC,CAAC;QACrE,GAAG,EAAE,OAAO,CAAC,SAAS;QACtB,SAAS,EAAE,IAAI;QACf,IAAI,EAAE,OAAO,CAAC,IAAI;KACnB,CAAC,CAAA;IACF,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAA;IAC7C,IAAI;QACF,MAAM,OAAO,CAAC,GAAG,CACf,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,eAAe,EAAE,EAAE;YACzC,MAAM,SAAS,GAAG,OAAO,CAAC,eAAe,CAAC,CAAA;YAC1C,MAAM,kBAAkB,CAAC,SAAS,EAAE,OAAO,CAAC,cAAc,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,CAAC,MAAM,CAAC,CAAA;QAC3G,CAAC,CAAC,CACH,CAAA;KACF;IAAC,OAAO,KAAK,EAAE;QACd,eAAe,CAAC,KAAK,EAAE,CAAA;QACvB,MAAM,KAAK,CAAA;KACZ;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,SAAiB,EACjB,cAA8B,EAC9B,MAAiB,EACjB,MAAiB,EACjB,MAAoB;IAEpB,MAAM,OAAO,GAAgB,EAAC,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAC,CAAA;IACvF,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAA;AAClD,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,eAAuB;IAC1D,MAAM,kBAAkB,GAAG,MAAM,uBAAuB,CAAC,eAAe,CAAC,CAAA;IACzE,OAAO,kBAAkB,CAAC,IAAI,CAAA;AAChC,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,eAAuB;IAC3D,MAAM,kBAAkB,GAAG,MAAM,uBAAuB,CAAC,eAAe,CAAC,CAAA;IACzE,MAAM,YAAY,GAA4B,kBAAkB,CAAC,YAAY,IAAI,EAAE,CAAA;IACnF,MAAM,eAAe,GAA4B,kBAAkB,CAAC,eAAe,IAAI,EAAE,CAAA;IAEzF,OAAO,EAAC,GAAG,YAAY,EAAE,GAAG,eAAe,EAAC,CAAA;AAC9C,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,UAAkB,EAAE,cAAsB;IACjF,KAAK,CAAC,OAAO,CAAA,oCAAoC,UAAU,eAAe,cAAc,EAAE,CAAC,CAAA;IAC3F,IAAI;QACF,MAAM,WAAW,GAAG,MAAM,uBAAuB,CAAC,UAAU,CAAC,CAAA;QAC7D,IAAI,WAAW,IAAI,IAAI,OAAO,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE;YACvE,OAAO,WAAW,CAAA;SACnB;aAAM;YACL,OAAO,SAAS,CAAA;SACjB;QACD,qDAAqD;KACtD;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,SAAS,CAAA;KACjB;AACH,CAAC;AAgCD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,eAAuB;IACnE,IAAI,CAAC,CAAC,MAAM,UAAU,CAAC,eAAe,CAAC,CAAC,EAAE;QACxC,MAAM,wBAAwB,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAA;KACzD;IACD,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAA;AACpD,CAAC;AAiDD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAC9C,YAAiC,EACjC,OAA0C,EAC1C,KAAK,GAAG,KAAK;IAEb,KAAK,CAAC,OAAO,CAAA;EACb,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC;;EAExB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC;GAClB,CAAC,CAAA;IACF,MAAM,eAAe,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,cAAc,CAAC,CAAA;IACnE,IAAI,CAAC,CAAC,MAAM,UAAU,CAAC,eAAe,CAAC,CAAC,EAAE;QACxC,MAAM,wBAAwB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;KAClD;IACD,MAAM,oBAAoB,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,eAAe,CAAC,eAAe,CAAC,CAAC,CAAA;IAChF,IAAI,iBAAiB,GAAG,YAAY,CAAA;IACpC,IAAI,CAAC,KAAK,EAAE;QACV,iBAAiB,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;YAC9C,OAAO,CAAC,oBAAoB,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QACjD,CAAC,CAAC,CAAA;KACH;IACD,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC,EAAE;QAClC,OAAM;KACP;IACD,IAAI,IAAc,CAAA;IAClB,MAAM,sBAAsB,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QAC3D,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAA;IAC9D,CAAC,CAAC,CAAA;IACF,QAAQ,OAAO,CAAC,cAAc,EAAE;QAC9B,KAAK,KAAK;YACR,IAAI,GAAG,iCAAiC,CAAC,sBAAsB,EAAE,OAAO,CAAC,IAAI,CAAC,CAAA;YAC9E,MAAK;QACP,KAAK,MAAM;YACT,IAAI,GAAG,kCAAkC,CAAC,sBAAsB,EAAE,OAAO,CAAC,IAAI,CAAC,CAAA;YAC/E,MAAK;QACP,KAAK,MAAM;YACT,IAAI,GAAG,kCAAkC,CAAC,sBAAsB,EAAE,OAAO,CAAC,IAAI,CAAC,CAAA;YAC/E,MAAK;KACR;IACD,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,eAAe,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;IACtD,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,IAAI,EAAE;QACvC,GAAG,EAAE,OAAO,CAAC,SAAS;QACtB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,wCAAwC,CAC5D,YAAsB,EACtB,OAA0C;IAE1C,MAAM,0BAA0B,CAC9B,YAAY,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;QAC9B,OAAO,EAAC,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAC,CAAA;IAC/C,CAAC,CAAC,EACF,OAAO,CACR,CAAA;AACH,CAAC;AAED,+CAA+C;AAC/C,+EAA+E;AAC/E,wDAAwD;AACxD,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAAC,YAAsB,EAAE,OAA0C;IAC/G,MAAM,0BAA0B,CAC9B,YAAY,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;QAC9B,OAAO,EAAC,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAC,CAAA;IAC9C,CAAC,CAAC,EACF,OAAO,EACP,IAAI,CACL,CAAA;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAS,iCAAiC,CAAC,YAAsB,EAAE,IAAoB;IACrF,IAAI,OAAO,GAAG,CAAC,SAAS,CAAC,CAAA;IACzB,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;IACtC,QAAQ,IAAI,EAAE;QACZ,KAAK,KAAK;YACR,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;YAC1B,MAAK;QACP,KAAK,MAAM;YACT,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;YAC3B,MAAK;QACP,KAAK,MAAM;YACT,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;YAC3B,MAAK;KACR;IACD,OAAO,OAAO,CAAA;AAChB,CAAC;AAED;;;;;GAKG;AACH,SAAS,kCAAkC,CAAC,YAAsB,EAAE,IAAoB;IACtF,IAAI,OAAO,GAAG,CAAC,KAAK,CAAC,CAAA;IACrB,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;IACtC,QAAQ,IAAI,EAAE;QACZ,KAAK,KAAK;YACR,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YACrB,MAAK;QACP,KAAK,MAAM;YACT,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YACtB,MAAK;QACP,KAAK,MAAM;YACT,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YACtB,MAAK;KACR;IACD,OAAO,OAAO,CAAA;AAChB,CAAC;AAED;;;;;GAKG;AACH,SAAS,kCAAkC,CAAC,YAAsB,EAAE,IAAoB;IACtF,IAAI,OAAO,GAAG,CAAC,KAAK,CAAC,CAAA;IACrB,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;IACtC,QAAQ,IAAI,EAAE;QACZ,KAAK,KAAK;YACR,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;YAC1B,MAAK;QACP,KAAK,MAAM;YACT,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;YAC3B,MAAK;QACP,KAAK,MAAM;YACT,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;YAC3B,MAAK;KACR;IACD,OAAO,OAAO,CAAA;AAChB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAAC,aAAqB;IAClE,MAAM,eAAe,GAAG,MAAM,MAAM,CAAC,cAAc,EAAE,EAAC,GAAG,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAC,CAAC,CAAA;IACxF,IAAI,eAAe,EAAE;QACnB,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAA;QAC/D,OAAO,EAAC,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,WAAW,EAAC,CAAA;KACrD;SAAM;QACL,MAAM,qCAAqC,CAAC,aAAa,CAAC,CAAA;KAC3D;AACH,CAAC","sourcesContent":["import {exec} from '../system.js'\nimport {exists as fileExists, read as readFile} from '../file.js'\nimport {glob, dirname, join as pathJoin, findUp} from '../path.js'\nimport {Abort, Bug} from '../error.js'\nimport {latestNpmPackageVersion} from '../version.js'\nimport {Version} from '../semver.js'\nimport {content, token, debug} from '../output.js'\nimport {AbortController, AbortSignal} from 'abort-controller'\nimport type {Writable} from 'node:stream'\nimport type {ExecOptions} from '../system.js'\n\n/** The name of the Yarn lock file */\nexport const yarnLockfile = 'yarn.lock'\n\n/** The name of the pnpm lock file */\nexport const pnpmLockfile = 'pnpm-lock.yaml'\n\n/** An array containing the lockfiles from all the package managers */\nexport const lockfiles = [yarnLockfile, pnpmLockfile]\n\n/**\n * A union type that represents the type of dependencies in the package.json\n * - dev: devDependencies\n * - prod: dependencies\n * - peer: peerDependencies\n */\nexport type DependencyType = 'dev' | 'prod' | 'peer'\n\n/**\n * A union that represents the package managers available.\n */\nexport const packageManager = ['yarn', 'npm', 'pnpm'] as const\nexport type PackageManager = typeof packageManager[number]\n\n/**\n * Returns an abort error that's thrown when a directory that's expected to have\n * a package.json doesn't have it.\n * @param directory {string} The path to the directory that should contain a package.json\n * @returns {Abort} An abort error.\n */\nexport const PackageJsonNotFoundError = (directory: string) => {\n  return new Abort(`The directory ${directory} doesn't have a package.json.`)\n}\n\n/**\n * Returns a bug error that's thrown when the lookup of the package.json traversing the directory\n * hierarchy up can't find a package.json\n * @param directory {string} The directory from which the traverse has been done\n * @returns {Abort} An abort error.\n */\nexport const FindUpAndReadPackageJsonNotFoundError = (directory: string) => {\n  return new Bug(content`Couldn't find a a package.json traversing directories from ${token.path(directory)}`)\n}\n\n/**\n * Returns the dependency manager used to run the create workflow.\n * @param env {Object} The environment variables of the process in which the CLI runs.\n * @returns The dependency manager\n */\nexport function packageManagerUsedForCreating(env = process.env): PackageManager {\n  if (env.npm_config_user_agent?.includes('yarn')) {\n    return 'yarn'\n  } else if (env.npm_config_user_agent?.includes('pnpm')) {\n    return 'pnpm'\n  } else {\n    return 'npm'\n  }\n}\n\n/**\n * Returns the dependency manager used by an existing project.\n * @param directory {string} The root directory of the project.\n * @returns The dependency manager\n */\nexport async function getPackageManager(directory: string): Promise<PackageManager> {\n  debug(content`Obtaining the dependency manager in directory ${token.path(directory)}...`)\n  const yarnLockPath = pathJoin(directory, yarnLockfile)\n  const pnpmLockPath = pathJoin(directory, pnpmLockfile)\n  if (await fileExists(yarnLockPath)) {\n    return 'yarn'\n  } else if (await fileExists(pnpmLockPath)) {\n    return 'pnpm'\n  } else {\n    return 'npm'\n  }\n}\n\ninterface InstallNPMDependenciesRecursivelyOptions {\n  /**\n   * The dependency manager to use to install the dependencies.\n   */\n  packageManager: PackageManager\n  /**\n   * The directory from where we'll find package.json's recursively\n   */\n  directory: string\n\n  /**\n   * Specifies the maximum depth of the glob search.\n   */\n  deep?: number\n}\n\n/**\n * This function traverses down a directory tree to find directories containing a package.json\n * and installs the dependencies if needed. To know if it's needed, it uses the \"check\" command\n * provided by dependency managers.\n * @param options {InstallNPMDependenciesRecursivelyOptions} Options to install dependencies recursively.\n */\nexport async function installNPMDependenciesRecursively(options: InstallNPMDependenciesRecursivelyOptions) {\n  const packageJsons = await glob(pathJoin(options.directory, '**/package.json'), {\n    ignore: [pathJoin(options.directory, 'node_modules/**/package.json')],\n    cwd: options.directory,\n    onlyFiles: true,\n    deep: options.deep,\n  })\n  const abortController = new AbortController()\n  try {\n    await Promise.all(\n      packageJsons.map(async (packageJsonPath) => {\n        const directory = dirname(packageJsonPath)\n        await installNodeModules(directory, options.packageManager, undefined, undefined, abortController.signal)\n      }),\n    )\n  } catch (error) {\n    abortController.abort()\n    throw error\n  }\n}\n\n/**\n * Installs the dependencies in the given directory.\n * @param directory {string} The directory that contains the package.json\n * @param packageManager {PackageManager} The package manager to use to install the dependencies.\n * @param stdout {Writable} Standard output stream.\n * @param stderr {Writable} Standard error stream.\n * @param signal {AbortSignal} Abort signal.\n * @returns stderr {Writable} Standard error stream.\n */\nexport async function installNodeModules(\n  directory: string,\n  packageManager: PackageManager,\n  stdout?: Writable,\n  stderr?: Writable,\n  signal?: AbortSignal,\n) {\n  const options: ExecOptions = {cwd: directory, stdin: undefined, stdout, stderr, signal}\n  await exec(packageManager, ['install'], options)\n}\n\n/**\n * Returns the name of the package configured in its package.json\n * @param packageJsonPath {string} Path to the package.json file\n * @returns A promise that resolves with the name.\n */\nexport async function getPackageName(packageJsonPath: string): Promise<string> {\n  const packageJsonContent = await readAndParsePackageJson(packageJsonPath)\n  return packageJsonContent.name\n}\n\n/**\n * Returns the list of production and dev dependencies of a package.json\n * @param packageJsonPath {string} Path to the package.json file\n * @returns A promise that resolves with the list of dependencies.\n */\nexport async function getDependencies(packageJsonPath: string): Promise<{[key: string]: string}> {\n  const packageJsonContent = await readAndParsePackageJson(packageJsonPath)\n  const dependencies: {[key: string]: string} = packageJsonContent.dependencies ?? {}\n  const devDependencies: {[key: string]: string} = packageJsonContent.devDependencies ?? {}\n\n  return {...dependencies, ...devDependencies}\n}\n\n/**\n * Given an NPM dependency, it checks if there's a more recent version, and if there is, it returns its value.\n * @param dependency {string} The dependency name (e.g. react)\n * @param currentVersion {string} The current version.\n * @returns {Promise<string>} A promise that resolves with a more recent version or undefined if there's no more recent version.\n */\nexport async function checkForNewVersion(dependency: string, currentVersion: string): Promise<string | undefined> {\n  debug(content`Checking if there's a version of ${dependency} newer than ${currentVersion}`)\n  try {\n    const lastVersion = await latestNpmPackageVersion(dependency)\n    if (lastVersion && new Version(currentVersion).compare(lastVersion) < 0) {\n      return lastVersion\n    } else {\n      return undefined\n    }\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch (error) {\n    return undefined\n  }\n}\n\n/**\n * An interface that represents a package.json\n */\ninterface PackageJson {\n  /**\n   * The absolute path to the package.json\n   */\n  path: string\n\n  /**\n   * The name attribute of the package.json\n   */\n  name: string\n\n  /**\n   * The version attribute of the package.json\n   */\n  version?: string\n\n  /**\n   * The dependencies attribute of the package.json\n   */\n  dependencies?: {[key: string]: string}\n\n  /**\n   * The devDependencies attribute of the package.json\n   */\n  devDependencies?: {[key: string]: string}\n}\n\n/**\n * Reads and parses a package.json\n * @param packageJsonPath {string} Path to the package.json\n * @returns {Promise<PackageJson>} An promise that resolves with an in-memory representation\n *    of the package.json or rejects with an error if the file is not found or the content is\n *    not decodable.\n */\nexport async function readAndParsePackageJson(packageJsonPath: string): Promise<PackageJson> {\n  if (!(await fileExists(packageJsonPath))) {\n    throw PackageJsonNotFoundError(dirname(packageJsonPath))\n  }\n  return JSON.parse(await readFile(packageJsonPath))\n}\n\ninterface AddNPMDependenciesIfNeededOptions {\n  /** How dependencies should be added */\n  type: DependencyType\n\n  /** The dependency manager to use to add dependencies */\n  packageManager: PackageManager\n\n  /** The directory that contains the package.json where dependencies will be added */\n  directory: string\n\n  /** Standard output coming from the underlying installation process */\n  stdout?: Writable\n\n  /** Standard error coming from the underlying installation process */\n  stderr?: Writable\n\n  /** Abort signal to stop the process */\n  signal?: AbortSignal\n}\n\n/**\n * An interface that represents a dependency name with its version\n */\nexport interface DependencyVersion {\n  /**\n   * The name of the NPM dependency as it's reflected in the package.json:\n   *\n   * @example\n   *  In the example below name would be \"react\"\n   *  {\n   *    \"react\": \"1.2.3\"\n   *  }\n   */\n  name: string\n\n  /**\n   * The version of the NPM dependency as it's reflected in the package.json:\n   *\n   * @example\n   *  In the example below version would be \"1.2.3\"\n   *  {\n   *    \"react\": \"1.2.3\"\n   *  }\n   */\n  version: string | undefined\n}\n\n/**\n * Adds dependencies to a Node project (i.e. a project that has a package.json)\n * @param dependencies {string[]} List of dependencies to be added.\n * @param options {AddNPMDependenciesIfNeededOptions} Options for adding dependencies.\n */\nexport async function addNPMDependenciesIfNeeded(\n  dependencies: DependencyVersion[],\n  options: AddNPMDependenciesIfNeededOptions,\n  force = false,\n) {\n  debug(content`Adding the following dependencies if needed:\n${token.json(dependencies)}\nWith options:\n${token.json(options)}\n  `)\n  const packageJsonPath = pathJoin(options.directory, 'package.json')\n  if (!(await fileExists(packageJsonPath))) {\n    throw PackageJsonNotFoundError(options.directory)\n  }\n  const existingDependencies = Object.keys(await getDependencies(packageJsonPath))\n  let dependenciesToAdd = dependencies\n  if (!force) {\n    dependenciesToAdd = dependencies.filter((dep) => {\n      return !existingDependencies.includes(dep.name)\n    })\n  }\n  if (dependenciesToAdd.length === 0) {\n    return\n  }\n  let args: string[]\n  const depedenciesWithVersion = dependenciesToAdd.map((dep) => {\n    return dep.version ? `${dep.name}@${dep.version}` : dep.name\n  })\n  switch (options.packageManager) {\n    case 'npm':\n      args = argumentsToAddDependenciesWithNPM(depedenciesWithVersion, options.type)\n      break\n    case 'yarn':\n      args = argumentsToAddDependenciesWithYarn(depedenciesWithVersion, options.type)\n      break\n    case 'pnpm':\n      args = argumentsToAddDependenciesWithPNPM(depedenciesWithVersion, options.type)\n      break\n  }\n  options.stdout?.write(`Executing...${args.join(' ')}`)\n  await exec(options.packageManager, args, {\n    cwd: options.directory,\n    stdout: options.stdout,\n    stderr: options.stderr,\n    signal: options.signal,\n  })\n}\n\nexport async function addNPMDependenciesWithoutVersionIfNeeded(\n  dependencies: string[],\n  options: AddNPMDependenciesIfNeededOptions,\n) {\n  await addNPMDependenciesIfNeeded(\n    dependencies.map((dependency) => {\n      return {name: dependency, version: undefined}\n    }),\n    options,\n  )\n}\n\n// eslint-disable-next-line no-warning-comments\n// TODO: Switch it around so add-if-needed depends on this, rather than calling\n// if-needed with force: true which is counterintuitive.\nexport async function addLatestNPMDependencies(dependencies: string[], options: AddNPMDependenciesIfNeededOptions) {\n  await addNPMDependenciesIfNeeded(\n    dependencies.map((dependency) => {\n      return {name: dependency, version: 'latest'}\n    }),\n    options,\n    true,\n  )\n}\n\n/**\n * Returns the arguments to add dependencies using NPM.\n * @param dependencies {string[]} The list of dependencies to add\n * @param type {DependencyType} The dependency type.\n * @returns {string[]} An array with the arguments.\n */\nfunction argumentsToAddDependenciesWithNPM(dependencies: string[], type: DependencyType): string[] {\n  let command = ['install']\n  command = command.concat(dependencies)\n  switch (type) {\n    case 'dev':\n      command.push('--save-dev')\n      break\n    case 'peer':\n      command.push('--save-peer')\n      break\n    case 'prod':\n      command.push('--save-prod')\n      break\n  }\n  return command\n}\n\n/**\n * Returns the arguments to add dependencies using Yarn.\n * @param dependencies {string[]} The list of dependencies to add\n * @param type {DependencyType} The dependency type.\n * @returns {string[]} An array with the arguments.\n */\nfunction argumentsToAddDependenciesWithYarn(dependencies: string[], type: DependencyType): string[] {\n  let command = ['add']\n  command = command.concat(dependencies)\n  switch (type) {\n    case 'dev':\n      command.push('--dev')\n      break\n    case 'peer':\n      command.push('--peer')\n      break\n    case 'prod':\n      command.push('--prod')\n      break\n  }\n  return command\n}\n\n/**\n * Returns the arguments to add dependencies using PNPM.\n * @param dependencies {string[]} The list of dependencies to add\n * @param type {DependencyType} The dependency type.\n * @returns {string[]} An array with the arguments.\n */\nfunction argumentsToAddDependenciesWithPNPM(dependencies: string[], type: DependencyType): string[] {\n  let command = ['add']\n  command = command.concat(dependencies)\n  switch (type) {\n    case 'dev':\n      command.push('--save-dev')\n      break\n    case 'peer':\n      command.push('--save-peer')\n      break\n    case 'prod':\n      command.push('--save-prod')\n      break\n  }\n  return command\n}\n\n/**\n * Given a directory it traverses the directory up looking for a package.json and if found, it reads it\n * decodes the JSON, and returns its content as a Javascript object.\n * @param options {string} The directory from which traverse up.\n * @returns {Promise<{path: string; content: unknown}>} If found, the promise resolves with the path to the\n *  package.json and its content. If not found, it throws a FindUpAndReadPackageJsonNotFoundError error.\n */\nexport async function findUpAndReadPackageJson(fromDirectory: string): Promise<{path: string; content: unknown}> {\n  const packageJsonPath = await findUp('package.json', {cwd: fromDirectory, type: 'file'})\n  if (packageJsonPath) {\n    const packageJson = JSON.parse(await readFile(packageJsonPath))\n    return {path: packageJsonPath, content: packageJson}\n  } else {\n    throw FindUpAndReadPackageJsonNotFoundError(fromDirectory)\n  }\n}\n"]}

package/dist/{ruby.d.ts → node/ruby.d.ts}

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { AdminSession } from './session.js';
+import { AdminSession } from '../session.js';
 import { Writable } from 'node:stream';
 /**
  * Execute CLI 2.0 commands.
@@ -9,13 +9,22 @@ import { Writable } from 'node:stream';
  * @param args {string[]} List of argumets to execute. (ex: ['theme', 'pull'])
  * @param adminSession {AdminSession} Contains token and store to pass to CLI 2.0, which will be set as environment variables
  */
-export declare function execCLI(args: string[], adminSession?: AdminSession): Promise<void>;
+export declare function execCLI2(args: string[], adminSession?: AdminSession): Promise<void>;
 interface ExecThemeCheckCLIOptions {
+    /** A list of directories in which theme-check should run */
     directories: string[];
+    /** Arguments to pass to the theme-check CLI */
     args?: string[];
+    /** Writable to send standard output content through */
     stdout: Writable;
+    /** Writable to send standard error content through */
     stderr: Writable;
 }
+/**
+ * A function that installs (if needed) and runs the theme-check CLI.
+ * @param options {ExecThemeCheckCLIOptions} Options to customize the execution of theme-check.
+ * @returns {Promise<void>} A promise that resolves or rejects depending on the result of the underlying theme-check process.
+ */
 export declare function execThemeCheckCLI({ directories, args, stdout, stderr, }: ExecThemeCheckCLIOptions): Promise<void[]>;
 export declare function version(): Promise<string | undefined>;
 export {};

package/dist/{ruby.js → node/ruby.js}

@@ -1,16 +1,16 @@
-import * as file from './file.js';
-import * as ui from './ui.js';
-import * as system from './system.js';
-import { Abort } from './error.js';
-import { glob, join } from './path.js';
-import constants from './constants.js';
-import { coerce } from './semver.js';
-import { content, token } from './output.js';
+import * as file from '../file.js';
+import * as ui from '../ui.js';
+import * as system from '../system.js';
+import { Abort } from '../error.js';
+import { glob, join } from '../path.js';
+import constants from '../constants.js';
+import { coerce } from '../semver.js';
+import { content, token } from '../output.js';
 // eslint-disable-next-line no-restricted-imports
 import { spawn } from 'child_process';
 import { Writable } from 'node:stream';
 const RubyCLIVersion = '2.16.0';
-const ThemeCheckVersion = '1.10.2';
+const ThemeCheckVersion = '1.10.3';
 const MinBundlerVersion = '2.3.8';
 const MinRubyVersion = '2.3.0';
 const MinRubyGemVersion = '2.5.0';
@@ -22,7 +22,7 @@ const MinRubyGemVersion = '2.5.0';
  * @param args {string[]} List of argumets to execute. (ex: ['theme', 'pull'])
  * @param adminSession {AdminSession} Contains token and store to pass to CLI 2.0, which will be set as environment variables
  */
-export async function execCLI(args, adminSession) {
+export async function execCLI2(args, adminSession) {
     await installCLIDependencies();
     const env = {
         ...process.env,
@@ -36,6 +36,11 @@ export async function execCLI(args, adminSession) {
         env,
     });
 }
+/**
+ * A function that installs (if needed) and runs the theme-check CLI.
+ * @param options {ExecThemeCheckCLIOptions} Options to customize the execution of theme-check.
+ * @returns {Promise<void>} A promise that resolves or rejects depending on the result of the underlying theme-check process.
+ */
 export async function execThemeCheckCLI({ directories, args, stdout, stderr, }) {
     await installThemeCheckCLIDependencies(stdout);
     const processes = directories.map(async (directory) => {