@shopify/cli-kit 3.0.25 → 3.1.0

package/dist/npm.js

@@ -0,0 +1,20 @@
+import { join } from './path.js';
+import * as file from './file.js';
+import * as os from './os.js';
+import { debug, token, content } from './output.js';
+export async function readPackageJSON(directory) {
+    debug(content `Reading and decoding the content from package.json at ${token.path(directory)}...`);
+    const packagePath = join(directory, 'package.json');
+    const packageJSON = JSON.parse(await file.read(packagePath));
+    return packageJSON;
+}
+export async function writePackageJSON(directory, packageJSON) {
+    debug(content `JSON-encoding and writing content to package.json at ${token.path(directory)}...`);
+    const packagePath = join(directory, 'package.json');
+    await file.write(packagePath, JSON.stringify(packageJSON, null, 2));
+}
+export async function updateAppData(packageJSON, name) {
+    packageJSON.name = name;
+    packageJSON.author = (await os.username()) ?? '';
+}
+//# sourceMappingURL=npm.js.map

package/dist/npm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"npm.js","sourceRoot":"","sources":["../src/npm.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAA;AAC9B,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,EAAE,MAAM,SAAS,CAAA;AAC7B,OAAO,EAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAC,MAAM,aAAa,CAAA;AAkBjD,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,SAAiB;IACrD,KAAK,CAAC,OAAO,CAAA,yDAAyD,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;IACjG,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAA;IACnD,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAA;IAE5D,OAAO,WAAW,CAAA;AACpB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,SAAiB,EAAE,WAAiB;IACzE,KAAK,CAAC,OAAO,CAAA,wDAAwD,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;IAChG,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAA;IACnD,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;AACrE,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,WAAiB,EAAE,IAAY;IACjE,WAAW,CAAC,IAAI,GAAG,IAAI,CAAA;IACvB,WAAW,CAAC,MAAM,GAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAA;AAClD,CAAC","sourcesContent":["import {join} from './path.js'\nimport * as file from './file.js'\nimport * as os from './os.js'\nimport {debug, token, content} from './output.js'\n\ninterface JSON {\n  [key: string]: JSONValue\n}\n\ntype JSONValue = string | number | boolean | JSON | JSONValue[]\n\nexport interface PackageJSON extends JSON {\n  name: string\n  author: string\n  dependencies: {[key: string]: string}\n  devDependencies: {[key: string]: string}\n  resolutions: {[key: string]: string}\n  overrides: {[key: string]: string}\n  scripts: {[key: string]: string}\n}\n\nexport async function readPackageJSON(directory: string): Promise<PackageJSON> {\n  debug(content`Reading and decoding the content from package.json at ${token.path(directory)}...`)\n  const packagePath = join(directory, 'package.json')\n  const packageJSON = JSON.parse(await file.read(packagePath))\n\n  return packageJSON\n}\n\nexport async function writePackageJSON(directory: string, packageJSON: JSON): Promise<void> {\n  debug(content`JSON-encoding and writing content to package.json at ${token.path(directory)}...`)\n  const packagePath = join(directory, 'package.json')\n  await file.write(packagePath, JSON.stringify(packageJSON, null, 2))\n}\n\nexport async function updateAppData(packageJSON: JSON, name: string): Promise<void> {\n  packageJSON.name = name\n  packageJSON.author = (await os.username()) ?? ''\n}\n"]}

package/dist/os.d.ts

@@ -0,0 +1,10 @@
+import { platform as processPlatform } from 'node:process';
+export declare const username: (platform?: typeof processPlatform) => Promise<string | null>;
+/**
+ * Returns the platform and architecture.
+ * @returns {{platform: string, arch: string}} Returns the current platform and architecture.
+ */
+export declare const platformAndArch: (platform?: typeof processPlatform) => {
+    platform: string;
+    arch: string;
+};

package/dist/os.js

