@shopify/cli-kit 3.32.1 → 3.34.0

package/dist/{environment → public/node/environment}/local.d.ts

@@ -1,29 +1,35 @@
 /// <reference types="node" />
 /**
  * It returns true if the terminal is interactive.
+ *
  * @returns True if the terminal is interactive.
  */
 export declare function isTerminalInteractive(): boolean;
 /**
  * Returns the path to the user's home directory.
+ *
  * @returns The path to the user's home directory.
  */
 export declare function homeDirectory(): string;
 /**
  * Returns true if the CLI is running in debug mode.
+ *
  * @param env - The environment variables from the environment of the current process.
- * @returns true if SHOPIFY_ENV is development
+ * @returns True if SHOPIFY_ENV is development.
  */
 export declare function isDevelopment(env?: NodeJS.ProcessEnv): boolean;
 /**
  * Returns true if the CLI is running in verbose mode.
+ *
  * @param env - The environment variables from the environment of the current process.
- * @returns true if SHOPIFY_FLAG_VERBOSE is truthy or the flag --verbose has been passed
+ * @returns True if SHOPIFY_FLAG_VERBOSE is truthy or the flag --verbose has been passed.
  */
 export declare function isVerbose(env?: NodeJS.ProcessEnv): boolean;
 /**
  * Returns true if the environment in which the CLI is running is either
  * a local environment (where dev is present) or a cloud environment (spin).
+ *
+ * @param env - The environment variables from the environment of the current process.
  * @returns True if the CLI is used in a Shopify environment.
  */
 export declare function isShopify(env?: NodeJS.ProcessEnv): Promise<boolean>;
@@ -31,39 +37,75 @@ export declare function isShopify(env?: NodeJS.ProcessEnv): Promise<boolean>;
  * This variable is used when running unit tests to indicate that the CLI's business logic
  * is run as a subject of a unit test. We can use this variable to disable output through
  * the standard streams.
+ *
  * @param env - The environment variables from the environment of the current process.
  * @returns True if the SHOPIFY_UNIT_TEST environment variable is truthy.
  */
 export declare function isUnitTest(env?: NodeJS.ProcessEnv): boolean;
 /**
  * Returns true if reporting analytics is enabled.
+ *
  * @param env - The environment variables from the environment of the current process.
- * @returns true unless SHOPIFY_CLI_NO_ANALYTICS is truthy or debug mode is enabled.
+ * @returns True unless SHOPIFY_CLI_NO_ANALYTICS is truthy or debug mode is enabled.
  */
 export declare function analyticsDisabled(env?: NodeJS.ProcessEnv): boolean;
-/** Returns true if reporting analytics should always happen, regardless of DEBUG mode etc. */
+/**
+ * Returns true if reporting analytics should always happen, regardless of DEBUG mode etc.
+ *
+ * @param env - The environment variables from the environment of the current process.
+ * @returns True if SHOPIFY_CLI_ALWAYS_LOG_ANALYTICS is truthy.
+ */
 export declare function alwaysLogAnalytics(env?: NodeJS.ProcessEnv): boolean;
+/**
+ * Returns true if the CLI User is 1P.
+ *
+ * @param env - The environment variables from the environment of the current process.
+ * @returns True if SHOPIFY_CLI_1P is truthy.
+ */
 export declare function firstPartyDev(env?: NodeJS.ProcessEnv): boolean;
+/**
+ * Returns true if the CLI should use device auth.
+ *
+ * @param env - The environment variables from the environment of the current process.
+ * @returns True if SHOPIFY_CLI_DEVICE_AUTH is truthy or the CLI is run from a cloud environment.
+ */
 export declare function useDeviceAuth(env?: NodeJS.ProcessEnv): boolean;
-export declare function useFunctionMatching(env?: NodeJS.ProcessEnv): boolean;
+/**
+ * Returns true if the CLI should use theme bundling.
+ *
+ * @param env - The environment variables from the environment of the current process.
+ * @returns True if SHOPIFY_CLI_THEME_BUNDLING is truthy.
+ */
 export declare function useThemeBundling(env?: NodeJS.ProcessEnv): boolean;
