@shopify/cli-kit 3.31.1 → 3.32.1

package/dist/{os.js → public/node/os.js}

@@ -1,26 +1,14 @@
-import { debug, content } from './output.js';
+import { debug, content } from '../../output.js';
 import { execa } from 'execa';
-import { platform as processPlatform } from 'node:process';
-import { userInfo as osUserInfo, arch as osArch } from 'node:os';
-const getEnvironmentVariable = () => {
-    const { env } = process;
-    return env.SUDO_USER || env.C9_USER || env.LOGNAME || env.USER || env.LNAME || env.USERNAME;
-};
-const getUsernameFromOsUserInfo = () => {
-    try {
-        return osUserInfo().username;
-        // eslint-disable-next-line no-catch-all/no-catch-all
-    }
-    catch {
-        return null;
-    }
-};
-const cleanWindowsCommand = (value) => value.replace(/^.*\\/, '');
-const makeUsernameFromId = (userId) => `no-username-${userId}`;
+import { userInfo as osUserInfo } from 'os';
 // This code has been vendored from https://github.com/sindresorhus/username
 // because adding it as a transtive dependency causes conflicts with other
 // packages that haven't been yet migrated to the latest version.
-export const username = async (platform = processPlatform) => {
+/**
+ * @param platform - The platform to get the username for. Defaults to the current platform.
+ * @returns The username of the current user.
+ */
+export async function username(platform = process.platform) {
     debug(content `Obtaining user name...`);
     const environmentVariable = getEnvironmentVariable();
     if (environmentVariable) {
@@ -51,23 +39,39 @@ export const username = async (platform = processPlatform) => {
     catch {
         return null;
     }
-};
+}
 /**
  * Returns the platform and architecture.
  * @returns Returns the current platform and architecture.
  */
-export const platformAndArch = (platform = processPlatform) => {
-    let arch = osArch();
+export function platformAndArch(platform = process.platform, arch = process.arch) {
+    let archString = arch;
     if (arch === 'x64') {
-        arch = 'amd64';
+        archString = 'amd64';
     }
     if (arch === 'ia32') {
-        arch = '386';
+        archString = '386';
     }
-    let platformString = platform;
-    if (platform.match(/^win.+/)) {
-        platformString = 'windows';
+    const platformString = (platform.match(/^win.+/) ? 'windows' : platform);
+    return { platform: platformString, arch: archString };
+}
+function getEnvironmentVariable() {
+    const { env } = process;
+    return env.SUDO_USER || env.C9_USER || env.LOGNAME || env.USER || env.LNAME || env.USERNAME;
+}
+function getUsernameFromOsUserInfo() {
+    try {
+        return osUserInfo().username;
+        // eslint-disable-next-line no-catch-all/no-catch-all
+    }
+    catch {
+        return null;
     }
-    return { platform: platformString, arch };
-};
+}
+function cleanWindowsCommand(value) {
+    return value.replace(/^.*\\/, '');
+}
+function makeUsernameFromId(userId) {
+    return `no-username-${userId}`;
+}
 //# sourceMappingURL=os.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"os.js","sourceRoot":"","sources":["../../../src/public/node/os.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAE,OAAO,EAAC,MAAM,iBAAiB,CAAA;AAC9C,OAAO,EAAC,KAAK,EAAC,MAAM,OAAO,CAAA;AAC3B,OAAO,EAAC,QAAQ,IAAI,UAAU,EAAC,MAAM,IAAI,CAAA;AAEzC,4EAA4E;AAC5E,0EAA0E;AAC1E,iEAAiE;AACjE;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,WAAoC,OAAO,CAAC,QAAQ;IACjF,KAAK,CAAC,OAAO,CAAA,wBAAwB,CAAC,CAAA;IACtC,MAAM,mBAAmB,GAAG,sBAAsB,EAAE,CAAA;IACpD,IAAI,mBAAmB,EAAE;QACvB,OAAO,mBAAmB,CAAA;KAC3B;IAED,MAAM,gBAAgB,GAAG,yBAAyB,EAAE,CAAA;IACpD,IAAI,gBAAgB,EAAE;QACpB,OAAO,gBAAgB,CAAA;KACxB;IAED;;QAEI;IACJ,IAAI;QACF,IAAI,QAAQ,KAAK,OAAO,EAAE;YACxB,MAAM,EAAC,MAAM,EAAC,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,CAAA;YACtC,OAAO,mBAAmB,CAAC,MAAM,CAAC,CAAA;SACnC;QAED,MAAM,EAAC,MAAM,EAAE,MAAM,EAAC,GAAG,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC,CAAA;QAClD,IAAI;YACF,MAAM,EAAC,MAAM,EAAC,GAAG,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAA;YACnD,OAAO,MAAM,CAAA;YAEb,8DAA8D;SAC/D;QAAC,MAAM,GAAE;QACV,OAAO,kBAAkB,CAAC,MAAM,CAAC,CAAA;QACjC,qDAAqD;KACtD;IAAC,MAAM;QACN,OAAO,IAAI,CAAA;KACZ;AACH,CAAC;AAID;;;GAGG;AACH,MAAM,UAAU,eAAe,CAC7B,WAAoC,OAAO,CAAC,QAAQ,EACpD,OAA4B,OAAO,CAAC,IAAI;IAKxC,IAAI,UAAU,GAAG,IAAI,CAAA;IACrB,IAAI,IAAI,KAAK,KAAK,EAAE;QAClB,UAAU,GAAG,OAAO,CAAA;KACrB;IACD,IAAI,IAAI,KAAK,MAAM,EAAE;QACnB,UAAU,GAAG,KAAK,CAAA;KACnB;IACD,MAAM,cAAc,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAoB,CAAA;IAC3F,OAAO,EAAC,QAAQ,EAAE,cAAc,EAAE,IAAI,EAAE,UAAU,EAAC,CAAA;AACrD,CAAC;AAED,SAAS,sBAAsB;IAC7B,MAAM,EAAC,GAAG,EAAC,GAAG,OAAO,CAAA;IAErB,OAAO,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,QAAQ,CAAA;AAC7F,CAAC;AAED,SAAS,yBAAyB;IAChC,IAAI;QACF,OAAO,UAAU,EAAE,CAAC,QAAQ,CAAA;QAC5B,qDAAqD;KACtD;IAAC,MAAM;QACN,OAAO,IAAI,CAAA;KACZ;AACH,CAAC;AAED,SAAS,mBAAmB,CAAC,KAAa;IACxC,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;AACnC,CAAC;AAED,SAAS,kBAAkB,CAAC,MAAc;IACxC,OAAO,eAAe,MAAM,EAAE,CAAA;AAChC,CAAC","sourcesContent":["import {debug, content} from '../../output.js'\nimport {execa} from 'execa'\nimport {userInfo as osUserInfo} from 'os'\n\n// This code has been vendored from https://github.com/sindresorhus/username\n// because adding it as a transtive dependency causes conflicts with other\n// packages that haven't been yet migrated to the latest version.\n/**\n * @param platform - The platform to get the username for. Defaults to the current platform.\n * @returns The username of the current user.\n */\nexport async function username(platform: typeof process.platform = process.platform): Promise<string | null> {\n  debug(content`Obtaining user name...`)\n  const environmentVariable = getEnvironmentVariable()\n  if (environmentVariable) {\n    return environmentVariable\n  }\n\n  const userInfoUsername = getUsernameFromOsUserInfo()\n  if (userInfoUsername) {\n    return userInfoUsername\n  }\n\n  /**\n    First we try to get the ID of the user and then the actual username. We do this because in `docker run --user <uid>:<gid>` context, we don't have \"username\" available. Therefore, we have a fallback to `makeUsernameFromId` for such scenario. Applies also to the `sync()` method below.\n    */\n  try {\n    if (platform === 'win32') {\n      const {stdout} = await execa('whoami')\n      return cleanWindowsCommand(stdout)\n    }\n\n    const {stdout: userId} = await execa('id', ['-u'])\n    try {\n      const {stdout} = await execa('id', ['-un', userId])\n      return stdout\n\n      // eslint-disable-next-line no-catch-all/no-catch-all,no-empty\n    } catch {}\n    return makeUsernameFromId(userId)\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch {\n    return null\n  }\n}\n\ntype PlatformArch = Exclude<typeof process.arch, 'x64' | 'ia32'> | 'amd64' | '386'\ntype PlatformStrings = Exclude<typeof process.platform, 'win32'> | 'windows'\n/**\n * Returns the platform and architecture.\n * @returns Returns the current platform and architecture.\n */\nexport function platformAndArch(\n  platform: typeof process.platform = process.platform,\n  arch: typeof process.arch = process.arch,\n): {\n  platform: PlatformStrings\n  arch: PlatformArch\n} {\n  let archString = arch\n  if (arch === 'x64') {\n    archString = 'amd64'\n  }\n  if (arch === 'ia32') {\n    archString = '386'\n  }\n  const platformString = (platform.match(/^win.+/) ? 'windows' : platform) as PlatformStrings\n  return {platform: platformString, arch: archString}\n}\n\nfunction getEnvironmentVariable() {\n  const {env} = process\n\n  return env.SUDO_USER || env.C9_USER || env.LOGNAME || env.USER || env.LNAME || env.USERNAME\n}\n\nfunction getUsernameFromOsUserInfo(): string | null {\n  try {\n    return osUserInfo().username\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch {\n    return null\n  }\n}\n\nfunction cleanWindowsCommand(value: string) {\n  return value.replace(/^.*\\\\/, '')\n}\n\nfunction makeUsernameFromId(userId: string) {\n  return `no-username-${userId}`\n}\n"]}

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

@@ -1,4 +1,4 @@
-import { JsonMap } from '../../json.js';
+import { JsonMap } from '../../private/common/json.js';
 export declare const presetsFilename = "shopify.presets.toml";
 export interface Presets {
     [name: string]: JsonMap;

package/dist/public/node/presets.js

@@ -1,6 +1,6 @@
+import { decodeToml } from './toml.js';
 import { exists as fileExists, read as fileRead } from '../../file.js';
 import { findUp, join as pathJoin } from '../../path.js';
-import { decode as tomlDecode } from '../../toml.js';
 export const presetsFilename = 'shopify.presets.toml';
 export async function loadPresetsFromDirectory(dir, opts) {
     let presetsFilePath;
@@ -17,7 +17,7 @@ export async function loadPresetsFromDirectory(dir, opts) {
         }
     }
     if (presetsFilePath) {
-        return tomlDecode(await fileRead(presetsFilePath));
+        return decodeToml(await fileRead(presetsFilePath));
     }
     else {
         return {};

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

@@ -1 +1 @@
-{"version":3,"file":"presets.js","sourceRoot":"","sources":["../../../src/public/node/presets.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,MAAM,IAAI,UAAU,EAAE,IAAI,IAAI,QAAQ,EAAC,MAAM,eAAe,CAAA;AAEpE,OAAO,EAAC,MAAM,EAAE,IAAI,IAAI,QAAQ,EAAC,MAAM,eAAe,CAAA;AACtD,OAAO,EAAC,MAAM,IAAI,UAAU,EAAC,MAAM,eAAe,CAAA;AAElD,MAAM,CAAC,MAAM,eAAe,GAAG,sBAAsB,CAAA;AAKrD,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAAC,GAAW,EAAE,IAAwB;IAClF,IAAI,eAAmC,CAAA;IACvC,IAAI,IAAI,EAAE,MAAM,EAAE;QAChB,eAAe,GAAG,MAAM,MAAM,CAAC,eAAe,EAAE;YAC9C,GAAG,EAAE,GAAG;YACR,IAAI,EAAE,MAAM;SACb,CAAC,CAAA;KACH;SAAM;QACL,MAAM,sBAAsB,GAAG,QAAQ,CAAC,GAAG,EAAE,eAAe,CAAC,CAAA;QAC7D,IAAI,MAAM,UAAU,CAAC,sBAAsB,CAAC,EAAE;YAC5C,eAAe,GAAG,sBAAsB,CAAA;SACzC;KACF;IACD,IAAI,eAAe,EAAE;QACnB,OAAO,UAAU,CAAC,MAAM,QAAQ,CAAC,eAAe,CAAC,CAAY,CAAA;KAC9D;SAAM;QACL,OAAO,EAAa,CAAA;KACrB;AACH,CAAC","sourcesContent":["import {exists as fileExists, read as fileRead} from '../../file.js'\nimport {JsonMap} from '../../json.js'\nimport {findUp, join as pathJoin} from '../../path.js'\nimport {decode as tomlDecode} from '../../toml.js'\n\nexport const presetsFilename = 'shopify.presets.toml'\n\nexport interface Presets {\n  [name: string]: JsonMap\n}\nexport async function loadPresetsFromDirectory(dir: string, opts?: {findUp: boolean}): Promise<Presets> {\n  let presetsFilePath: string | undefined\n  if (opts?.findUp) {\n    presetsFilePath = await findUp(presetsFilename, {\n      cwd: dir,\n      type: 'file',\n    })\n  } else {\n    const allowedPresetsFilePath = pathJoin(dir, presetsFilename)\n    if (await fileExists(allowedPresetsFilePath)) {\n      presetsFilePath = allowedPresetsFilePath\n    }\n  }\n  if (presetsFilePath) {\n    return tomlDecode(await fileRead(presetsFilePath)) as Presets\n  } else {\n    return {} as Presets\n  }\n}\n"]}
+{"version":3,"file":"presets.js","sourceRoot":"","sources":["../../../src/public/node/presets.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,WAAW,CAAA;AACpC,OAAO,EAAC,MAAM,IAAI,UAAU,EAAE,IAAI,IAAI,QAAQ,EAAC,MAAM,eAAe,CAAA;AAEpE,OAAO,EAAC,MAAM,EAAE,IAAI,IAAI,QAAQ,EAAC,MAAM,eAAe,CAAA;AAEtD,MAAM,CAAC,MAAM,eAAe,GAAG,sBAAsB,CAAA;AAKrD,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAAC,GAAW,EAAE,IAAwB;IAClF,IAAI,eAAmC,CAAA;IACvC,IAAI,IAAI,EAAE,MAAM,EAAE;QAChB,eAAe,GAAG,MAAM,MAAM,CAAC,eAAe,EAAE;YAC9C,GAAG,EAAE,GAAG;YACR,IAAI,EAAE,MAAM;SACb,CAAC,CAAA;KACH;SAAM;QACL,MAAM,sBAAsB,GAAG,QAAQ,CAAC,GAAG,EAAE,eAAe,CAAC,CAAA;QAC7D,IAAI,MAAM,UAAU,CAAC,sBAAsB,CAAC,EAAE;YAC5C,eAAe,GAAG,sBAAsB,CAAA;SACzC;KACF;IACD,IAAI,eAAe,EAAE;QACnB,OAAO,UAAU,CAAC,MAAM,QAAQ,CAAC,eAAe,CAAC,CAAY,CAAA;KAC9D;SAAM;QACL,OAAO,EAAa,CAAA;KACrB;AACH,CAAC","sourcesContent":["import {decodeToml} from './toml.js'\nimport {exists as fileExists, read as fileRead} from '../../file.js'\nimport {JsonMap} from '../../private/common/json.js'\nimport {findUp, join as pathJoin} from '../../path.js'\n\nexport const presetsFilename = 'shopify.presets.toml'\n\nexport interface Presets {\n  [name: string]: JsonMap\n}\nexport async function loadPresetsFromDirectory(dir: string, opts?: {findUp: boolean}): Promise<Presets> {\n  let presetsFilePath: string | undefined\n  if (opts?.findUp) {\n    presetsFilePath = await findUp(presetsFilename, {\n      cwd: dir,\n      type: 'file',\n    })\n  } else {\n    const allowedPresetsFilePath = pathJoin(dir, presetsFilename)\n    if (await fileExists(allowedPresetsFilePath)) {\n      presetsFilePath = allowedPresetsFilePath\n    }\n  }\n  if (presetsFilePath) {\n    return decodeToml(await fileRead(presetsFilePath)) as Presets\n  } else {\n    return {} as Presets\n  }\n}\n"]}

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

@@ -1,7 +1,7 @@
 /// <reference types="node" />
+import { AbortSignal } from './abort.js';
 import { AdminSession } from '../../session.js';
-import { AbortSignal } from 'abort-controller';
-import { Writable } from 'node:stream';
+import { Writable } from 'stream';
 interface ExecCLI2Options {
     adminSession?: AdminSession;
     storefrontToken?: string;
@@ -14,25 +14,29 @@ interface ExecCLI2Options {
  * 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 - List of argumets to execute. (ex: ['theme', 'pull'])
+ * @param args - List of argumets to execute. (ex: ['theme', 'pull']).
  * @param options - Options to customize the execution of cli2.
  */
-export declare function execCLI2(args: string[], { adminSession, storefrontToken, token, directory, signal }?: ExecCLI2Options): Promise<void>;
+export declare function execCLI2(args: string[], options?: ExecCLI2Options): Promise<void>;
 interface ExecThemeCheckCLIOptions {
-    /** A list of directories in which theme-check should run */
+    /** A list of directories in which theme-check should run. */
     directories: string[];
-    /** Arguments to pass to the theme-check CLI */
+    /** Arguments to pass to the theme-check CLI. */
     args?: string[];
-    /** Writable to send standard output content through */
+    /** Writable to send standard output content through. */
     stdout: Writable;
-    /** Writable to send standard error content through */
+    /** Writable to send standard error content through. */
     stderr: Writable;
 }
 /**
  * A function that installs (if needed) and runs the theme-check CLI.
+ *
  * @param options - Options to customize the execution of theme-check.
  * @returns 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 execThemeCheckCLI(options: ExecThemeCheckCLIOptions): Promise<void[]>;
+/**
+ * It returns the Ruby version present in the envirronment.
+ */
 export declare function version(): Promise<string | undefined>;
 export {};

package/dist/public/node/ruby.js

@@ -1,4 +1,5 @@
 import { coerceSemverVersion } from './semver.js';
+import { platformAndArch } from './os.js';
 import * as file from '../../file.js';
 import * as ui from '../../ui.js';
 import * as system from '../../system.js';
@@ -6,10 +7,9 @@ import { Abort, AbortSilent } from '../../error.js';
 import { glob, join } from '../../path.js';
 import constants from '../../constants.js';
 import { content, token } from '../../output.js';
-import { platformAndArch } from '../../os.js';
-import { Writable } from 'node:stream';
-const RubyCLIVersion = '2.33.0';
-const ThemeCheckVersion = '1.12.1';
+import { Writable } from 'stream';
+const RubyCLIVersion = '2.33.1';
+const ThemeCheckVersion = '1.14.0';
 const MinBundlerVersion = '2.3.8';
 const MinRubyVersion = '2.7.5';
 /**
@@ -17,17 +17,17 @@ const MinRubyVersion = '2.7.5';
  * 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 - List of argumets to execute. (ex: ['theme', 'pull'])
+ * @param args - List of argumets to execute. (ex: ['theme', 'pull']).
  * @param options - Options to customize the execution of cli2.
  */
-export async function execCLI2(args, { adminSession, storefrontToken, token, directory, signal } = {}) {
+export async function execCLI2(args, options = {}) {
     await installCLIDependencies();
     const env = {
         ...process.env,
-        SHOPIFY_CLI_STOREFRONT_RENDERER_AUTH_TOKEN: storefrontToken,
-        SHOPIFY_CLI_ADMIN_AUTH_TOKEN: adminSession?.token,
-        SHOPIFY_SHOP: adminSession?.storeFqdn,
-        SHOPIFY_CLI_AUTH_TOKEN: token,
+        SHOPIFY_CLI_STOREFRONT_RENDERER_AUTH_TOKEN: options.storefrontToken,
+        SHOPIFY_CLI_ADMIN_AUTH_TOKEN: options.adminSession?.token,
+        SHOPIFY_SHOP: options.adminSession?.storeFqdn,
+        SHOPIFY_CLI_AUTH_TOKEN: options.token,
         SHOPIFY_CLI_RUN_AS_SUBPROCESS: 'true',
         // Bundler uses this Gemfile to understand which gems are available in the
         // environment. We use this to specify our own Gemfile for CLI2, which exists
@@ -37,9 +37,9 @@ export async function execCLI2(args, { adminSession, storefrontToken, token, dir
     try {
         await system.exec(bundleExecutable(), ['exec', 'shopify'].concat(args), {
             stdio: 'inherit',
-            cwd: directory ?? process.cwd(),
+            cwd: options.directory ?? process.cwd(),
             env,
-            signal,
+            signal: options.signal,
         });
     }
     catch (error) {
@@ -49,12 +49,13 @@ export async function execCLI2(args, { adminSession, storefrontToken, token, dir
 }
 /**
  * A function that installs (if needed) and runs the theme-check CLI.
+ *
  * @param options - Options to customize the execution of theme-check.
  * @returns 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) => {
+export async function execThemeCheckCLI(options) {
+    await installThemeCheckCLIDependencies(options.stdout);
+    const processes = options.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, '/**/*'));
@@ -67,15 +68,15 @@ export async function execThemeCheckCLI({ directories, args, stdout, 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);
+                    options.stdout.write(chunk, ...args);
                 }
                 else {
-                    stderr.write(chunk, ...args);
+                    options.stderr.write(chunk, ...args);
                 }
             },
         });
-        await system.exec(bundleExecutable(), ['exec', 'theme-check'].concat([directory, ...(args || [])]), {
-            stdout,
+        await system.exec(bundleExecutable(), ['exec', 'theme-check'].concat([directory, ...(options.args || [])]), {
+            stdout: options.stdout,
             stderr: customStderr,
             cwd: themeCheckDirectory(),
         });
@@ -86,7 +87,9 @@ export async function execThemeCheckCLI({ directories, args, stdout, stderr, })
  * 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
+ * or if we are installing a new version of Theme Check CLI.
+ *
+ * @param stdout - The Writable stream on which to write the standard output.
  */
 async function installThemeCheckCLIDependencies(stdout) {
     const exists = await file.exists(themeCheckDirectory());
@@ -111,7 +114,7 @@ async function installThemeCheckCLIDependencies(stdout) {
  * 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
+ * or if we are installing a new version of RubyCLI.
  */
 async function installCLIDependencies() {
     const exists = await file.exists(shopifyCLIDirectory());
@@ -135,10 +138,16 @@ async function installCLIDependencies() {
     ], { renderer });
     await list.run();
 }
+/**
+ * A function that validates if the environment in which the CLI is running is set up with Ruby and Bundler.
+ */
 async function validateRubyEnv() {
     await validateRuby();
     await validateBundler();
 }
+/**
+ * A function that validates if the environment in which the CLI is running is set up with Ruby.
+ */
 async function validateRuby() {
     let version;
     try {
@@ -153,6 +162,9 @@ async function validateRuby() {
         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('Documentation.', 'https://www.ruby-lang.org/en/documentation/installation/')}`.value}`);
     }
 }
+/**
+ * A function that validates if the environment in which the CLI is running is set up with Bundler.
+ */
 async function validateBundler() {
     let version;
     try {
@@ -167,12 +179,21 @@ async function validateBundler() {
         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(`${gemExecutable()} install bundler`)}`.value}`);
     }
 }
-function createShopifyCLIWorkingDirectory() {
+/**
+ * It creates the directory where the Ruby CLI will be downloaded along its dependencies.
+ */
+async function createShopifyCLIWorkingDirectory() {
     return file.mkdir(shopifyCLIDirectory());
 }
-function createThemeCheckCLIWorkingDirectory() {
+/**
+ * It creates the directory where the theme-check CLI will be downloaded along its dependencies.
+ */
+async function createThemeCheckCLIWorkingDirectory() {
     return file.mkdir(themeCheckDirectory());
 }
+/**
+ * It creates the Gemfile to install The Ruby CLI and the dependencies.
+ */
 async function createShopifyCLIGemfile() {
     const gemPath = join(shopifyCLIDirectory(), 'Gemfile');
     const gemFileContent = ["source 'https://rubygems.org'", `gem 'shopify-cli', '${RubyCLIVersion}'`];
@@ -183,32 +204,57 @@ async function createShopifyCLIGemfile() {
     }
     await file.write(gemPath, gemFileContent.join('\n'));
 }
+/**
+ * It creates the Gemfile to install theme-check and its dependencies.
+ */
 async function createThemeCheckGemfile() {
     const gemPath = join(themeCheckDirectory(), 'Gemfile');
     await file.write(gemPath, `source 'https://rubygems.org'\ngem 'theme-check', '${ThemeCheckVersion}'`);
 }
+/**
+ * It runs bundle install for the dev-managed copy of the Ruby CLI.
+ */
 async function bundleInstallLocalShopifyCLI() {
     await system.exec(bundleExecutable(), ['install'], { cwd: shopifyCLIDirectory() });
 }
+/**
+ * It runs bundle install for the CLI-managed copy of the Ruby CLI.
+ */
 async function bundleInstallShopifyCLI() {
     await system.exec(bundleExecutable(), ['config', 'set', '--local', 'path', shopifyCLIDirectory()], {
         cwd: shopifyCLIDirectory(),
     });
     await system.exec(bundleExecutable(), ['install'], { cwd: shopifyCLIDirectory() });
 }
+/**
+ * It runs bundle install for the CLI-managed copy of theme-check.
+ */
 async function bundleInstallThemeCheck() {
     await system.exec(bundleExecutable(), ['config', 'set', '--local', 'path', themeCheckDirectory()], {
         cwd: themeCheckDirectory(),
     });
     await system.exec(bundleExecutable(), ['install'], { cwd: themeCheckDirectory() });
 }
+/**
+ * It returns the directory where the Ruby CLI is located.
+ *
+ * @returns The absolute path to the directory.
+ */
 function shopifyCLIDirectory() {
     return (process.env.SHOPIFY_CLI_2_0_DIRECTORY ??
         join(constants.paths.directories.cache.vendor.path(), 'ruby-cli', RubyCLIVersion));
 }
+/**
+ * It returns the path to the directory containing the theme-check CLI.
+ *
+ * @returns The absolute path to the theme-check directory.
+ */
 function themeCheckDirectory() {
     return join(constants.paths.directories.cache.vendor.path(), 'theme-check', ThemeCheckVersion);
 }
+/**
+ * It returns the Ruby version present in the envirronment.
+ */
 export async function version() {
     const parseOutput = (version) => version.match(/ruby (\d+\.\d+\.\d+)/)?.[1];
     return system
@@ -216,17 +262,39 @@ export async function version() {
         .then(parseOutput)
         .catch(() => undefined);
 }
+/**
+ * It returns the Ruby binary path set through the environment variable SHOPIFY_RUBY_BINDIR.
+ * This is useful when the CLI is managed by an installer like a Homebrew where we need to
+ * point the CLI to the Ruby installation managed by Homebrew.
+ *
+ * @returns The value of the environment variable.
+ */
 function getRubyBinDir() {
     return process.env.SHOPIFY_RUBY_BINDIR;
 }
+/**
+ * It returns the path to the "ruby" executable.
+ *
+ * @returns The path to the executable.
+ */
 function rubyExecutable() {
     const rubyBinDir = getRubyBinDir();
     return rubyBinDir ? join(rubyBinDir, 'ruby') : 'ruby';
 }
+/**
+ * It returns the path to the "bundle" executable.
+ *
+ * @returns The path to the executable.
+ */
 function bundleExecutable() {
     const rubyBinDir = getRubyBinDir();
     return rubyBinDir ? join(rubyBinDir, 'bundle') : 'bundle';
 }
+/**
+ * It returns the path to the "gem"" executable.
+ *
+ * @returns The path to the executable.
+ */
 function gemExecutable() {
     const rubyBinDir = getRubyBinDir();
     return rubyBinDir ? join(rubyBinDir, 'gem') : 'gem';

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

@@ -1 +1 @@
-{"version":3,"file":"ruby.js","sourceRoot":"","sources":["../../../src/public/node/ruby.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,mBAAmB,EAAC,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,IAAI,MAAM,eAAe,CAAA;AACrC,OAAO,KAAK,EAAE,MAAM,aAAa,CAAA;AACjC,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,EAAC,KAAK,EAAE,WAAW,EAAC,MAAM,gBAAgB,CAAA;AACjD,OAAO,EAAC,IAAI,EAAE,IAAI,EAAC,MAAM,eAAe,CAAA;AACxC,OAAO,SAAS,MAAM,oBAAoB,CAAA;AAE1C,OAAO,EAAC,OAAO,EAAE,KAAK,EAAC,MAAM,iBAAiB,CAAA;AAC9C,OAAO,EAAC,eAAe,EAAC,MAAM,aAAa,CAAA;AAE3C,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;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,IAAc,EACd,EAAC,YAAY,EAAE,eAAe,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,KAAqB,EAAE;IAE/E,MAAM,sBAAsB,EAAE,CAAA;IAC9B,MAAM,GAAG,GAAG;QACV,GAAG,OAAO,CAAC,GAAG;QACd,0CAA0C,EAAE,eAAe;QAC3D,4BAA4B,EAAE,YAAY,EAAE,KAAK;QACjD,YAAY,EAAE,YAAY,EAAE,SAAS;QACrC,sBAAsB,EAAE,KAAK;QAC7B,6BAA6B,EAAE,MAAM;QACrC,0EAA0E;QAC1E,6EAA6E;QAC7E,wCAAwC;QACxC,cAAc,EAAE,IAAI,CAAC,mBAAmB,EAAE,EAAE,SAAS,CAAC;KACvD,CAAA;IAED,IAAI;QACF,MAAM,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;YACtE,KAAK,EAAE,SAAS;YAChB,GAAG,EAAE,SAAS,IAAI,OAAO,CAAC,GAAG,EAAE;YAC/B,GAAG;YACH,MAAM;SACP,CAAC,CAAA;KACH;IAAC,OAAO,KAAK,EAAE;QACd,iFAAiF;QACjF,MAAM,IAAI,WAAW,EAAE,CAAA;KACxB;AACH,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,gBAAgB,EAAE,EAAE,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE;YAClG,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,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAA;gBACrE,MAAM,eAAe,EAAE,CAAA;gBACvB,IAAI,cAAc,EAAE;oBAClB,MAAM,4BAA4B,EAAE,CAAA;iBACrC;qBAAM;oBACL,MAAM,gCAAgC,EAAE,CAAA;oBACxC,MAAM,uBAAuB,EAAE,CAAA;oBAC/B,MAAM,uBAAuB,EAAE,CAAA;iBAChC;YACH,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,eAAe,EAAE,CAAA;AACzB,CAAC;AAED,KAAK,UAAU,YAAY;IACzB,IAAI,OAAO,CAAA;IACX,IAAI;QACF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,cAAc,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAA;QACnE,OAAO,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAA;KACtC;IAAC,MAAM;QACN,MAAM,IAAI,KAAK,CACb,4BAA4B,EAC5B,qDACE,OAAO,CAAA,GAAG,KAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,0DAA0D,CAAC,EAAE,CAAC,KACvG,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,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,mBAAmB,EAC9E,oCAAoC,OAAO,CAAA,GAAG,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC,KAAK,8BAChF,OAAO,CAAA,GAAG,KAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,0DAA0D,CAAC,EAAE,CAAC,KACvG,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,gBAAgB,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAA;QACrE,OAAO,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAA;KACtC;IAAC,MAAM;QACN,MAAM,IAAI,KAAK,CACb,mBAAmB,EACnB,iDACE,OAAO,CAAA,GAAG,KAAK,CAAC,mBAAmB,CAAC,GAAG,aAAa,EAAE,kBAAkB,CAAC,EAAE,CAAC,KAC9E,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,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,mBAAmB,EACjF,mDACE,OAAO,CAAA,GAAG,KAAK,CAAC,mBAAmB,CAAC,GAAG,aAAa,EAAE,kBAAkB,CAAC,EAAE,CAAC,KAC9E,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,cAAc,GAAG,CAAC,+BAA+B,EAAE,uBAAuB,cAAc,GAAG,CAAC,CAAA;IAClG,MAAM,EAAC,QAAQ,EAAC,GAAG,eAAe,EAAE,CAAA;IACpC,IAAI,QAAQ,KAAK,SAAS,EAAE;QAC1B,+EAA+E;QAC/E,cAAc,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAA;KAC7C;IACD,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;AACtD,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,4BAA4B;IACzC,MAAM,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,EAAC,GAAG,EAAE,mBAAmB,EAAE,EAAC,CAAC,CAAA;AAClF,CAAC;AAED,KAAK,UAAU,uBAAuB;IACpC,MAAM,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,mBAAmB,EAAE,CAAC,EAAE;QACjG,GAAG,EAAE,mBAAmB,EAAE;KAC3B,CAAC,CAAA;IACF,MAAM,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,EAAC,GAAG,EAAE,mBAAmB,EAAE,EAAC,CAAC,CAAA;AAClF,CAAC;AAED,KAAK,UAAU,uBAAuB;IACpC,MAAM,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,mBAAmB,EAAE,CAAC,EAAE;QACjG,GAAG,EAAE,mBAAmB,EAAE;KAC3B,CAAC,CAAA;IACF,MAAM,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,EAAC,GAAG,EAAE,mBAAmB,EAAE,EAAC,CAAC,CAAA;AAClF,CAAC;AAED,SAAS,mBAAmB;IAC1B,OAAO,CACL,OAAO,CAAC,GAAG,CAAC,yBAAyB;QACrC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,UAAU,EAAE,cAAc,CAAC,CAClF,CAAA;AACH,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,cAAc,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;SACvC,IAAI,CAAC,WAAW,CAAC;SACjB,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAA;AAC3B,CAAC;AAED,SAAS,aAAa;IACpB,OAAO,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAA;AACxC,CAAC;AAED,SAAS,cAAc;IACrB,MAAM,UAAU,GAAG,aAAa,EAAE,CAAA;IAClC,OAAO,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;AACvD,CAAC;AAED,SAAS,gBAAgB;IACvB,MAAM,UAAU,GAAG,aAAa,EAAE,CAAA;IAClC,OAAO,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAA;AAC3D,CAAC;AAED,SAAS,aAAa;IACpB,MAAM,UAAU,GAAG,aAAa,EAAE,CAAA;IAClC,OAAO,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;AACrD,CAAC","sourcesContent":["import {coerceSemverVersion} from './semver.js'\nimport * as file from '../../file.js'\nimport * as ui from '../../ui.js'\nimport * as system from '../../system.js'\nimport {Abort, AbortSilent} from '../../error.js'\nimport {glob, join} from '../../path.js'\nimport constants from '../../constants.js'\nimport {AdminSession} from '../../session.js'\nimport {content, token} from '../../output.js'\nimport {platformAndArch} from '../../os.js'\nimport {AbortSignal} from 'abort-controller'\nimport {Writable} from 'node:stream'\n\nconst RubyCLIVersion = '2.33.0'\nconst ThemeCheckVersion = '1.12.1'\nconst MinBundlerVersion = '2.3.8'\nconst MinRubyVersion = '2.7.5'\n\ninterface ExecCLI2Options {\n  // Contains token and store to pass to CLI 2.0, which will be set as environment variables\n  adminSession?: AdminSession\n  // Contains token for storefront access to pass to CLI 2.0 as environment variable\n  storefrontToken?: string\n  // Contains token for partners access to pass to CLI 2.0 as environment variable\n  token?: string\n  // Directory in which to execute the command. Otherwise the current directory will be used.\n  directory?: string\n\n  signal?: AbortSignal\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 - List of argumets to execute. (ex: ['theme', 'pull'])\n * @param options - Options to customize the execution of cli2.\n */\nexport async function execCLI2(\n  args: string[],\n  {adminSession, storefrontToken, token, directory, signal}: ExecCLI2Options = {},\n): Promise<void> {\n  await installCLIDependencies()\n  const env = {\n    ...process.env,\n    SHOPIFY_CLI_STOREFRONT_RENDERER_AUTH_TOKEN: storefrontToken,\n    SHOPIFY_CLI_ADMIN_AUTH_TOKEN: adminSession?.token,\n    SHOPIFY_SHOP: adminSession?.storeFqdn,\n    SHOPIFY_CLI_AUTH_TOKEN: token,\n    SHOPIFY_CLI_RUN_AS_SUBPROCESS: 'true',\n    // Bundler uses this Gemfile to understand which gems are available in the\n    // environment. We use this to specify our own Gemfile for CLI2, which exists\n    // outside the user's project directory.\n    BUNDLE_GEMFILE: join(shopifyCLIDirectory(), 'Gemfile'),\n  }\n\n  try {\n    await system.exec(bundleExecutable(), ['exec', 'shopify'].concat(args), {\n      stdio: 'inherit',\n      cwd: directory ?? process.cwd(),\n      env,\n      signal,\n    })\n  } catch (error) {\n    // CLI2 will show it's own errors, we don't need to show an additional CLI3 error\n    throw new AbortSilent()\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 - Options to customize the execution of theme-check.\n * @returns 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(bundleExecutable(), ['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          const usingLocalCLI2 = Boolean(process.env.SHOPIFY_CLI_2_0_DIRECTORY)\n          await validateRubyEnv()\n          if (usingLocalCLI2) {\n            await bundleInstallLocalShopifyCLI()\n          } else {\n            await createShopifyCLIWorkingDirectory()\n            await createShopifyCLIGemfile()\n            await bundleInstallShopifyCLI()\n          }\n        },\n      },\n    ],\n    {renderer},\n  )\n  await list.run()\n}\n\nasync function validateRubyEnv() {\n  await validateRuby()\n  await validateBundler()\n}\n\nasync function validateRuby() {\n  let version\n  try {\n    const stdout = await system.captureOutput(rubyExecutable(), ['-v'])\n    version = coerceSemverVersion(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('Documentation.', '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('Documentation.', 'https://www.ruby-lang.org/en/documentation/installation/')}`.value\n      }`,\n    )\n  }\n}\n\nasync function validateBundler() {\n  let version\n  try {\n    const stdout = await system.captureOutput(bundleExecutable(), ['-v'])\n    version = coerceSemverVersion(stdout)\n  } catch {\n    throw new Abort(\n      'Bundler not found',\n      `To install the latest version of Bundler, run ${\n        content`${token.genericShellCommand(`${gemExecutable()} 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(`${gemExecutable()} 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  const gemFileContent = [\"source 'https://rubygems.org'\", `gem 'shopify-cli', '${RubyCLIVersion}'`]\n  const {platform} = platformAndArch()\n  if (platform === 'windows') {\n    // 'wdm' is required by 'listen', see https://github.com/Shopify/cli/issues/780\n    gemFileContent.push(\"gem 'wdm', '>= 0.1.0'\")\n  }\n  await file.write(gemPath, gemFileContent.join('\\n'))\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 bundleInstallLocalShopifyCLI() {\n  await system.exec(bundleExecutable(), ['install'], {cwd: shopifyCLIDirectory()})\n}\n\nasync function bundleInstallShopifyCLI() {\n  await system.exec(bundleExecutable(), ['config', 'set', '--local', 'path', shopifyCLIDirectory()], {\n    cwd: shopifyCLIDirectory(),\n  })\n  await system.exec(bundleExecutable(), ['install'], {cwd: shopifyCLIDirectory()})\n}\n\nasync function bundleInstallThemeCheck() {\n  await system.exec(bundleExecutable(), ['config', 'set', '--local', 'path', themeCheckDirectory()], {\n    cwd: themeCheckDirectory(),\n  })\n  await system.exec(bundleExecutable(), ['install'], {cwd: themeCheckDirectory()})\n}\n\nfunction shopifyCLIDirectory() {\n  return (\n    process.env.SHOPIFY_CLI_2_0_DIRECTORY ??\n    join(constants.paths.directories.cache.vendor.path(), 'ruby-cli', RubyCLIVersion)\n  )\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(rubyExecutable(), ['-v'])\n    .then(parseOutput)\n    .catch(() => undefined)\n}\n\nfunction getRubyBinDir(): string | undefined {\n  return process.env.SHOPIFY_RUBY_BINDIR\n}\n\nfunction rubyExecutable(): string {\n  const rubyBinDir = getRubyBinDir()\n  return rubyBinDir ? join(rubyBinDir, 'ruby') : 'ruby'\n}\n\nfunction bundleExecutable(): string {\n  const rubyBinDir = getRubyBinDir()\n  return rubyBinDir ? join(rubyBinDir, 'bundle') : 'bundle'\n}\n\nfunction gemExecutable(): string {\n  const rubyBinDir = getRubyBinDir()\n  return rubyBinDir ? join(rubyBinDir, 'gem') : 'gem'\n}\n"]}
+{"version":3,"file":"ruby.js","sourceRoot":"","sources":["../../../src/public/node/ruby.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,mBAAmB,EAAC,MAAM,aAAa,CAAA;AAE/C,OAAO,EAAC,eAAe,EAAC,MAAM,SAAS,CAAA;AACvC,OAAO,KAAK,IAAI,MAAM,eAAe,CAAA;AACrC,OAAO,KAAK,EAAE,MAAM,aAAa,CAAA;AACjC,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,EAAC,KAAK,EAAE,WAAW,EAAC,MAAM,gBAAgB,CAAA;AACjD,OAAO,EAAC,IAAI,EAAE,IAAI,EAAC,MAAM,eAAe,CAAA;AACxC,OAAO,SAAS,MAAM,oBAAoB,CAAA;AAE1C,OAAO,EAAC,OAAO,EAAE,KAAK,EAAC,MAAM,iBAAiB,CAAA;AAC9C,OAAO,EAAC,QAAQ,EAAC,MAAM,QAAQ,CAAA;AAE/B,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;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,IAAc,EAAE,UAA2B,EAAE;IAC1E,MAAM,sBAAsB,EAAE,CAAA;IAC9B,MAAM,GAAG,GAAsB;QAC7B,GAAG,OAAO,CAAC,GAAG;QACd,0CAA0C,EAAE,OAAO,CAAC,eAAe;QACnE,4BAA4B,EAAE,OAAO,CAAC,YAAY,EAAE,KAAK;QACzD,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE,SAAS;QAC7C,sBAAsB,EAAE,OAAO,CAAC,KAAK;QACrC,6BAA6B,EAAE,MAAM;QACrC,0EAA0E;QAC1E,6EAA6E;QAC7E,wCAAwC;QACxC,cAAc,EAAE,IAAI,CAAC,mBAAmB,EAAE,EAAE,SAAS,CAAC;KACvD,CAAA;IAED,IAAI;QACF,MAAM,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;YACtE,KAAK,EAAE,SAAS;YAChB,GAAG,EAAE,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,GAAG,EAAE;YACvC,GAAG;YACH,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAA;KACH;IAAC,OAAO,KAAK,EAAE;QACd,iFAAiF;QACjF,MAAM,IAAI,WAAW,EAAE,CAAA;KACxB;AACH,CAAC;AAaD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,OAAiC;IACvE,MAAM,gCAAgC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IAEtD,MAAM,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,EAAiB,EAAE;QAC3E,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,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAA;iBACrC;qBAAM;oBACL,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAA;iBACrC;YACH,CAAC;SACF,CAAC,CAAA;QACF,MAAM,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE;YAC1G,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,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;;;;;;;GAOG;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,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAA;gBACrE,MAAM,eAAe,EAAE,CAAA;gBACvB,IAAI,cAAc,EAAE;oBAClB,MAAM,4BAA4B,EAAE,CAAA;iBACrC;qBAAM;oBACL,MAAM,gCAAgC,EAAE,CAAA;oBACxC,MAAM,uBAAuB,EAAE,CAAA;oBAC/B,MAAM,uBAAuB,EAAE,CAAA;iBAChC;YACH,CAAC;SACF;KACF,EACD,EAAC,QAAQ,EAAC,CACX,CAAA;IACD,MAAM,IAAI,CAAC,GAAG,EAAE,CAAA;AAClB,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,eAAe;IAC5B,MAAM,YAAY,EAAE,CAAA;IACpB,MAAM,eAAe,EAAE,CAAA;AACzB,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,YAAY;IACzB,IAAI,OAAO,CAAA;IACX,IAAI;QACF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,cAAc,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAA;QACnE,OAAO,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAA;KACtC;IAAC,MAAM;QACN,MAAM,IAAI,KAAK,CACb,4BAA4B,EAC5B,qDACE,OAAO,CAAA,GAAG,KAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,0DAA0D,CAAC,EAAE,CAAC,KACvG,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,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,mBAAmB,EAC9E,oCAAoC,OAAO,CAAA,GAAG,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC,KAAK,8BAChF,OAAO,CAAA,GAAG,KAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,0DAA0D,CAAC,EAAE,CAAC,KACvG,EAAE,CACH,CAAA;KACF;AACH,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,eAAe;IAC5B,IAAI,OAAO,CAAA;IACX,IAAI;QACF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,gBAAgB,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAA;QACrE,OAAO,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAA;KACtC;IAAC,MAAM;QACN,MAAM,IAAI,KAAK,CACb,mBAAmB,EACnB,iDACE,OAAO,CAAA,GAAG,KAAK,CAAC,mBAAmB,CAAC,GAAG,aAAa,EAAE,kBAAkB,CAAC,EAAE,CAAC,KAC9E,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,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,mBAAmB,EACjF,mDACE,OAAO,CAAA,GAAG,KAAK,CAAC,mBAAmB,CAAC,GAAG,aAAa,EAAE,kBAAkB,CAAC,EAAE,CAAC,KAC9E,EAAE,CACH,CAAA;KACF;AACH,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,gCAAgC;IAC7C,OAAO,IAAI,CAAC,KAAK,CAAC,mBAAmB,EAAE,CAAC,CAAA;AAC1C,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,mCAAmC;IAChD,OAAO,IAAI,CAAC,KAAK,CAAC,mBAAmB,EAAE,CAAC,CAAA;AAC1C,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,uBAAuB;IACpC,MAAM,OAAO,GAAG,IAAI,CAAC,mBAAmB,EAAE,EAAE,SAAS,CAAC,CAAA;IACtD,MAAM,cAAc,GAAG,CAAC,+BAA+B,EAAE,uBAAuB,cAAc,GAAG,CAAC,CAAA;IAClG,MAAM,EAAC,QAAQ,EAAC,GAAG,eAAe,EAAE,CAAA;IACpC,IAAI,QAAQ,KAAK,SAAS,EAAE;QAC1B,+EAA+E;QAC/E,cAAc,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAA;KAC7C;IACD,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;AACtD,CAAC;AAED;;GAEG;AACH,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;;GAEG;AACH,KAAK,UAAU,4BAA4B;IACzC,MAAM,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,EAAC,GAAG,EAAE,mBAAmB,EAAE,EAAC,CAAC,CAAA;AAClF,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,uBAAuB;IACpC,MAAM,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,mBAAmB,EAAE,CAAC,EAAE;QACjG,GAAG,EAAE,mBAAmB,EAAE;KAC3B,CAAC,CAAA;IACF,MAAM,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,EAAC,GAAG,EAAE,mBAAmB,EAAE,EAAC,CAAC,CAAA;AAClF,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,uBAAuB;IACpC,MAAM,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,mBAAmB,EAAE,CAAC,EAAE;QACjG,GAAG,EAAE,mBAAmB,EAAE;KAC3B,CAAC,CAAA;IACF,MAAM,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,EAAC,GAAG,EAAE,mBAAmB,EAAE,EAAC,CAAC,CAAA;AAClF,CAAC;AAED;;;;GAIG;AACH,SAAS,mBAAmB;IAC1B,OAAO,CACL,OAAO,CAAC,GAAG,CAAC,yBAAyB;QACrC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,UAAU,EAAE,cAAc,CAAC,CAClF,CAAA;AACH,CAAC;AAED;;;;GAIG;AACH,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;;GAEG;AACH,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,cAAc,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;SACvC,IAAI,CAAC,WAAW,CAAC;SACjB,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAA;AAC3B,CAAC;AAED;;;;;;GAMG;AACH,SAAS,aAAa;IACpB,OAAO,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAA;AACxC,CAAC;AAED;;;;GAIG;AACH,SAAS,cAAc;IACrB,MAAM,UAAU,GAAG,aAAa,EAAE,CAAA;IAClC,OAAO,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;AACvD,CAAC;AAED;;;;GAIG;AACH,SAAS,gBAAgB;IACvB,MAAM,UAAU,GAAG,aAAa,EAAE,CAAA;IAClC,OAAO,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAA;AAC3D,CAAC;AAED;;;;GAIG;AACH,SAAS,aAAa;IACpB,MAAM,UAAU,GAAG,aAAa,EAAE,CAAA;IAClC,OAAO,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;AACrD,CAAC","sourcesContent":["import {coerceSemverVersion} from './semver.js'\nimport {AbortSignal} from './abort.js'\nimport {platformAndArch} from './os.js'\nimport * as file from '../../file.js'\nimport * as ui from '../../ui.js'\nimport * as system from '../../system.js'\nimport {Abort, AbortSilent} from '../../error.js'\nimport {glob, join} from '../../path.js'\nimport constants from '../../constants.js'\nimport {AdminSession} from '../../session.js'\nimport {content, token} from '../../output.js'\nimport {Writable} from 'stream'\n\nconst RubyCLIVersion = '2.33.1'\nconst ThemeCheckVersion = '1.14.0'\nconst MinBundlerVersion = '2.3.8'\nconst MinRubyVersion = '2.7.5'\n\ninterface ExecCLI2Options {\n  // Contains token and store to pass to CLI 2.0, which will be set as environment variables\n  adminSession?: AdminSession\n  // Contains token for storefront access to pass to CLI 2.0 as environment variable\n  storefrontToken?: string\n  // Contains token for partners access to pass to CLI 2.0 as environment variable\n  token?: string\n  // Directory in which to execute the command. Otherwise the current directory will be used.\n  directory?: string\n  // A signal to stop the process execution.\n  signal?: AbortSignal\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 - List of argumets to execute. (ex: ['theme', 'pull']).\n * @param options - Options to customize the execution of cli2.\n */\nexport async function execCLI2(args: string[], options: ExecCLI2Options = {}): Promise<void> {\n  await installCLIDependencies()\n  const env: NodeJS.ProcessEnv = {\n    ...process.env,\n    SHOPIFY_CLI_STOREFRONT_RENDERER_AUTH_TOKEN: options.storefrontToken,\n    SHOPIFY_CLI_ADMIN_AUTH_TOKEN: options.adminSession?.token,\n    SHOPIFY_SHOP: options.adminSession?.storeFqdn,\n    SHOPIFY_CLI_AUTH_TOKEN: options.token,\n    SHOPIFY_CLI_RUN_AS_SUBPROCESS: 'true',\n    // Bundler uses this Gemfile to understand which gems are available in the\n    // environment. We use this to specify our own Gemfile for CLI2, which exists\n    // outside the user's project directory.\n    BUNDLE_GEMFILE: join(shopifyCLIDirectory(), 'Gemfile'),\n  }\n\n  try {\n    await system.exec(bundleExecutable(), ['exec', 'shopify'].concat(args), {\n      stdio: 'inherit',\n      cwd: options.directory ?? process.cwd(),\n      env,\n      signal: options.signal,\n    })\n  } catch (error) {\n    // CLI2 will show it's own errors, we don't need to show an additional CLI3 error\n    throw new AbortSilent()\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 *\n * @param options - Options to customize the execution of theme-check.\n * @returns A promise that resolves or rejects depending on the result of the underlying theme-check process.\n */\nexport async function execThemeCheckCLI(options: ExecThemeCheckCLIOptions): Promise<void[]> {\n  await installThemeCheckCLIDependencies(options.stdout)\n\n  const processes = options.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          options.stdout.write(chunk, ...args)\n        } else {\n          options.stderr.write(chunk, ...args)\n        }\n      },\n    })\n    await system.exec(bundleExecutable(), ['exec', 'theme-check'].concat([directory, ...(options.args || [])]), {\n      stdout: options.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 *\n * @param stdout - The Writable stream on which to write the standard output.\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          const usingLocalCLI2 = Boolean(process.env.SHOPIFY_CLI_2_0_DIRECTORY)\n          await validateRubyEnv()\n          if (usingLocalCLI2) {\n            await bundleInstallLocalShopifyCLI()\n          } else {\n            await createShopifyCLIWorkingDirectory()\n            await createShopifyCLIGemfile()\n            await bundleInstallShopifyCLI()\n          }\n        },\n      },\n    ],\n    {renderer},\n  )\n  await list.run()\n}\n\n/**\n * A function that validates if the environment in which the CLI is running is set up with Ruby and Bundler.\n */\nasync function validateRubyEnv() {\n  await validateRuby()\n  await validateBundler()\n}\n\n/**\n * A function that validates if the environment in which the CLI is running is set up with Ruby.\n */\nasync function validateRuby() {\n  let version\n  try {\n    const stdout = await system.captureOutput(rubyExecutable(), ['-v'])\n    version = coerceSemverVersion(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('Documentation.', '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('Documentation.', 'https://www.ruby-lang.org/en/documentation/installation/')}`.value\n      }`,\n    )\n  }\n}\n\n/**\n * A function that validates if the environment in which the CLI is running is set up with Bundler.\n */\nasync function validateBundler() {\n  let version\n  try {\n    const stdout = await system.captureOutput(bundleExecutable(), ['-v'])\n    version = coerceSemverVersion(stdout)\n  } catch {\n    throw new Abort(\n      'Bundler not found',\n      `To install the latest version of Bundler, run ${\n        content`${token.genericShellCommand(`${gemExecutable()} 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(`${gemExecutable()} install bundler`)}`.value\n      }`,\n    )\n  }\n}\n\n/**\n * It creates the directory where the Ruby CLI will be downloaded along its dependencies.\n */\nasync function createShopifyCLIWorkingDirectory(): Promise<void> {\n  return file.mkdir(shopifyCLIDirectory())\n}\n\n/**\n * It creates the directory where the theme-check CLI will be downloaded along its dependencies.\n */\nasync function createThemeCheckCLIWorkingDirectory(): Promise<void> {\n  return file.mkdir(themeCheckDirectory())\n}\n\n/**\n * It creates the Gemfile to install The Ruby CLI and the dependencies.\n */\nasync function createShopifyCLIGemfile(): Promise<void> {\n  const gemPath = join(shopifyCLIDirectory(), 'Gemfile')\n  const gemFileContent = [\"source 'https://rubygems.org'\", `gem 'shopify-cli', '${RubyCLIVersion}'`]\n  const {platform} = platformAndArch()\n  if (platform === 'windows') {\n    // 'wdm' is required by 'listen', see https://github.com/Shopify/cli/issues/780\n    gemFileContent.push(\"gem 'wdm', '>= 0.1.0'\")\n  }\n  await file.write(gemPath, gemFileContent.join('\\n'))\n}\n\n/**\n * It creates the Gemfile to install theme-check and its dependencies.\n */\nasync function createThemeCheckGemfile(): Promise<void> {\n  const gemPath = join(themeCheckDirectory(), 'Gemfile')\n  await file.write(gemPath, `source 'https://rubygems.org'\\ngem 'theme-check', '${ThemeCheckVersion}'`)\n}\n\n/**\n * It runs bundle install for the dev-managed copy of the Ruby CLI.\n */\nasync function bundleInstallLocalShopifyCLI(): Promise<void> {\n  await system.exec(bundleExecutable(), ['install'], {cwd: shopifyCLIDirectory()})\n}\n\n/**\n * It runs bundle install for the CLI-managed copy of the Ruby CLI.\n */\nasync function bundleInstallShopifyCLI() {\n  await system.exec(bundleExecutable(), ['config', 'set', '--local', 'path', shopifyCLIDirectory()], {\n    cwd: shopifyCLIDirectory(),\n  })\n  await system.exec(bundleExecutable(), ['install'], {cwd: shopifyCLIDirectory()})\n}\n\n/**\n * It runs bundle install for the CLI-managed copy of theme-check.\n */\nasync function bundleInstallThemeCheck() {\n  await system.exec(bundleExecutable(), ['config', 'set', '--local', 'path', themeCheckDirectory()], {\n    cwd: themeCheckDirectory(),\n  })\n  await system.exec(bundleExecutable(), ['install'], {cwd: themeCheckDirectory()})\n}\n\n/**\n * It returns the directory where the Ruby CLI is located.\n *\n * @returns The absolute path to the directory.\n */\nfunction shopifyCLIDirectory(): string {\n  return (\n    process.env.SHOPIFY_CLI_2_0_DIRECTORY ??\n    join(constants.paths.directories.cache.vendor.path(), 'ruby-cli', RubyCLIVersion)\n  )\n}\n\n/**\n * It returns the path to the directory containing the theme-check CLI.\n *\n * @returns The absolute path to the theme-check directory.\n */\nfunction themeCheckDirectory(): string {\n  return join(constants.paths.directories.cache.vendor.path(), 'theme-check', ThemeCheckVersion)\n}\n\n/**\n * It returns the Ruby version present in the envirronment.\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(rubyExecutable(), ['-v'])\n    .then(parseOutput)\n    .catch(() => undefined)\n}\n\n/**\n * It returns the Ruby binary path set through the environment variable SHOPIFY_RUBY_BINDIR.\n * This is useful when the CLI is managed by an installer like a Homebrew where we need to\n * point the CLI to the Ruby installation managed by Homebrew.\n *\n * @returns The value of the environment variable.\n */\nfunction getRubyBinDir(): string | undefined {\n  return process.env.SHOPIFY_RUBY_BINDIR\n}\n\n/**\n * It returns the path to the \"ruby\" executable.\n *\n * @returns The path to the executable.\n */\nfunction rubyExecutable(): string {\n  const rubyBinDir = getRubyBinDir()\n  return rubyBinDir ? join(rubyBinDir, 'ruby') : 'ruby'\n}\n\n/**\n * It returns the path to the \"bundle\" executable.\n *\n * @returns The path to the executable.\n */\nfunction bundleExecutable(): string {\n  const rubyBinDir = getRubyBinDir()\n  return rubyBinDir ? join(rubyBinDir, 'bundle') : 'bundle'\n}\n\n/**\n * It returns the path to the \"gem\"\" executable.\n *\n * @returns The path to the executable.\n */\nfunction gemExecutable(): string {\n  const rubyBinDir = getRubyBinDir()\n  return rubyBinDir ? join(rubyBinDir, 'gem') : 'gem'\n}\n"]}

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

@@ -1,5 +1,7 @@
 /**
  * Returns an available port in the current environment.
+ *
  * @returns A promise that resolves with an availabe port.
+ * @example
  */
 export declare function getAvailableTCPPort(): Promise<number>;

package/dist/public/node/tcp.js

@@ -4,7 +4,9 @@ import { sleep } from '../../system.js';
 import * as port from 'get-port-please';
 /**
  * Returns an available port in the current environment.
+ *
  * @returns A promise that resolves with an availabe port.
+ * @example
  */
 export async function getAvailableTCPPort() {
     debug(content `Getting a random port...`);
@@ -12,6 +14,13 @@ export async function getAvailableTCPPort() {
     debug(content `Random port obtained: ${token.raw(`${randomPort}`)}`);
     return randomPort;
 }
+/**
+ * Given a function, it runs it and retries in case of failiure up to the provided number of times.
+ *
+ * @param execute - The function to execute.
+ * @param maxTries - The maximum retries.
+ * @param waitTimeInSeconds - The time to wait between retries.
+ */
 async function retryOnError(execute, maxTries = 5, waitTimeInSeconds = 1) {
     let retryCount = 1;
     while (true) {

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

@@ -1 +1 @@
-{"version":3,"file":"tcp.js","sourceRoot":"","sources":["../../../src/public/node/tcp.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAC,MAAM,iBAAiB,CAAA;AACrD,OAAO,EAAC,KAAK,EAAC,MAAM,gBAAgB,CAAA;AACpC,OAAO,EAAC,KAAK,EAAC,MAAM,iBAAiB,CAAA;AACrC,OAAO,KAAK,IAAI,MAAM,iBAAiB,CAAA;AAEvC;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB;IACvC,KAAK,CAAC,OAAO,CAAA,0BAA0B,CAAC,CAAA;IACxC,MAAM,UAAU,GAAG,MAAM,YAAY,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAA;IACjE,KAAK,CAAC,OAAO,CAAA,yBAAyB,KAAK,CAAC,GAAG,CAAC,GAAG,UAAU,EAAE,CAAC,EAAE,CAAC,CAAA;IACnE,OAAO,UAAU,CAAA;AACnB,CAAC;AAED,KAAK,UAAU,YAAY,CAAI,OAAgB,EAAE,QAAQ,GAAG,CAAC,EAAE,iBAAiB,GAAG,CAAC;IAClF,IAAI,UAAU,GAAG,CAAC,CAAA;IAClB,OAAO,IAAI,EAAE;QACX,IAAI;YACF,4CAA4C;YAC5C,OAAO,MAAM,OAAO,EAAE,CAAA;YACtB,8DAA8D;SAC/D;QAAC,OAAO,KAAU,EAAE;YACnB,IAAI,UAAU,EAAE,GAAG,QAAQ,EAAE;gBAC3B,KAAK,CAAC,OAAO,CAAA,0CAA0C,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;gBACvE,4CAA4C;gBAC5C,MAAM,KAAK,CAAC,iBAAiB,CAAC,CAAA;aAC/B;iBAAM;gBACL,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;aAC/B;SACF;KACF;AACH,CAAC","sourcesContent":["import {debug, content, token} from '../../output.js'\nimport {Abort} from '../../error.js'\nimport {sleep} from '../../system.js'\nimport * as port from 'get-port-please'\n\n/**\n * Returns an available port in the current environment.\n * @returns A promise that resolves with an availabe port.\n */\nexport async function getAvailableTCPPort(): Promise<number> {\n  debug(content`Getting a random port...`)\n  const randomPort = await retryOnError(() => port.getRandomPort())\n  debug(content`Random port obtained: ${token.raw(`${randomPort}`)}`)\n  return randomPort\n}\n\nasync function retryOnError<T>(execute: () => T, maxTries = 5, waitTimeInSeconds = 1) {\n  let retryCount = 1\n  while (true) {\n    try {\n      // eslint-disable-next-line no-await-in-loop\n      return await execute()\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    } catch (error: any) {\n      if (retryCount++ < maxTries) {\n        debug(content`Unknown problem getting a random port: ${error.message}`)\n        // eslint-disable-next-line no-await-in-loop\n        await sleep(waitTimeInSeconds)\n      } else {\n        throw new Abort(error.message)\n      }\n    }\n  }\n}\n"]}
+{"version":3,"file":"tcp.js","sourceRoot":"","sources":["../../../src/public/node/tcp.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAC,MAAM,iBAAiB,CAAA;AACrD,OAAO,EAAC,KAAK,EAAC,MAAM,gBAAgB,CAAA;AACpC,OAAO,EAAC,KAAK,EAAC,MAAM,iBAAiB,CAAA;AACrC,OAAO,KAAK,IAAI,MAAM,iBAAiB,CAAA;AAEvC;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB;IACvC,KAAK,CAAC,OAAO,CAAA,0BAA0B,CAAC,CAAA;IACxC,MAAM,UAAU,GAAG,MAAM,YAAY,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAA;IACjE,KAAK,CAAC,OAAO,CAAA,yBAAyB,KAAK,CAAC,GAAG,CAAC,GAAG,UAAU,EAAE,CAAC,EAAE,CAAC,CAAA;IACnE,OAAO,UAAU,CAAA;AACnB,CAAC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,YAAY,CAAI,OAAgB,EAAE,QAAQ,GAAG,CAAC,EAAE,iBAAiB,GAAG,CAAC;IAClF,IAAI,UAAU,GAAG,CAAC,CAAA;IAClB,OAAO,IAAI,EAAE;QACX,IAAI;YACF,4CAA4C;YAC5C,OAAO,MAAM,OAAO,EAAE,CAAA;YACtB,8DAA8D;SAC/D;QAAC,OAAO,KAAU,EAAE;YACnB,IAAI,UAAU,EAAE,GAAG,QAAQ,EAAE;gBAC3B,KAAK,CAAC,OAAO,CAAA,0CAA0C,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;gBACvE,4CAA4C;gBAC5C,MAAM,KAAK,CAAC,iBAAiB,CAAC,CAAA;aAC/B;iBAAM;gBACL,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;aAC/B;SACF;KACF;AACH,CAAC","sourcesContent":["import {debug, content, token} from '../../output.js'\nimport {Abort} from '../../error.js'\nimport {sleep} from '../../system.js'\nimport * as port from 'get-port-please'\n\n/**\n * Returns an available port in the current environment.\n *\n * @returns A promise that resolves with an availabe port.\n * @example\n */\nexport async function getAvailableTCPPort(): Promise<number> {\n  debug(content`Getting a random port...`)\n  const randomPort = await retryOnError(() => port.getRandomPort())\n  debug(content`Random port obtained: ${token.raw(`${randomPort}`)}`)\n  return randomPort\n}\n\n/**\n * Given a function, it runs it and retries in case of failiure up to the provided number of times.\n *\n * @param execute - The function to execute.\n * @param maxTries - The maximum retries.\n * @param waitTimeInSeconds - The time to wait between retries.\n */\nasync function retryOnError<T>(execute: () => T, maxTries = 5, waitTimeInSeconds = 1) {\n  let retryCount = 1\n  while (true) {\n    try {\n      // eslint-disable-next-line no-await-in-loop\n      return await execute()\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    } catch (error: any) {\n      if (retryCount++ < maxTries) {\n        debug(content`Unknown problem getting a random port: ${error.message}`)\n        // eslint-disable-next-line no-await-in-loop\n        await sleep(waitTimeInSeconds)\n      } else {\n        throw new Abort(error.message)\n      }\n    }\n  }\n}\n"]}

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

@@ -0,0 +1,15 @@
+import * as toml from '@iarna/toml';
+/**
+ * Given a TOML string, it returns a JSON object.
+ *
+ * @param input - TOML string.
+ * @returns JSON object.
+ */
+export declare function decodeToml(input: string): object;
+/**
+ * Given a JSON object, it returns a TOML string.
+ *
+ * @param content - JSON object.
+ * @returns TOML string.
+ */
+export declare function encodeToml(content: toml.JsonMap): string;

package/dist/public/node/toml.js

@@ -0,0 +1,20 @@
+import * as toml from '@iarna/toml';
+/**
+ * Given a TOML string, it returns a JSON object.
+ *
+ * @param input - TOML string.
+ * @returns JSON object.
+ */
+export function decodeToml(input) {
+    return toml.parse(input);
+}
+/**
+ * Given a JSON object, it returns a TOML string.
+ *
+ * @param content - JSON object.
+ * @returns TOML string.
+ */
+export function encodeToml(content) {
+    return toml.stringify(content);
+}
+//# sourceMappingURL=toml.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"toml.js","sourceRoot":"","sources":["../../../src/public/node/toml.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,aAAa,CAAA;AAEnC;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,KAAa;IACtC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;AAC1B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,OAAqB;IAC9C,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;AAChC,CAAC","sourcesContent":["import * as toml from '@iarna/toml'\n\n/**\n * Given a TOML string, it returns a JSON object.\n *\n * @param input - TOML string.\n * @returns JSON object.\n */\nexport function decodeToml(input: string): object {\n  return toml.parse(input)\n}\n\n/**\n * Given a JSON object, it returns a TOML string.\n *\n * @param content - JSON object.\n * @returns TOML string.\n */\nexport function encodeToml(content: toml.JsonMap): string {\n  return toml.stringify(content)\n}\n"]}