@shopify/cli-kit 3.0.24 → 3.0.27

package/dist/node/ruby.js

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

package/dist/node/ruby.js.map

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

package/dist/npm.d.ts

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

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,142 @@
+/// <reference types="node" />
+import { Fatal } from './error.js';
+import { DependencyManager } from './dependency.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: (dependencyManager: DependencyManager, 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>;
+export {};