+/**
+ * Return gitpodURL if we are running in gitpod.
+ * Https://www.gitpod.io/docs/environment-variables#default-environment-variables.
+ *
+ * @param env - The environment variables from the environment of the current process.
+ * @returns The gitpod URL.
+ */
 export declare function gitpodURL(env?: NodeJS.ProcessEnv): string | undefined;
-export declare function codespaceURL(env?: NodeJS.ProcessEnv): string | undefined;
 /**
- * Checks if the CLI is run from a cloud environment
+ * Return codespaceURL if we are running in codespaces.
+ * Https://docs.github.com/en/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace#list-of-default-environment-variables.
  *
- * @param env - Environment variables used when the cli is launched
+ * @param env - The environment variables from the environment of the current process.
+ * @returns The codespace URL.
+ */
+export declare function codespaceURL(env?: NodeJS.ProcessEnv): string | undefined;
+/**
+ * Checks if the CLI is run from a cloud environment.
  *
- * @returns True in case the CLI is run from a cloud environment
+ * @param env - Environment variables used when the cli is launched.
+ * @returns True in case the CLI is run from a cloud environment.
  */
 export declare function isCloudEnvironment(env?: NodeJS.ProcessEnv): boolean;
 /**
  * Returns the cloud environment platform name and if the platform support online IDE in case the CLI is run from one of
- * them. Platform name 'localhost' is returned otherwise
+ * them. Platform name 'localhost' is returned otherwise.
  *
- * @param env - Environment variables used when the cli is launched
- *
- * @returns Cloud platform information
+ * @param env - Environment variables used when the cli is launched.
+ * @returns Cloud platform information.
  */
 export declare function cloudEnvironment(env?: NodeJS.ProcessEnv): {
     platform: 'spin' | 'codespaces' | 'gitpod' | 'localhost';
@@ -71,11 +113,15 @@ export declare function cloudEnvironment(env?: NodeJS.ProcessEnv): {
 };
 /**
  * Returns whether the environment has Git available.
+ *
  * @returns A promise that resolves with the value.
  */
 export declare function hasGit(): Promise<boolean>;
 /**
- * Gets info on the CI platform the CLI is running on, if applicable
+ * Gets info on the CI platform the CLI is running on, if applicable.
+ *
+ * @param env - The environment variables from the environment of the current process.
+ * @returns The CI platform info.
  */
 export declare function ciPlatform(env?: NodeJS.ProcessEnv): {
     isCI: true;
@@ -85,8 +131,8 @@ export declare function ciPlatform(env?: NodeJS.ProcessEnv): {
     name?: undefined;
 };
 /**
- * Returns the first mac address found
+ * Returns the first mac address found.
  *
- * @returns Mac address
+ * @returns Mac address.
  */
 export declare function macAddress(): Promise<string>;

package/dist/{environment → public/node/environment}/local.js

@@ -1,13 +1,14 @@
-import { isTruthy, isSet } from './utilities.js';
-import { isSpin } from './spin.js';
-import constants from '../constants.js';
-import { exists as fileExists } from '../file.js';
+import { isTruthy, isSet } from '../../../private/node/environment/utilities.js';
+import constants from '../../../constants.js';
+import { exists as fileExists } from '../../../file.js';
 import { exec } from '../system.js';
+import { isSpin } from '../environment/spin.js';
 import isInteractive from 'is-interactive';
 import macaddress from 'macaddress';
 import { homedir } from 'os';
 /**
  * It returns true if the terminal is interactive.
+ *
  * @returns True if the terminal is interactive.
  */
 export function isTerminalInteractive() {
@@ -15,6 +16,7 @@ export function isTerminalInteractive() {
 }
 /**
  * Returns the path to the user's home directory.
+ *
  * @returns The path to the user's home directory.
  */
 export function homeDirectory() {
@@ -22,16 +24,18 @@ export function homeDirectory() {
 }
 /**
  * Returns true if the CLI is running in debug mode.
+ *
  * @param env - The environment variables from the environment of the current process.
- * @returns true if SHOPIFY_ENV is development
+ * @returns True if SHOPIFY_ENV is development.
  */
 export function isDevelopment(env = process.env) {
     return env[constants.environmentVariables.env] === 'development';
 }
 /**
  * Returns true if the CLI is running in verbose mode.
+ *
  * @param env - The environment variables from the environment of the current process.
- * @returns true if SHOPIFY_FLAG_VERBOSE is truthy or the flag --verbose has been passed
+ * @returns True if SHOPIFY_FLAG_VERBOSE is truthy or the flag --verbose has been passed.
  */
 export function isVerbose(env = process.env) {
     return isTruthy(env[constants.environmentVariables.verbose]) || process.argv.includes('--verbose');
@@ -39,6 +43,8 @@ export function isVerbose(env = process.env) {
 /**
  * Returns true if the environment in which the CLI is running is either
  * a local environment (where dev is present) or a cloud environment (spin).
+ *
+ * @param env - The environment variables from the environment of the current process.
  * @returns True if the CLI is used in a Shopify environment.
  */
 export async function isShopify(env = process.env) {
@@ -52,6 +58,7 @@ export async function isShopify(env = process.env) {
  * This variable is used when running unit tests to indicate that the CLI's business logic
  * is run as a subject of a unit test. We can use this variable to disable output through
  * the standard streams.
+ *
  * @param env - The environment variables from the environment of the current process.
  * @returns True if the SHOPIFY_UNIT_TEST environment variable is truthy.
  */
@@ -60,53 +67,84 @@ export function isUnitTest(env = process.env) {
 }
 /**
  * Returns true if reporting analytics is enabled.
+ *
  * @param env - The environment variables from the environment of the current process.
- * @returns true unless SHOPIFY_CLI_NO_ANALYTICS is truthy or debug mode is enabled.
+ * @returns True unless SHOPIFY_CLI_NO_ANALYTICS is truthy or debug mode is enabled.
  */
 export function analyticsDisabled(env = process.env) {
     return isTruthy(env[constants.environmentVariables.noAnalytics]) || isDevelopment(env);
 }
-/** Returns true if reporting analytics should always happen, regardless of DEBUG mode etc. */
+/**
+ * Returns true if reporting analytics should always happen, regardless of DEBUG mode etc.
+ *
+ * @param env - The environment variables from the environment of the current process.
+ * @returns True if SHOPIFY_CLI_ALWAYS_LOG_ANALYTICS is truthy.
+ */
 export function alwaysLogAnalytics(env = process.env) {
     return isTruthy(env[constants.environmentVariables.alwaysLogAnalytics]);
 }
+/**
+ * Returns true if the CLI User is 1P.
+ *
+ * @param env - The environment variables from the environment of the current process.
+ * @returns True if SHOPIFY_CLI_1P is truthy.
+ */
 export function firstPartyDev(env = process.env) {
     return isTruthy(env[constants.environmentVariables.firstPartyDev]);
 }
+/**
+ * Returns true if the CLI should use device auth.
+ *
+ * @param env - The environment variables from the environment of the current process.
+ * @returns True if SHOPIFY_CLI_DEVICE_AUTH is truthy or the CLI is run from a cloud environment.
+ */
 export function useDeviceAuth(env = process.env) {
     return isTruthy(env[constants.environmentVariables.deviceAuth]) || isCloudEnvironment(env);
 }
-export function useFunctionMatching(env = process.env) {
-    return isTruthy(env[constants.environmentVariables.functionMatching]);
-}
+/**
+ * Returns true if the CLI should use theme bundling.
+ *
+ * @param env - The environment variables from the environment of the current process.
+ * @returns True if SHOPIFY_CLI_THEME_BUNDLING is truthy.
+ */
 export function useThemeBundling(env = process.env) {
     return isTruthy(env[constants.environmentVariables.themeBundling]);
 }
-// https://www.gitpod.io/docs/environment-variables#default-environment-variables
+/**
+ * Return gitpodURL if we are running in gitpod.
+ * Https://www.gitpod.io/docs/environment-variables#default-environment-variables.
+ *
+ * @param env - The environment variables from the environment of the current process.
+ * @returns The gitpod URL.
+ */
 export function gitpodURL(env = process.env) {
     return env[constants.environmentVariables.gitpod];
 }
-// https://docs.github.com/en/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace#list-of-default-environment-variables
+/**
+ * Return codespaceURL if we are running in codespaces.
+ * Https://docs.github.com/en/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace#list-of-default-environment-variables.
+ *
+ * @param env - The environment variables from the environment of the current process.
+ * @returns The codespace URL.
+ */
 export function codespaceURL(env = process.env) {
     return env[constants.environmentVariables.codespaceName];
 }
 /**
- * Checks if the CLI is run from a cloud environment
- *
- * @param env - Environment variables used when the cli is launched
+ * Checks if the CLI is run from a cloud environment.
  *
- * @returns True in case the CLI is run from a cloud environment
+ * @param env - Environment variables used when the cli is launched.
+ * @returns True in case the CLI is run from a cloud environment.
  */
 export function isCloudEnvironment(env = process.env) {
     return cloudEnvironment(env).platform !== 'localhost';
 }
 /**
  * Returns the cloud environment platform name and if the platform support online IDE in case the CLI is run from one of
- * them. Platform name 'localhost' is returned otherwise
+ * them. Platform name 'localhost' is returned otherwise.
  *
- * @param env - Environment variables used when the cli is launched
- *
- * @returns Cloud platform information
+ * @param env - Environment variables used when the cli is launched.
+ * @returns Cloud platform information.
  */
 export function cloudEnvironment(env = process.env) {
     if (isSet(env[constants.environmentVariables.codespaces])) {
@@ -122,6 +160,7 @@ export function cloudEnvironment(env = process.env) {
 }
 /**
  * Returns whether the environment has Git available.
+ *
  * @returns A promise that resolves with the value.
  */
 export async function hasGit() {
@@ -135,7 +174,10 @@ export async function hasGit() {
     }
 }
 /**
- * Gets info on the CI platform the CLI is running on, if applicable
+ * Gets info on the CI platform the CLI is running on, if applicable.
+ *
+ * @param env - The environment variables from the environment of the current process.
+ * @returns The CI platform info.
  */
 export function ciPlatform(env = process.env) {
     if (isTruthy(env.CI)) {
@@ -159,9 +201,9 @@ export function ciPlatform(env = process.env) {
     };
 }
 /**
- * Returns the first mac address found
+ * Returns the first mac address found.
  *
- * @returns Mac address
+ * @returns Mac address.
  */
 export function macAddress() {
     return macaddress.one();

package/dist/public/node/environment/local.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"local.js","sourceRoot":"","sources":["../../../../src/public/node/environment/local.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAE,KAAK,EAAC,MAAM,gDAAgD,CAAA;AAC9E,OAAO,SAAS,MAAM,uBAAuB,CAAA;AAC7C,OAAO,EAAC,MAAM,IAAI,UAAU,EAAC,MAAM,kBAAkB,CAAA;AACrD,OAAO,EAAC,IAAI,EAAC,MAAM,cAAc,CAAA;AACjC,OAAO,EAAC,MAAM,EAAC,MAAM,wBAAwB,CAAA;AAC7C,OAAO,aAAa,MAAM,gBAAgB,CAAA;AAC1C,OAAO,UAAU,MAAM,YAAY,CAAA;AACnC,OAAO,EAAC,OAAO,EAAC,MAAM,IAAI,CAAA;AAE1B;;;;GAIG;AACH,MAAM,UAAU,qBAAqB;IACnC,OAAO,aAAa,EAAE,CAAA;AACxB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa;IAC3B,OAAO,OAAO,EAAE,CAAA;AAClB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IAC7C,OAAO,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,KAAK,aAAa,CAAA;AAClE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACzC,OAAO,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;AACpG,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IAC/C,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,oBAAoB,CAAC,SAAS,CAAC,EAAE;QACvF,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC,CAAA;KAChE;IACD,MAAM,YAAY,GAAG,MAAM,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;IACtE,OAAO,YAAY,IAAI,MAAM,CAAC,GAAG,CAAC,CAAA;AACpC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,UAAU,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IAC1C,OAAO,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC,CAAA;AAC/D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACjD,OAAO,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC,IAAI,aAAa,CAAC,GAAG,CAAC,CAAA;AACxF,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IAClD,OAAO,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,kBAAkB,CAAC,CAAC,CAAA;AACzE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IAC7C,OAAO,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC,CAAA;AACpE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IAC7C,OAAO,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC,IAAI,kBAAkB,CAAC,GAAG,CAAC,CAAA;AAC5F,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IAChD,OAAO,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC,CAAA;AACpE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACzC,OAAO,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAA;AACnD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IAC5C,OAAO,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAA;AAC1D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAyB,OAAO,CAAC,GAAG;IACrE,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAC,QAAQ,KAAK,WAAW,CAAA;AACvD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAyB,OAAO,CAAC,GAAG;IAInE,IAAI,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC,EAAE;QACzD,OAAO,EAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,IAAI,EAAC,CAAA;KAC9C;IACD,IAAI,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,EAAE;QACrD,OAAO,EAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAC,CAAA;KAC1C;IACD,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE;QACf,OAAO,EAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAC,CAAA;KACzC;IACD,OAAO,EAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,EAAC,CAAA;AAC/C,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM;IAC1B,IAAI;QACF,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,WAAW,CAAC,CAAC,CAAA;QAChC,OAAO,IAAI,CAAA;QACX,qDAAqD;KACtD;IAAC,MAAM;QACN,OAAO,KAAK,CAAA;KACb;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IAC1C,IAAI,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;QACpB,IAAI,IAAI,GAAG,SAAS,CAAA;QACpB,IAAI,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;YAC1B,IAAI,GAAG,UAAU,CAAA;SAClB;aAAM,IAAI,KAAK,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE;YACnC,IAAI,GAAG,QAAQ,CAAA;SAChB;aAAM,IAAI,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;YAClC,IAAI,GAAG,QAAQ,CAAA;SAChB;QAED,OAAO;YACL,IAAI,EAAE,IAAI;YACV,IAAI;SACL,CAAA;KACF;IACD,OAAO;QACL,IAAI,EAAE,KAAK;KACZ,CAAA;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU;IACxB,OAAO,UAAU,CAAC,GAAG,EAAE,CAAA;AACzB,CAAC","sourcesContent":["import {isTruthy, isSet} from '../../../private/node/environment/utilities.js'\nimport constants from '../../../constants.js'\nimport {exists as fileExists} from '../../../file.js'\nimport {exec} from '../system.js'\nimport {isSpin} from '../environment/spin.js'\nimport isInteractive from 'is-interactive'\nimport macaddress from 'macaddress'\nimport {homedir} from 'os'\n\n/**\n * It returns true if the terminal is interactive.\n *\n * @returns True if the terminal is interactive.\n */\nexport function isTerminalInteractive(): boolean {\n  return isInteractive()\n}\n\n/**\n * Returns the path to the user's home directory.\n *\n * @returns The path to the user's home directory.\n */\nexport function homeDirectory(): string {\n  return homedir()\n}\n\n/**\n * Returns true if the CLI is running in debug mode.\n *\n * @param env - The environment variables from the environment of the current process.\n * @returns True if SHOPIFY_ENV is development.\n */\nexport function isDevelopment(env = process.env): boolean {\n  return env[constants.environmentVariables.env] === 'development'\n}\n\n/**\n * Returns true if the CLI is running in verbose mode.\n *\n * @param env - The environment variables from the environment of the current process.\n * @returns True if SHOPIFY_FLAG_VERBOSE is truthy or the flag --verbose has been passed.\n */\nexport function isVerbose(env = process.env): boolean {\n  return isTruthy(env[constants.environmentVariables.verbose]) || process.argv.includes('--verbose')\n}\n\n/**\n * Returns true if the environment in which the CLI is running is either\n * a local environment (where dev is present) or a cloud environment (spin).\n *\n * @param env - The environment variables from the environment of the current process.\n * @returns True if the CLI is used in a Shopify environment.\n */\nexport async function isShopify(env = process.env): Promise<boolean> {\n  if (Object.prototype.hasOwnProperty.call(env, constants.environmentVariables.runAsUser)) {\n    return !isTruthy(env[constants.environmentVariables.runAsUser])\n  }\n  const devInstalled = await fileExists(constants.paths.executables.dev)\n  return devInstalled || isSpin(env)\n}\n\n/**\n * This variable is used when running unit tests to indicate that the CLI's business logic\n * is run as a subject of a unit test. We can use this variable to disable output through\n * the standard streams.\n *\n * @param env - The environment variables from the environment of the current process.\n * @returns True if the SHOPIFY_UNIT_TEST environment variable is truthy.\n */\nexport function isUnitTest(env = process.env): boolean {\n  return isTruthy(env[constants.environmentVariables.unitTest])\n}\n\n/**\n * Returns true if reporting analytics is enabled.\n *\n * @param env - The environment variables from the environment of the current process.\n * @returns True unless SHOPIFY_CLI_NO_ANALYTICS is truthy or debug mode is enabled.\n */\nexport function analyticsDisabled(env = process.env): boolean {\n  return isTruthy(env[constants.environmentVariables.noAnalytics]) || isDevelopment(env)\n}\n\n/**\n * Returns true if reporting analytics should always happen, regardless of DEBUG mode etc.\n *\n * @param env - The environment variables from the environment of the current process.\n * @returns True if SHOPIFY_CLI_ALWAYS_LOG_ANALYTICS is truthy.\n */\nexport function alwaysLogAnalytics(env = process.env): boolean {\n  return isTruthy(env[constants.environmentVariables.alwaysLogAnalytics])\n}\n\n/**\n * Returns true if the CLI User is 1P.\n *\n * @param env - The environment variables from the environment of the current process.\n * @returns True if SHOPIFY_CLI_1P is truthy.\n */\nexport function firstPartyDev(env = process.env): boolean {\n  return isTruthy(env[constants.environmentVariables.firstPartyDev])\n}\n\n/**\n * Returns true if the CLI should use device auth.\n *\n * @param env - The environment variables from the environment of the current process.\n * @returns True if SHOPIFY_CLI_DEVICE_AUTH is truthy or the CLI is run from a cloud environment.\n */\nexport function useDeviceAuth(env = process.env): boolean {\n  return isTruthy(env[constants.environmentVariables.deviceAuth]) || isCloudEnvironment(env)\n}\n\n/**\n * Returns true if the CLI should use theme bundling.\n *\n * @param env - The environment variables from the environment of the current process.\n * @returns True if SHOPIFY_CLI_THEME_BUNDLING is truthy.\n */\nexport function useThemeBundling(env = process.env): boolean {\n  return isTruthy(env[constants.environmentVariables.themeBundling])\n}\n\n/**\n * Return gitpodURL if we are running in gitpod.\n * Https://www.gitpod.io/docs/environment-variables#default-environment-variables.\n *\n * @param env - The environment variables from the environment of the current process.\n * @returns The gitpod URL.\n */\nexport function gitpodURL(env = process.env): string | undefined {\n  return env[constants.environmentVariables.gitpod]\n}\n\n/**\n * Return codespaceURL if we are running in codespaces.\n * Https://docs.github.com/en/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace#list-of-default-environment-variables.\n *\n * @param env - The environment variables from the environment of the current process.\n * @returns The codespace URL.\n */\nexport function codespaceURL(env = process.env): string | undefined {\n  return env[constants.environmentVariables.codespaceName]\n}\n\n/**\n * Checks if the CLI is run from a cloud environment.\n *\n * @param env - Environment variables used when the cli is launched.\n * @returns True in case the CLI is run from a cloud environment.\n */\nexport function isCloudEnvironment(env: NodeJS.ProcessEnv = process.env): boolean {\n  return cloudEnvironment(env).platform !== 'localhost'\n}\n\n/**\n * Returns the cloud environment platform name and if the platform support online IDE in case the CLI is run from one of\n * them. Platform name 'localhost' is returned otherwise.\n *\n * @param env - Environment variables used when the cli is launched.\n * @returns Cloud platform information.\n */\nexport function cloudEnvironment(env: NodeJS.ProcessEnv = process.env): {\n  platform: 'spin' | 'codespaces' | 'gitpod' | 'localhost'\n  editor: boolean\n} {\n  if (isSet(env[constants.environmentVariables.codespaces])) {\n    return {platform: 'codespaces', editor: true}\n  }\n  if (isSet(env[constants.environmentVariables.gitpod])) {\n    return {platform: 'gitpod', editor: true}\n  }\n  if (isSpin(env)) {\n    return {platform: 'spin', editor: false}\n  }\n  return {platform: 'localhost', editor: false}\n}\n\n/**\n * Returns whether the environment has Git available.\n *\n * @returns A promise that resolves with the value.\n */\nexport async function hasGit(): Promise<boolean> {\n  try {\n    await exec('git', ['--version'])\n    return true\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch {\n    return false\n  }\n}\n\n/**\n * Gets info on the CI platform the CLI is running on, if applicable.\n *\n * @param env - The environment variables from the environment of the current process.\n * @returns The CI platform info.\n */\nexport function ciPlatform(env = process.env): {isCI: true; name: string} | {isCI: false; name?: undefined} {\n  if (isTruthy(env.CI)) {\n    let name = 'unknown'\n    if (isTruthy(env.CIRCLECI)) {\n      name = 'circleci'\n    } else if (isSet(env.GITHUB_ACTION)) {\n      name = 'github'\n    } else if (isTruthy(env.GITLAB_CI)) {\n      name = 'gitlab'\n    }\n\n    return {\n      isCI: true,\n      name,\n    }\n  }\n  return {\n    isCI: false,\n  }\n}\n\n/**\n * Returns the first mac address found.\n *\n * @returns Mac address.\n */\nexport function macAddress(): Promise<string> {\n  return macaddress.one()\n}\n"]}

package/dist/public/node/environment/spin.d.ts

@@ -0,0 +1,43 @@
+/// <reference types="node" />
+/**
+ * When ran in a Spin environment, it returns the fqdn of the instance.
+ *
+ * Will cache the value of the Spin FQDN during the execution of the CLI.
+ * To avoid multiple calls to `readSync` or `show`.
+ *
+ * @param env - Environment variables.
+ * @returns Fqdn of the Spin environment.
+ */
+export declare function spinFqdn(env?: NodeJS.ProcessEnv): Promise<string>;
+/**
+ * Runs "spin show" and returns the JSON-parsed output.
+ *
+ * @param spinInstance - When it's undefined, we'll fetch the latest one.
+ * @param env - Environment variables.
+ * @returns The JSON-parsed output of the Spin CLI.
+ * @throws Any error raised from the underlying Spin CLI.
+ */
+export declare function show(spinInstance: string | undefined, env?: NodeJS.ProcessEnv): Promise<{
+    fqdn: string;
+}>;
+/**
+ * Returns true if the CLI is running in a Spin environment.
+ *
+ * @param env - Environment variables.
+ * @returns True if the CLI is running in a Spin environment.
+ */
+export declare function isSpin(env?: NodeJS.ProcessEnv): boolean;
+/**
+ * Returns the value of the SPIN_INSTANCE environment variable.
+ *
+ * @param env - Environment variables.
+ * @returns The value of the SPIN_INSTANCE environment variable.
+ */
+export declare function instance(env?: NodeJS.ProcessEnv): string | undefined;
+/**
+ * Returns true if the CLI is running in a Spin environment.
+ *
+ * @param env - Environment variables.
+ * @returns True if the CLI is running in a Spin environment.
+ */
+export declare function isSpinEnvironment(env?: NodeJS.ProcessEnv): boolean;

package/dist/{environment → public/node/environment}/spin.js

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

package/dist/public/node/environment/spin.js.map

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

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

@@ -1,7 +1,7 @@
 import { AbortError, BugError } from './error.js';
 import { Version } from './semver.js';
 import { AbortController } from './abort.js';
-import { exec } from '../../system.js';
+import { exec } from './system.js';
 import { exists as fileExists, read as readFile, write as writeFile } from '../../file.js';
 import { glob, dirname, join as pathJoin, findUp, moduleDirectory } from '../../path.js';
 import { token, content, debug } from '../../output.js';