@shopify/cli-kit 3.0.25 → 3.1.0

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

@@ -0,0 +1,309 @@
+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';
+/** 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)}`);
+};
+/**
+ * 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 function packageManagerUsedForCreating(env = process.env) {
+    if (env.npm_config_user_agent?.includes('yarn')) {
+        return 'yarn';
+    }
+    else if (env.npm_config_user_agent?.includes('pnpm')) {
+        return 'pnpm';
+    }
+    else {
+        return 'npm';
+    }
+}
+/**
+ * Returns the dependency manager used by an existing project.
+ * @param directory {string} The root directory of the project.
+ * @returns The dependency manager
+ */
+export async function getPackageManager(directory) {
+    debug(content `Obtaining the dependency manager in directory ${token.path(directory)}...`);
+    const yarnLockPath = pathJoin(directory, yarnLockfile);
+    const pnpmLockPath = pathJoin(directory, pnpmLockfile);
+    if (await fileExists(yarnLockPath)) {
+        return 'yarn';
+    }
+    else if (await fileExists(pnpmLockPath)) {
+        return 'pnpm';
+    }
+    else {
+        return 'npm';
+    }
+}
+/**
+ * This function traverses down a directory tree to find directories containing a package.json
+ * and installs the dependencies if needed. To know if it's needed, it uses the "check" command
+ * provided by dependency managers.
+ * @param options {InstallNPMDependenciesRecursivelyOptions} Options to install dependencies recursively.
+ */
+export async function installNPMDependenciesRecursively(options) {
+    const packageJsons = await glob(pathJoin(options.directory, '**/package.json'), {
+        ignore: [pathJoin(options.directory, 'node_modules/**/package.json')],
+        cwd: options.directory,
+        onlyFiles: true,
+        deep: options.deep,
+    });
+    const abortController = new AbortController();
+    try {
+        await Promise.all(packageJsons.map(async (packageJsonPath) => {
+            const directory = dirname(packageJsonPath);
+            await installNodeModules(directory, options.packageManager, undefined, undefined, abortController.signal);
+        }));
+    }
+    catch (error) {
+        abortController.abort();
+        throw error;
+    }
+}
+/**
+ * Installs the dependencies in the given directory.
+ * @param directory {string} The directory that contains the package.json
+ * @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 installNodeModules(directory, packageManager, stdout, stderr, signal) {
+    const options = { cwd: directory, stdin: undefined, stdout, stderr, signal };
+    await exec(packageManager, ['install'], options);
+}
+/**
+ * Returns the name of the package configured in its package.json
+ * @param packageJsonPath {string} Path to the package.json file
+ * @returns A promise that resolves with the name.
+ */
+export async function getPackageName(packageJsonPath) {
+    const packageJsonContent = await readAndParsePackageJson(packageJsonPath);
+    return packageJsonContent.name;
+}
+/**
+ * Returns the list of production and dev dependencies of a package.json
+ * @param packageJsonPath {string} Path to the package.json file
+ * @returns A promise that resolves with the list of dependencies.
+ */
+export async function getDependencies(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 {
+        const lastVersion = await latestNpmPackageVersion(dependency);
+        if (lastVersion && new Version(currentVersion).compare(lastVersion) < 0) {
+            return lastVersion;
+        }
+        else {
+            return undefined;
+        }
+        // eslint-disable-next-line no-catch-all/no-catch-all
+    }
+    catch (error) {
+        return undefined;
+    }
+}
+/**
+ * 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));
+    }
+    return JSON.parse(await readFile(packageJsonPath));
+}
+/**
+ * Adds dependencies to a Node project (i.e. a project that has a package.json)
+ * @param dependencies {string[]} List of dependencies to be added.
+ * @param options {AddNPMDependenciesIfNeededOptions} Options for adding dependencies.
+ */
+export async function addNPMDependenciesIfNeeded(dependencies, options, force = false) {
+    debug(content `Adding the following dependencies if needed:
+${token.json(dependencies)}
+With options:
+${token.json(options)}
+  `);
+    const packageJsonPath = pathJoin(options.directory, 'package.json');
+    if (!(await fileExists(packageJsonPath))) {
+        throw PackageJsonNotFoundError(options.directory);
+    }
+    const existingDependencies = Object.keys(await getDependencies(packageJsonPath));
+    let dependenciesToAdd = dependencies;
+    if (!force) {
+        dependenciesToAdd = dependencies.filter((dep) => {
+            return !existingDependencies.includes(dep.name);
+        });
+    }
+    if (dependenciesToAdd.length === 0) {
+        return;
+    }
+    let args;
+    const depedenciesWithVersion = dependenciesToAdd.map((dep) => {
+        return dep.version ? `${dep.name}@${dep.version}` : dep.name;
+    });
+    switch (options.packageManager) {
+        case 'npm':
+            args = argumentsToAddDependenciesWithNPM(depedenciesWithVersion, options.type);
+            break;
+        case 'yarn':
+            args = argumentsToAddDependenciesWithYarn(depedenciesWithVersion, options.type);
+            break;
+        case 'pnpm':
+            args = argumentsToAddDependenciesWithPNPM(depedenciesWithVersion, options.type);
+            break;
+    }
+    options.stdout?.write(`Executing...${args.join(' ')}`);
+    await exec(options.packageManager, args, {
+        cwd: options.directory,
+        stdout: options.stdout,
+        stderr: options.stderr,
+        signal: options.signal,
+    });
+}
+export async function addNPMDependenciesWithoutVersionIfNeeded(dependencies, options) {
+    await addNPMDependenciesIfNeeded(dependencies.map((dependency) => {
+        return { name: dependency, version: undefined };
+    }), options);
+}
+// eslint-disable-next-line no-warning-comments
+// TODO: Switch it around so add-if-needed depends on this, rather than calling
+// if-needed with force: true which is counterintuitive.
+export async function addLatestNPMDependencies(dependencies, options) {
+    await addNPMDependenciesIfNeeded(dependencies.map((dependency) => {
+        return { name: dependency, version: 'latest' };
+    }), options, true);
+}
+/**
+ * Returns the arguments to add dependencies using NPM.
+ * @param dependencies {string[]} The list of dependencies to add
+ * @param type {DependencyType} The dependency type.
+ * @returns {string[]} An array with the arguments.
+ */
+function argumentsToAddDependenciesWithNPM(dependencies, type) {
+    let command = ['install'];
+    command = command.concat(dependencies);
+    switch (type) {
+        case 'dev':
+            command.push('--save-dev');
+            break;
+        case 'peer':
+            command.push('--save-peer');
+            break;
+        case 'prod':
+            command.push('--save-prod');
+            break;
+    }
+    return command;
+}
+/**
+ * Returns the arguments to add dependencies using Yarn.
+ * @param dependencies {string[]} The list of dependencies to add
+ * @param type {DependencyType} The dependency type.
+ * @returns {string[]} An array with the arguments.
+ */
+function argumentsToAddDependenciesWithYarn(dependencies, type) {
+    let command = ['add'];
+    command = command.concat(dependencies);
+    switch (type) {
+        case 'dev':
+            command.push('--dev');
+            break;
+        case 'peer':
+            command.push('--peer');
+            break;
+        case 'prod':
+            command.push('--prod');
+            break;
+    }
+    return command;
+}
+/**
+ * Returns the arguments to add dependencies using PNPM.
+ * @param dependencies {string[]} The list of dependencies to add
+ * @param type {DependencyType} The dependency type.
+ * @returns {string[]} An array with the arguments.
+ */
+function argumentsToAddDependenciesWithPNPM(dependencies, type) {
+    let command = ['add'];
+    command = command.concat(dependencies);
+    switch (type) {
+        case 'dev':
+            command.push('--save-dev');
+            break;
+        case 'peer':
+            command.push('--save-peer');
+            break;
+        case 'prod':
+            command.push('--save-prod');
+            break;
+    }
+    return command;
+}
+/**
+ * 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.
+ * @param options {string} The directory from which traverse up.
+ * @returns {Promise<{path: string; content: unknown}>} If found, the promise resolves with the path to the
+ *  package.json and its content. If not found, it throws a FindUpAndReadPackageJsonNotFoundError error.
+ */
+export async function findUpAndReadPackageJson(fromDirectory) {
+    const packageJsonPath = await findUp('package.json', { cwd: fromDirectory, type: 'file' });
+    if (packageJsonPath) {
+        const packageJson = JSON.parse(await readFile(packageJsonPath));
+        return { path: packageJsonPath, content: packageJson };
+    }
+    else {
+        throw FindUpAndReadPackageJsonNotFoundError(fromDirectory);
+    }
+}
+//# 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/node/ruby.d.ts