@@ -0,0 +1,70 @@
+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}`;
+// 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) => {
+    debug(content `Obtaining user name...`);
+    const environmentVariable = getEnvironmentVariable();
+    if (environmentVariable) {
+        return environmentVariable;
+    }
+    const userInfoUsername = getUsernameFromOsUserInfo();
+    if (userInfoUsername) {
+        return userInfoUsername;
+    }
+    /**
+      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.
+      */
+    try {
+        if (platform === 'win32') {
+            const { stdout } = await execa('whoami');
+            return cleanWindowsCommand(stdout);
+        }
+        const { stdout: userId } = await execa('id', ['-u']);
+        try {
+            const { stdout } = await execa('id', ['-un', userId]);
+            return stdout;
+            // eslint-disable-next-line no-catch-all/no-catch-all,no-empty
+        }
+        catch { }
+        return makeUsernameFromId(userId);
+        // eslint-disable-next-line no-catch-all/no-catch-all
+    }
+    catch {
+        return null;
+    }
+};
+/**
+ * Returns the platform and architecture.
+ * @returns {{platform: string, arch: string}} Returns the current platform and architecture.
+ */
+export const platformAndArch = (platform = processPlatform) => {
+    let arch = osArch();
+    if (arch === 'x64') {
+        arch = 'amd64';
+    }
+    let platformString = platform;
+    if (platform.match(/^win.+/)) {
+        platformString = 'windows';
+    }
+    return { platform: platformString, arch };
+};
+//# sourceMappingURL=os.js.map

package/dist/os.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"os.js","sourceRoot":"","sources":["../src/os.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAE,OAAO,EAAC,MAAM,aAAa,CAAA;AAC1C,OAAO,EAAC,KAAK,EAAC,MAAM,OAAO,CAAA;AAC3B,OAAO,EAAC,QAAQ,IAAI,eAAe,EAAC,MAAM,cAAc,CAAA;AACxD,OAAO,EAAC,QAAQ,IAAI,UAAU,EAAE,IAAI,IAAI,MAAM,EAAC,MAAM,SAAS,CAAA;AAE9D,MAAM,sBAAsB,GAAG,GAAG,EAAE;IAClC,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,CAAA;AAED,MAAM,yBAAyB,GAAG,GAAkB,EAAE;IACpD,IAAI;QACF,OAAO,UAAU,EAAE,CAAC,QAAQ,CAAA;QAC5B,qDAAqD;KACtD;IAAC,MAAM;QACN,OAAO,IAAI,CAAA;KACZ;AACH,CAAC,CAAA;AAED,MAAM,mBAAmB,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;AAEzE,MAAM,kBAAkB,GAAG,CAAC,MAAc,EAAE,EAAE,CAAC,eAAe,MAAM,EAAE,CAAA;AAEtE,4EAA4E;AAC5E,0EAA0E;AAC1E,iEAAiE;AACjE,MAAM,CAAC,MAAM,QAAQ,GAAG,KAAK,EAAE,WAAmC,eAAe,EAA0B,EAAE;IAC3G,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;;QAEC;IACD,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,CAAA;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,WAAmC,eAAe,EAChB,EAAE;IACpC,IAAI,IAAI,GAAG,MAAM,EAAE,CAAA;IACnB,IAAI,IAAI,KAAK,KAAK,EAAE;QAClB,IAAI,GAAG,OAAO,CAAA;KACf;IACD,IAAI,cAAc,GAAG,QAAkB,CAAA;IACvC,IAAI,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE;QAC5B,cAAc,GAAG,SAAS,CAAA;KAC3B;IACD,OAAO,EAAC,QAAQ,EAAE,cAAc,EAAE,IAAI,EAAC,CAAA;AACzC,CAAC,CAAA","sourcesContent":["import {debug, content} from './output.js'\nimport {execa} from 'execa'\nimport {platform as processPlatform} from 'node:process'\nimport {userInfo as osUserInfo, arch as osArch} from 'node:os'\n\nconst getEnvironmentVariable = () => {\n  const {env} = process\n\n  return env.SUDO_USER || env.C9_USER || env.LOGNAME || env.USER || env.LNAME || env.USERNAME\n}\n\nconst 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\nconst cleanWindowsCommand = (value: string) => value.replace(/^.*\\\\/, '')\n\nconst makeUsernameFromId = (userId: string) => `no-username-${userId}`\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.\nexport const username = async (platform: typeof processPlatform = processPlatform): 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\tFirst 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\t*/\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\n/**\n * Returns the platform and architecture.\n * @returns {{platform: string, arch: string}} Returns the current platform and architecture.\n */\nexport const platformAndArch = (\n  platform: typeof processPlatform = processPlatform,\n): {platform: string; arch: string} => {\n  let arch = osArch()\n  if (arch === 'x64') {\n    arch = 'amd64'\n  }\n  let platformString = platform as string\n  if (platform.match(/^win.+/)) {\n    platformString = 'windows'\n  }\n  return {platform: platformString, arch}\n}\n"]}

package/dist/output.d.ts

@@ -0,0 +1,149 @@
+/// <reference types="node" />
+import { Fatal } from './error.js';
+import { PackageManager } from './node/node-package-manager.js';
+import { AbortSignal } from 'abort-controller';
+import { Writable } from 'node:stream';
+export declare function initiateLogging({ logDir, filename, }: {
+    logDir?: string;
+    filename?: string;
+}): void;
+declare enum ContentTokenType {
+    Raw = 0,
+    Command = 1,
+    Json = 2,
+    Path = 3,
+    Link = 4,
+    Heading = 5,
+    SubHeading = 6,
+    Italic = 7,
+    ErrorText = 8,
+    Yellow = 9,
+    Cyan = 10,
+    Magenta = 11,
+    Green = 12
+}
+interface ContentMetadata {
+    link?: string;
+}
+declare class ContentToken {
+    type: ContentTokenType;
+    value: Message;
+    metadata: ContentMetadata;
+    constructor(value: Message, metadata: ContentMetadata | undefined, type: ContentTokenType);
+}
+export declare const token: {
+    raw: (value: Message) => ContentToken;
+    genericShellCommand: (value: Message) => ContentToken;
+    json: (value: any) => ContentToken;
+    path: (value: Message) => ContentToken;
+    link: (value: Message, link: string) => ContentToken;
+    heading: (value: Message) => ContentToken;
+    subheading: (value: Message) => ContentToken;
+    italic: (value: Message) => ContentToken;
+    errorText: (value: Message) => ContentToken;
+    cyan: (value: Message) => ContentToken;
+    yellow: (value: Message) => ContentToken;
+    magenta: (value: Message) => ContentToken;
+    green: (value: Message) => ContentToken;
+    packagejsonScript: (packageManager: PackageManager, scriptName: string, ...scriptArgs: string[]) => ContentToken;
+    successIcon: () => ContentToken;
+    failIcon: () => ContentToken;
+};
+export declare class TokenizedString {
+    value: string;
+    constructor(value: string);
+}
+export declare type Message = string | TokenizedString;
+export declare function content(strings: TemplateStringsArray, ...keys: (ContentToken | string)[]): TokenizedString;
+/** Log levels */
+export declare type LogLevel = 'fatal' | 'error' | 'warn' | 'info' | 'debug' | 'trace' | 'silent';
+/**
+ *
+ * @returns {LogLevel} It returns the log level set by the user.
+ */
+export declare const currentLogLevel: () => LogLevel;
+export declare const shouldOutput: (logLevel: LogLevel) => boolean;
+export declare let collectedLogs: {
+    [key: string]: string[];
+};
+export declare const clearCollectedLogs: () => void;
+/**
+ * Ouputs information to the user. This is akin to "console.log"
+ * Info messages don't get additional formatting.
+ * Note: Info messages are sent through the standard output.
+ * @param content {string} The content to be output to the user.
+ */
+export declare const info: (content: Message) => void;
+/**
+ * Outputs a success message to the user.
+ * Success message receive a special formatting to make them stand out in the console.
+ * Note: Success messages are sent through the standard output.
+ * @param content {string} The content to be output to the user.
+ */
+export declare const success: (content: Message) => void;
+/**
+ * Outputs a completed message to the user.
+ * Completed message receive a special formatting to make them stand out in the console.
+ * Note: Completed messages are sent through the standard output.
+ * @param content {string} The content to be output to the user.
+ */
+export declare const completed: (content: Message) => void;
+/**
+ * Ouputs debug information to the user. By default these output is hidden unless the user calls the CLI with --verbose.
+ * Debug messages don't get additional formatting.
+ * Note: Debug messages are sent through the standard output.
+ * @param content {string} The content to be output to the user.
+ */
+export declare const debug: (content: Message) => void;
+/**
+ * Outputs a warning message to the user.
+ * Warning messages receive a special formatting to make them stand out in the console.
+ * Note: Warning messages are sent through the standard output.
+ * @param content {string} The content to be output to the user.
+ */
+export declare const warn: (content: Message) => void;
+/**
+ * Prints a new line in the terminal.
+ */
+export declare const newline: () => void;
+/**
+ * Formats and outputs a fatal error.
+ * Note: This API is not intended to be used internally. If you want to
+ * abort the execution due to an error, raise a fatal error and let the
+ * error handler handle and format it.
+ * @param content {Fatal} The fatal error to be output.
+ */
+export declare const error: (content: Fatal) => Promise<void>;
+export declare function stringifyMessage(message: Message): string;
+export interface OutputProcess {
+    /** The prefix to include in the logs
+     *   [vite] Output coming from Vite
+     */
+    prefix: string;
+    /**
+     * A callback to invoke the process. stdout and stderr should be used
+     * to send standard output and error data that gets formatted with the
+     * right prefix.
+     */
+    action: (stdout: Writable, stderr: Writable, signal: AbortSignal) => Promise<void>;
+}
+/**
+ * Use this function when you have multiple concurrent processes that send data events
+ * and we need to output them ensuring that they can visually differenciated by the user.
+ *
+ * @param processes {OutputProcess[]} A list of processes to run concurrently.
+ */
+export declare function concurrent(processes: OutputProcess[], callback?: ((signal: AbortSignal) => void) | undefined): Promise<void>;
+export declare function logFileExists(): boolean;
+export declare function logToFile(message: string, logLevel: string): void;
+export declare function unstyled(message: string): string;
+export declare function shouldDisplayColors(): boolean;
+export declare function pageLogs(): Promise<void>;
+/**
+ *
+ * @param packageManager {PackageManager} The package manager that is being used.
+ * @param version {string} The version to update to
+ * @returns {te}
+ */
+export declare function getOutputUpdateCLIReminder(packageManager: PackageManager, version: string): string;
+export {};