@@ -0,0 +1,30 @@
+/// <reference types="node" />
+import { AdminSession } from '../session.js';
+import { Writable } from 'node:stream';
+/**
+ * Execute CLI 2.0 commands.
+ * Installs a version of RubyCLI as a vendor dependency in a hidden folder in the system.
+ * User must have a valid ruby+bundler environment to run any command.
+ *
+ * @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 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/node/ruby.js

@@ -0,0 +1,197 @@
+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.3';
+const MinBundlerVersion = '2.3.8';
+const MinRubyVersion = '2.3.0';
+const MinRubyGemVersion = '2.5.0';
+/**
+ * Execute CLI 2.0 commands.
+ * Installs a version of RubyCLI as a vendor dependency in a hidden folder in the system.
+ * User must have a valid ruby+bundler environment to run any command.
+ *
+ * @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 execCLI2(args, adminSession) {
+    await installCLIDependencies();
+    const env = {
+        ...process.env,
+        SHOPIFY_CLI_ADMIN_AUTH_TOKEN: adminSession?.token,
+        SHOPIFY_CLI_STORE: adminSession?.storeFqdn,
+    };
+    spawn('bundle', ['exec', 'shopify'].concat(args), {
+        stdio: 'inherit',
+        cwd: shopifyCLIDirectory(),
+        shell: true,
+        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) => {
+        // Check that there are files aside from the extension TOML config file,
+        // otherwise theme-check will return a false failure.
+        const files = await glob(join(directory, '/**/*'));
+        const fileCount = files.filter((file) => !file.match(/\.toml$/)).length;
+        if (fileCount === 0)
+            return;
+        const customStderr = new Writable({
+            write(chunk, ...args) {
+                // For some reason, theme-check reports this initial status line to stderr
+                // See https://github.com/Shopify/theme-check/blob/1092737cfb58a73ca397ffb1371665dc55df2976/lib/theme_check/language_server/diagnostics_engine.rb#L31
+                // which leads to https://github.com/Shopify/theme-check/blob/1092737cfb58a73ca397ffb1371665dc55df2976/lib/theme_check/language_server/io_messenger.rb#L65
+                if (chunk.toString('ascii').match(/^Checking/)) {
+                    stdout.write(chunk, ...args);
+                }
+                else {
+                    stderr.write(chunk, ...args);
+                }
+            },
+        });
+        await system.exec('bundle', ['exec', 'theme-check'].concat([directory, ...(args || [])]), {
+            stdout,
+            stderr: customStderr,
+            cwd: themeCheckDirectory(),
+        });
+    });
+    return Promise.all(processes);
+}
+/**
+ * Validate Ruby Enviroment
+ * Install Theme Check CLI and its dependencies
+ * Shows a loading message if it's the first time installing dependencies
+ * or if we are installing a new version of Theme Check CLI
+ */
+async function installThemeCheckCLIDependencies(stdout) {
+    const exists = await file.exists(themeCheckDirectory());
+    if (!exists)
+        stdout.write('Installing theme dependencies...');
+    const list = ui.newListr([
+        {
+            title: 'Installing theme dependencies',
+            task: async () => {
+                await validateRubyEnv();
+                await createThemeCheckCLIWorkingDirectory();
+                await createThemeCheckGemfile();
+                await bundleInstallThemeCheck();
+            },
+        },
+    ], { renderer: 'silent' });
+    await list.run();
+    if (!exists)
+        stdout.write('Installed theme dependencies!');
+}
+/**
+ * Validate Ruby Enviroment
+ * Install RubyCLI and its dependencies
+ * Shows a loading spinner if it's the first time installing dependencies
+ * or if we are installing a new version of RubyCLI
+ */
+async function installCLIDependencies() {
+    const exists = await file.exists(shopifyCLIDirectory());
+    const renderer = exists ? 'silent' : 'default';
+    const list = ui.newListr([
+        {
+            title: 'Installing theme dependencies',
+            task: async () => {
+                await validateRubyEnv();
+                await createShopifyCLIWorkingDirectory();
+                await createShopifyCLIGemfile();
+                await bundleInstallShopifyCLI();
+            },
+        },
+    ], { renderer });
+    await list.run();
+}
+async function validateRubyEnv() {
+    await validateRuby();
+    await validateRubyGems();
+    await validateBundler();
+}
+async function validateRuby() {
+    let version;
+    try {
+        const stdout = await system.captureOutput('ruby', ['-v']);
+        version = coerce(stdout);
+    }
+    catch {
+        throw new Abort('Ruby environment not found', `Make sure you have Ruby installed on your system: ${content `${token.link('', 'https://www.ruby-lang.org/en/documentation/installation/')}`.value}`);
+    }
+    const isValid = version?.compare(MinRubyVersion);
+    if (isValid === -1 || isValid === undefined) {
+        throw new Abort(`Ruby version ${content `${token.yellow(version.raw)}`.value} is not supported`, `Make sure you have at least Ruby ${content `${token.yellow(MinRubyVersion)}`.value} installed on your system: ${content `${token.link('', 'https://www.ruby-lang.org/en/documentation/installation/')}`.value}`);
+    }
+}
+async function validateRubyGems() {
+    const stdout = await system.captureOutput('gem', ['-v']);
+    const version = coerce(stdout);
+    const isValid = version?.compare(MinRubyGemVersion);
+    if (isValid === -1 || isValid === undefined) {
+        throw new Abort(`RubyGems version ${content `${token.yellow(version.raw)}`.value} is not supported`, `To update to the latest version of RubyGems, run ${content `${token.genericShellCommand('gem update --system')}`.value}`);
+    }
+}
+async function validateBundler() {
+    let version;
+    try {
+        const stdout = await system.captureOutput('bundler', ['-v']);
+        version = coerce(stdout);
+    }
+    catch {
+        throw new Abort('Bundler not found', `To install the latest version of Bundler, run ${content `${token.genericShellCommand('gem install bundler')}`.value}`);
+    }
+    const isValid = version?.compare(MinBundlerVersion);
+    if (isValid === -1 || isValid === undefined) {
+        throw new Abort(`Bundler version ${content `${token.yellow(version.raw)}`.value} is not supported`, `To update to the latest version of Bundler, run ${content `${token.genericShellCommand('gem install bundler')}`.value}`);
+    }
+}
+function createShopifyCLIWorkingDirectory() {
+    return file.mkdir(shopifyCLIDirectory());
+}
+function createThemeCheckCLIWorkingDirectory() {
+    return file.mkdir(themeCheckDirectory());
+}
+async function createShopifyCLIGemfile() {
+    const gemPath = join(shopifyCLIDirectory(), 'Gemfile');
+    await file.write(gemPath, `source 'https://rubygems.org'\ngem 'shopify-cli', '${RubyCLIVersion}'`);
+}
+async function createThemeCheckGemfile() {
+    const gemPath = join(themeCheckDirectory(), 'Gemfile');
+    await file.write(gemPath, `source 'https://rubygems.org'\ngem 'theme-check', '${ThemeCheckVersion}'`);
+}
+async function bundleInstallShopifyCLI() {
+    await system.exec('bundle', ['config', 'set', '--local', 'path', shopifyCLIDirectory()], { cwd: shopifyCLIDirectory() });
+    await system.exec('bundle', ['install'], { cwd: shopifyCLIDirectory() });
+}
+async function bundleInstallThemeCheck() {
+    await system.exec('bundle', ['config', 'set', '--local', 'path', themeCheckDirectory()], { cwd: themeCheckDirectory() });
+    await system.exec('bundle', ['install'], { cwd: themeCheckDirectory() });
+}
+function shopifyCLIDirectory() {
+    return join(constants.paths.directories.cache.vendor.path(), 'ruby-cli', RubyCLIVersion);
+}
+function themeCheckDirectory() {
+    return join(constants.paths.directories.cache.vendor.path(), 'theme-check', ThemeCheckVersion);
+}
+export async function version() {
+    const parseOutput = (version) => version.match(/ruby (\d+\.\d+\.\d+)/)?.[1];
+    return system
+        .captureOutput('ruby', ['-v'])
+        .then(parseOutput)
+        .catch(() => undefined);
+}
+//# sourceMappingURL=ruby.js.map

package/dist/node/ruby.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ruby.js","sourceRoot":"","sources":["../../src/node/ruby.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,YAAY,CAAA;AAClC,OAAO,KAAK,EAAE,MAAM,UAAU,CAAA;AAC9B,OAAO,KAAK,MAAM,MAAM,cAAc,CAAA;AACtC,OAAO,EAAC,KAAK,EAAC,MAAM,aAAa,CAAA;AACjC,OAAO,EAAC,IAAI,EAAE,IAAI,EAAC,MAAM,YAAY,CAAA;AACrC,OAAO,SAAS,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAC,MAAM,EAAC,MAAM,cAAc,CAAA;AAEnC,OAAO,EAAC,OAAO,EAAE,KAAK,EAAC,MAAM,cAAc,CAAA;AAC3C,iDAAiD;AACjD,OAAO,EAAC,KAAK,EAAC,MAAM,eAAe,CAAA;AACnC,OAAO,EAAC,QAAQ,EAAC,MAAM,aAAa,CAAA;AAEpC,MAAM,cAAc,GAAG,QAAQ,CAAA;AAC/B,MAAM,iBAAiB,GAAG,QAAQ,CAAA;AAClC,MAAM,iBAAiB,GAAG,OAAO,CAAA;AACjC,MAAM,cAAc,GAAG,OAAO,CAAA;AAC9B,MAAM,iBAAiB,GAAG,OAAO,CAAA;AAEjC;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,IAAc,EAAE,YAA2B;IACxE,MAAM,sBAAsB,EAAE,CAAA;IAC9B,MAAM,GAAG,GAAG;QACV,GAAG,OAAO,CAAC,GAAG;QACd,4BAA4B,EAAE,YAAY,EAAE,KAAK;QACjD,iBAAiB,EAAE,YAAY,EAAE,SAAS;KAC3C,CAAA;IAED,KAAK,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;QAChD,KAAK,EAAE,SAAS;QAChB,GAAG,EAAE,mBAAmB,EAAE;QAC1B,KAAK,EAAE,IAAI;QACX,GAAG;KACJ,CAAC,CAAA;AACJ,CAAC;AAaD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,EACtC,WAAW,EACX,IAAI,EACJ,MAAM,EACN,MAAM,GACmB;IACzB,MAAM,gCAAgC,CAAC,MAAM,CAAC,CAAA;IAE9C,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,EAAiB,EAAE;QACnE,wEAAwE;QACxE,qDAAqD;QACrD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAA;QAClD,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAA;QACvE,IAAI,SAAS,KAAK,CAAC;YAAE,OAAM;QAE3B,MAAM,YAAY,GAAG,IAAI,QAAQ,CAAC;YAChC,KAAK,CAAC,KAAK,EAAE,GAAG,IAAI;gBAClB,0EAA0E;gBAC1E,qJAAqJ;gBACrJ,0JAA0J;gBAC1J,IAAI,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE;oBAC9C,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAA;iBAC7B;qBAAM;oBACL,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAA;iBAC7B;YACH,CAAC;SACF,CAAC,CAAA;QACF,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE;YACxF,MAAM;YACN,MAAM,EAAE,YAAY;YACpB,GAAG,EAAE,mBAAmB,EAAE;SAC3B,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IACF,OAAO,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;AAC/B,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,gCAAgC,CAAC,MAAgB;IAC9D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,mBAAmB,EAAE,CAAC,CAAA;IAEvD,IAAI,CAAC,MAAM;QAAE,MAAM,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAA;IAC7D,MAAM,IAAI,GAAG,EAAE,CAAC,QAAQ,CACtB;QACE;YACE,KAAK,EAAE,+BAA+B;YACtC,IAAI,EAAE,KAAK,IAAI,EAAE;gBACf,MAAM,eAAe,EAAE,CAAA;gBACvB,MAAM,mCAAmC,EAAE,CAAA;gBAC3C,MAAM,uBAAuB,EAAE,CAAA;gBAC/B,MAAM,uBAAuB,EAAE,CAAA;YACjC,CAAC;SACF;KACF,EACD,EAAC,QAAQ,EAAE,QAAQ,EAAC,CACrB,CAAA;IACD,MAAM,IAAI,CAAC,GAAG,EAAE,CAAA;IAChB,IAAI,CAAC,MAAM;QAAE,MAAM,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAA;AAC5D,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,sBAAsB;IACnC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,mBAAmB,EAAE,CAAC,CAAA;IACvD,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAA;IAE9C,MAAM,IAAI,GAAG,EAAE,CAAC,QAAQ,CACtB;QACE;YACE,KAAK,EAAE,+BAA+B;YACtC,IAAI,EAAE,KAAK,IAAI,EAAE;gBACf,MAAM,eAAe,EAAE,CAAA;gBACvB,MAAM,gCAAgC,EAAE,CAAA;gBACxC,MAAM,uBAAuB,EAAE,CAAA;gBAC/B,MAAM,uBAAuB,EAAE,CAAA;YACjC,CAAC;SACF;KACF,EACD,EAAC,QAAQ,EAAC,CACX,CAAA;IACD,MAAM,IAAI,CAAC,GAAG,EAAE,CAAA;AAClB,CAAC;AAED,KAAK,UAAU,eAAe;IAC5B,MAAM,YAAY,EAAE,CAAA;IACpB,MAAM,gBAAgB,EAAE,CAAA;IACxB,MAAM,eAAe,EAAE,CAAA;AACzB,CAAC;AAED,KAAK,UAAU,YAAY;IACzB,IAAI,OAAO,CAAA;IACX,IAAI;QACF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,CAAA;QACzD,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;KACzB;IAAC,MAAM;QACN,MAAM,IAAI,KAAK,CACb,4BAA4B,EAC5B,qDACE,OAAO,CAAA,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,0DAA0D,CAAC,EAAE,CAAC,KACzF,EAAE,CACH,CAAA;KACF;IAED,MAAM,OAAO,GAAG,OAAO,EAAE,OAAO,CAAC,cAAc,CAAC,CAAA;IAChD,IAAI,OAAO,KAAK,CAAC,CAAC,IAAI,OAAO,KAAK,SAAS,EAAE;QAC3C,MAAM,IAAI,KAAK,CACb,gBAAgB,OAAO,CAAA,GAAG,KAAK,CAAC,MAAM,CAAC,OAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,mBAAmB,EAC/E,oCAAoC,OAAO,CAAA,GAAG,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC,KAAK,8BAChF,OAAO,CAAA,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,0DAA0D,CAAC,EAAE,CAAC,KACzF,EAAE,CACH,CAAA;KACF;AACH,CAAC;AAED,KAAK,UAAU,gBAAgB;IAC7B,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,CAAC,CAAA;IACxD,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;IAE9B,MAAM,OAAO,GAAG,OAAO,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAA;IACnD,IAAI,OAAO,KAAK,CAAC,CAAC,IAAI,OAAO,KAAK,SAAS,EAAE;QAC3C,MAAM,IAAI,KAAK,CACb,oBAAoB,OAAO,CAAA,GAAG,KAAK,CAAC,MAAM,CAAC,OAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,mBAAmB,EACnF,oDACE,OAAO,CAAA,GAAG,KAAK,CAAC,mBAAmB,CAAC,qBAAqB,CAAC,EAAE,CAAC,KAC/D,EAAE,CACH,CAAA;KACF;AACH,CAAC;AAED,KAAK,UAAU,eAAe;IAC5B,IAAI,OAAO,CAAA;IACX,IAAI;QACF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,CAAC,CAAA;QAC5D,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;KACzB;IAAC,MAAM;QACN,MAAM,IAAI,KAAK,CACb,mBAAmB,EACnB,iDACE,OAAO,CAAA,GAAG,KAAK,CAAC,mBAAmB,CAAC,qBAAqB,CAAC,EAAE,CAAC,KAC/D,EAAE,CACH,CAAA;KACF;IAED,MAAM,OAAO,GAAG,OAAO,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAA;IACnD,IAAI,OAAO,KAAK,CAAC,CAAC,IAAI,OAAO,KAAK,SAAS,EAAE;QAC3C,MAAM,IAAI,KAAK,CACb,mBAAmB,OAAO,CAAA,GAAG,KAAK,CAAC,MAAM,CAAC,OAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,mBAAmB,EAClF,mDACE,OAAO,CAAA,GAAG,KAAK,CAAC,mBAAmB,CAAC,qBAAqB,CAAC,EAAE,CAAC,KAC/D,EAAE,CACH,CAAA;KACF;AACH,CAAC;AAED,SAAS,gCAAgC;IACvC,OAAO,IAAI,CAAC,KAAK,CAAC,mBAAmB,EAAE,CAAC,CAAA;AAC1C,CAAC;AAED,SAAS,mCAAmC;IAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,mBAAmB,EAAE,CAAC,CAAA;AAC1C,CAAC;AAED,KAAK,UAAU,uBAAuB;IACpC,MAAM,OAAO,GAAG,IAAI,CAAC,mBAAmB,EAAE,EAAE,SAAS,CAAC,CAAA;IACtD,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,sDAAsD,cAAc,GAAG,CAAC,CAAA;AACpG,CAAC;AAED,KAAK,UAAU,uBAAuB;IACpC,MAAM,OAAO,GAAG,IAAI,CAAC,mBAAmB,EAAE,EAAE,SAAS,CAAC,CAAA;IACtD,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,sDAAsD,iBAAiB,GAAG,CAAC,CAAA;AACvG,CAAC;AAED,KAAK,UAAU,uBAAuB;IACpC,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,mBAAmB,EAAE,CAAC,EAAE,EAAC,GAAG,EAAE,mBAAmB,EAAE,EAAC,CAAC,CAAA;IACtH,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAC,GAAG,EAAE,mBAAmB,EAAE,EAAC,CAAC,CAAA;AACxE,CAAC;AAED,KAAK,UAAU,uBAAuB;IACpC,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,mBAAmB,EAAE,CAAC,EAAE,EAAC,GAAG,EAAE,mBAAmB,EAAE,EAAC,CAAC,CAAA;IACtH,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAC,GAAG,EAAE,mBAAmB,EAAE,EAAC,CAAC,CAAA;AACxE,CAAC;AAED,SAAS,mBAAmB;IAC1B,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,UAAU,EAAE,cAAc,CAAC,CAAA;AAC1F,CAAC;AAED,SAAS,mBAAmB;IAC1B,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,aAAa,EAAE,iBAAiB,CAAC,CAAA;AAChG,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,OAAO;IAC3B,MAAM,WAAW,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,sBAAsB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IACnF,OAAO,MAAM;SACV,aAAa,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC;SAC7B,IAAI,CAAC,WAAW,CAAC;SACjB,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAA;AAC3B,CAAC","sourcesContent":["import * as file from '../file.js'\nimport * as ui from '../ui.js'\nimport * as system from '../system.js'\nimport {Abort} from '../error.js'\nimport {glob, join} from '../path.js'\nimport constants from '../constants.js'\nimport {coerce} from '../semver.js'\nimport {AdminSession} from '../session.js'\nimport {content, token} from '../output.js'\n// eslint-disable-next-line no-restricted-imports\nimport {spawn} from 'child_process'\nimport {Writable} from 'node:stream'\n\nconst RubyCLIVersion = '2.16.0'\nconst ThemeCheckVersion = '1.10.3'\nconst MinBundlerVersion = '2.3.8'\nconst MinRubyVersion = '2.3.0'\nconst MinRubyGemVersion = '2.5.0'\n\n/**\n * Execute CLI 2.0 commands.\n * Installs a version of RubyCLI as a vendor dependency in a hidden folder in the system.\n * User must have a valid ruby+bundler environment to run any command.\n *\n * @param args {string[]} List of argumets to execute. (ex: ['theme', 'pull'])\n * @param adminSession {AdminSession} Contains token and store to pass to CLI 2.0, which will be set as environment variables\n */\nexport async function execCLI2(args: string[], adminSession?: AdminSession) {\n  await installCLIDependencies()\n  const env = {\n    ...process.env,\n    SHOPIFY_CLI_ADMIN_AUTH_TOKEN: adminSession?.token,\n    SHOPIFY_CLI_STORE: adminSession?.storeFqdn,\n  }\n\n  spawn('bundle', ['exec', 'shopify'].concat(args), {\n    stdio: 'inherit',\n    cwd: shopifyCLIDirectory(),\n    shell: true,\n    env,\n  })\n}\n\ninterface ExecThemeCheckCLIOptions {\n  /** A list of directories in which theme-check should run */\n  directories: string[]\n  /** Arguments to pass to the theme-check CLI */\n  args?: string[]\n  /** Writable to send standard output content through */\n  stdout: Writable\n  /** Writable to send standard error content through */\n  stderr: Writable\n}\n\n/**\n * A function that installs (if needed) and runs the theme-check CLI.\n * @param options {ExecThemeCheckCLIOptions} Options to customize the execution of theme-check.\n * @returns {Promise<void>} A promise that resolves or rejects depending on the result of the underlying theme-check process.\n */\nexport async function execThemeCheckCLI({\n  directories,\n  args,\n  stdout,\n  stderr,\n}: ExecThemeCheckCLIOptions): Promise<void[]> {\n  await installThemeCheckCLIDependencies(stdout)\n\n  const processes = directories.map(async (directory): Promise<void> => {\n    // Check that there are files aside from the extension TOML config file,\n    // otherwise theme-check will return a false failure.\n    const files = await glob(join(directory, '/**/*'))\n    const fileCount = files.filter((file) => !file.match(/\\.toml$/)).length\n    if (fileCount === 0) return\n\n    const customStderr = new Writable({\n      write(chunk, ...args) {\n        // For some reason, theme-check reports this initial status line to stderr\n        // See https://github.com/Shopify/theme-check/blob/1092737cfb58a73ca397ffb1371665dc55df2976/lib/theme_check/language_server/diagnostics_engine.rb#L31\n        // which leads to https://github.com/Shopify/theme-check/blob/1092737cfb58a73ca397ffb1371665dc55df2976/lib/theme_check/language_server/io_messenger.rb#L65\n        if (chunk.toString('ascii').match(/^Checking/)) {\n          stdout.write(chunk, ...args)\n        } else {\n          stderr.write(chunk, ...args)\n        }\n      },\n    })\n    await system.exec('bundle', ['exec', 'theme-check'].concat([directory, ...(args || [])]), {\n      stdout,\n      stderr: customStderr,\n      cwd: themeCheckDirectory(),\n    })\n  })\n  return Promise.all(processes)\n}\n\n/**\n * Validate Ruby Enviroment\n * Install Theme Check CLI and its dependencies\n * Shows a loading message if it's the first time installing dependencies\n * or if we are installing a new version of Theme Check CLI\n */\nasync function installThemeCheckCLIDependencies(stdout: Writable) {\n  const exists = await file.exists(themeCheckDirectory())\n\n  if (!exists) stdout.write('Installing theme dependencies...')\n  const list = ui.newListr(\n    [\n      {\n        title: 'Installing theme dependencies',\n        task: async () => {\n          await validateRubyEnv()\n          await createThemeCheckCLIWorkingDirectory()\n          await createThemeCheckGemfile()\n          await bundleInstallThemeCheck()\n        },\n      },\n    ],\n    {renderer: 'silent'},\n  )\n  await list.run()\n  if (!exists) stdout.write('Installed theme dependencies!')\n}\n\n/**\n * Validate Ruby Enviroment\n * Install RubyCLI and its dependencies\n * Shows a loading spinner if it's the first time installing dependencies\n * or if we are installing a new version of RubyCLI\n */\nasync function installCLIDependencies() {\n  const exists = await file.exists(shopifyCLIDirectory())\n  const renderer = exists ? 'silent' : 'default'\n\n  const list = ui.newListr(\n    [\n      {\n        title: 'Installing theme dependencies',\n        task: async () => {\n          await validateRubyEnv()\n          await createShopifyCLIWorkingDirectory()\n          await createShopifyCLIGemfile()\n          await bundleInstallShopifyCLI()\n        },\n      },\n    ],\n    {renderer},\n  )\n  await list.run()\n}\n\nasync function validateRubyEnv() {\n  await validateRuby()\n  await validateRubyGems()\n  await validateBundler()\n}\n\nasync function validateRuby() {\n  let version\n  try {\n    const stdout = await system.captureOutput('ruby', ['-v'])\n    version = coerce(stdout)\n  } catch {\n    throw new Abort(\n      'Ruby environment not found',\n      `Make sure you have Ruby installed on your system: ${\n        content`${token.link('', 'https://www.ruby-lang.org/en/documentation/installation/')}`.value\n      }`,\n    )\n  }\n\n  const isValid = version?.compare(MinRubyVersion)\n  if (isValid === -1 || isValid === undefined) {\n    throw new Abort(\n      `Ruby version ${content`${token.yellow(version!.raw)}`.value} is not supported`,\n      `Make sure you have at least Ruby ${content`${token.yellow(MinRubyVersion)}`.value} installed on your system: ${\n        content`${token.link('', 'https://www.ruby-lang.org/en/documentation/installation/')}`.value\n      }`,\n    )\n  }\n}\n\nasync function validateRubyGems() {\n  const stdout = await system.captureOutput('gem', ['-v'])\n  const version = coerce(stdout)\n\n  const isValid = version?.compare(MinRubyGemVersion)\n  if (isValid === -1 || isValid === undefined) {\n    throw new Abort(\n      `RubyGems version ${content`${token.yellow(version!.raw)}`.value} is not supported`,\n      `To update to the latest version of RubyGems, run ${\n        content`${token.genericShellCommand('gem update --system')}`.value\n      }`,\n    )\n  }\n}\n\nasync function validateBundler() {\n  let version\n  try {\n    const stdout = await system.captureOutput('bundler', ['-v'])\n    version = coerce(stdout)\n  } catch {\n    throw new Abort(\n      'Bundler not found',\n      `To install the latest version of Bundler, run ${\n        content`${token.genericShellCommand('gem install bundler')}`.value\n      }`,\n    )\n  }\n\n  const isValid = version?.compare(MinBundlerVersion)\n  if (isValid === -1 || isValid === undefined) {\n    throw new Abort(\n      `Bundler version ${content`${token.yellow(version!.raw)}`.value} is not supported`,\n      `To update to the latest version of Bundler, run ${\n        content`${token.genericShellCommand('gem install bundler')}`.value\n      }`,\n    )\n  }\n}\n\nfunction createShopifyCLIWorkingDirectory() {\n  return file.mkdir(shopifyCLIDirectory())\n}\n\nfunction createThemeCheckCLIWorkingDirectory() {\n  return file.mkdir(themeCheckDirectory())\n}\n\nasync function createShopifyCLIGemfile() {\n  const gemPath = join(shopifyCLIDirectory(), 'Gemfile')\n  await file.write(gemPath, `source 'https://rubygems.org'\\ngem 'shopify-cli', '${RubyCLIVersion}'`)\n}\n\nasync function createThemeCheckGemfile() {\n  const gemPath = join(themeCheckDirectory(), 'Gemfile')\n  await file.write(gemPath, `source 'https://rubygems.org'\\ngem 'theme-check', '${ThemeCheckVersion}'`)\n}\n\nasync function bundleInstallShopifyCLI() {\n  await system.exec('bundle', ['config', 'set', '--local', 'path', shopifyCLIDirectory()], {cwd: shopifyCLIDirectory()})\n  await system.exec('bundle', ['install'], {cwd: shopifyCLIDirectory()})\n}\n\nasync function bundleInstallThemeCheck() {\n  await system.exec('bundle', ['config', 'set', '--local', 'path', themeCheckDirectory()], {cwd: themeCheckDirectory()})\n  await system.exec('bundle', ['install'], {cwd: themeCheckDirectory()})\n}\n\nfunction shopifyCLIDirectory() {\n  return join(constants.paths.directories.cache.vendor.path(), 'ruby-cli', RubyCLIVersion)\n}\n\nfunction themeCheckDirectory() {\n  return join(constants.paths.directories.cache.vendor.path(), 'theme-check', ThemeCheckVersion)\n}\n\nexport async function version(): Promise<string | undefined> {\n  const parseOutput = (version: string) => version.match(/ruby (\\d+\\.\\d+\\.\\d+)/)?.[1]\n  return system\n    .captureOutput('ruby', ['-v'])\n    .then(parseOutput)\n    .catch(() => undefined)\n}\n"]}

package/dist/npm.d.ts

@@ -0,0 +1,27 @@
+interface JSON {
+    [key: string]: JSONValue;
+}
+declare type JSONValue = string | number | boolean | JSON | JSONValue[];
+export interface PackageJSON extends JSON {
+    name: string;
+    author: string;
+    dependencies: {
+        [key: string]: string;
+    };
+    devDependencies: {
+        [key: string]: string;
+    };
+    resolutions: {
+        [key: string]: string;
+    };
+    overrides: {
+        [key: string]: string;
+    };
+    scripts: {
+        [key: string]: string;
+    };
+}
+export declare function readPackageJSON(directory: string): Promise<PackageJSON>;
+export declare function writePackageJSON(directory: string, packageJSON: JSON): Promise<void>;
+export declare function updateAppData(packageJSON: JSON, name: string): Promise<void>;
+export {};