@shopify/cli-kit 3.16.3 → 3.18.0

package/dist/node/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/node/cli.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAQH,SAAS,yBAAyB,CAAC,OAA2C;IAC5E;;;;OAIG;IACH,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE;QACtC,OAAO,CAAC,GAAG,CAAC,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,GAAG,CAAA;KAC7C;IACD,IAAI,OAAO,CAAC,WAAW,EAAE;QACvB,OAAO,CAAC,GAAG,CAAC,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,aAAa,CAAA;KAC3E;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,OAAsB;IACjD,yBAAyB,CAAC,OAAO,CAAC,CAAA;IAClC;;;;OAIG;IACH,MAAM,EAAC,YAAY,EAAC,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,CAAA;IACzD,MAAM,EAAC,aAAa,EAAC,GAAG,MAAM,MAAM,CAAC,yBAAyB,CAAC,CAAA;IAC/D,MAAM,EAAC,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAC,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,CAAA;IAE1D,IAAI,aAAa,EAAE,EAAE;QACnB,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAA;KACtB;IAED,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAA;AACnE,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,OAAsB;IACvD,yBAAyB,CAAC,OAAO,CAAC,CAAA;IAElC,MAAM,EAAC,wBAAwB,EAAC,GAAG,MAAM,MAAM,CAAC,2BAA2B,CAAC,CAAA;IAC5E,MAAM,EAAC,eAAe,EAAC,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,CAAA;IAEpD,MAAM,WAAW,GAAG,MAAM,wBAAwB,CAAC,eAAe,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAA;IACtF,8DAA8D;IAC9D,MAAM,WAAW,GAAI,WAAW,CAAC,OAAe,CAAC,IAAc,CAAA;IAC/D,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAA;IACxD,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAA;IACvE,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE;QACpB,MAAM,SAAS,GACb,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,yBAAyB,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QACtG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,EAAE,MAAM,CAAC,CAAA;KAC1C;IACD,MAAM,MAAM,CAAC,OAAO,CAAC,CAAA;AACvB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,QAAgB;IAC1D,MAAM,EAAC,QAAQ,EAAC,GAAG,MAAM,MAAM,CAAC,6BAA6B,CAAC,CAAA;IAC9D,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,iBAAiB,CAAC,CAAA;IACjD,MAAM,EAAC,IAAI,EAAC,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,CAAA;IACzC,MAAM,EAAC,IAAI,EAAC,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,CAAA;IAE3C,oFAAoF;IACpF,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;QAAE,OAAO,KAAK,CAAA;IAElG,8EAA8E;IAC9E,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,oBAAoB,CAAC,eAAe,CAAC,CAAC;QAAE,OAAO,KAAK,CAAA;IAE/F,wFAAwF;IACxF,IAAI,OAAO,CAAC,GAAG,CAAC,qBAAqB;QAAE,OAAO,KAAK,CAAA;IAEnD,MAAM,UAAU,GAAG,MAAM,eAAe,EAAE,CAAA;IAC1C,IAAI,CAAC,UAAU;QAAE,OAAO,KAAK,CAAA;IAE7B,MAAM,qBAAqB,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IAC3E,IAAI,qBAAqB,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IACpD,IAAI;QACF,MAAM,IAAI,CAAC,qBAAqB,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;YAC5E,KAAK,EAAE,SAAS;YAChB,GAAG,EAAE,EAAC,CAAC,SAAS,CAAC,OAAO,CAAC,oBAAoB,CAAC,eAAe,CAAC,EAAE,GAAG,EAAC;SACrE,CAAC,CAAA;QACF,yFAAyF;KAC1F;IAAC,OAAO,YAAiB,EAAE;QAC1B,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;KACpC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAaD,MAAM,CAAC,KAAK,UAAU,eAAe;IACnC,MAAM,EAAC,aAAa,EAAC,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,CAAA;IAEpD,IAAI,aAAa,GAAG,EAAE,CAAA;IACtB,IAAI,eAAe,GAAgB,EAAE,CAAA;IACrC,IAAI;QACF,aAAa,GAAG,MAAM,aAAa,CAAC,KAAK,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAA;QACpF,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAA;QAC3C,qDAAqD;KACtD;IAAC,OAAO,GAAG,EAAE;QACZ,OAAM;KACP;IACD,MAAM,gBAAgB,GAAG;QACvB,GAAG,eAAe,CAAC,gBAAgB;QACnC,GAAG,eAAe,CAAC,eAAe;QAClC,GAAG,eAAe,CAAC,YAAY;KAChC,CAAA;IACD,OAAO,gBAAgB,CAAC,cAAc,CAAC,CAAA;AACzC,CAAC;AAED,eAAe,MAAM,CAAA","sourcesContent":["/**\n * IMPORTANT NOTE: Imports in this module are dynamic to ensure that \"setupEnvironmentVariables\" can dynamically\n * set the DEBUG environment variable before the 'debug' package sets up its configuration when modules\n * are loaded statically.\n */\n\ninterface RunCLIOptions {\n  /** The value of import.meta.url of the CLI executable module */\n  moduleURL: string\n  development: boolean\n}\n\nfunction setupEnvironmentVariables(options: Pick<RunCLIOptions, 'development'>) {\n  /**\n   * By setting DEBUG=* when --verbose is passed we are increasing the\n   * verbosity of oclif. Oclif uses debug (https://www.npmjs.com/package/debug)\n   * for logging, and it's configured through the DEBUG= environment variable.\n   */\n  if (process.argv.includes('--verbose')) {\n    process.env.DEBUG = process.env.DEBUG ?? '*'\n  }\n  if (options.development) {\n    process.env.SHOPIFY_CLI_ENV = process.env.SHOPIFY_CLI_ENV ?? 'development'\n  }\n}\n\n/**\n * A function that abstracts away setting up the environment and running\n * a CLI\n * @param options {RunCLIOptions} Options.\n */\nexport async function runCLI(options: RunCLIOptions) {\n  setupEnvironmentVariables(options)\n  /**\n   * These imports need to be dynamic because if they are static\n   * they are loaded before se set the DEBUG=* environment variable\n   * and therefore it has no effect.\n   */\n  const {errorHandler} = await import('./error-handler.js')\n  const {isDevelopment} = await import('../environment/local.js')\n  const {run, settings, flush} = await import('@oclif/core')\n\n  if (isDevelopment()) {\n    settings.debug = true\n  }\n\n  run(undefined, options.moduleURL).then(flush).catch(errorHandler)\n}\n\n/**\n * A function for create-x CLIs that automatically runs the \"init\" command.\n * @param options\n */\nexport async function runCreateCLI(options: RunCLIOptions) {\n  setupEnvironmentVariables(options)\n\n  const {findUpAndReadPackageJson} = await import('./node-package-manager.js')\n  const {moduleDirectory} = await import('../path.js')\n\n  const packageJson = await findUpAndReadPackageJson(moduleDirectory(options.moduleURL))\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  const packageName = (packageJson.content as any).name as string\n  const name = packageName.replace('@shopify/create-', '')\n  const initIndex = process.argv.findIndex((arg) => arg.includes('init'))\n  if (initIndex === -1) {\n    const initIndex =\n      process.argv.findIndex((arg) => arg.match(new RegExp(`bin(\\\\/|\\\\\\\\)+(create-${name}|dev|run)`))) + 1\n    process.argv.splice(initIndex, 0, 'init')\n  }\n  await runCLI(options)\n}\n\nexport async function useLocalCLIIfDetected(filepath: string): Promise<boolean> {\n  const {isTruthy} = await import('../environment/utilities.js')\n  const constants = await import('../constants.js')\n  const {join} = await import('../path.js')\n  const {exec} = await import('../system.js')\n\n  // Temporary flag while we test out this feature and ensure it won't break anything!\n  if (!isTruthy(process.env[constants.default.environmentVariables.enableCliRedirect])) return false\n\n  // Setting an env variable in the child process prevents accidental recursion.\n  if (isTruthy(process.env[constants.default.environmentVariables.skipCliRedirect])) return false\n\n  // If already running via package manager, we can assume it's running correctly already.\n  if (process.env.npm_config_user_agent) return false\n\n  const cliPackage = await localCliPackage()\n  if (!cliPackage) return false\n\n  const correctExecutablePath = join(cliPackage.path, cliPackage.bin.shopify)\n  if (correctExecutablePath === filepath) return false\n  try {\n    await exec(correctExecutablePath, process.argv.slice(2, process.argv.length), {\n      stdio: 'inherit',\n      env: {[constants.default.environmentVariables.skipCliRedirect]: '1'},\n    })\n    // eslint-disable-next-line no-catch-all/no-catch-all, @typescript-eslint/no-explicit-any\n  } catch (processError: any) {\n    process.exit(processError.exitCode)\n  }\n  return true\n}\n\ninterface CliPackageInfo {\n  path: string\n  bin: {shopify: string}\n}\n\ninterface PackageJSON {\n  dependencies?: {[packageName: string]: CliPackageInfo}\n  devDependencies?: {[packageName: string]: CliPackageInfo}\n  peerDependencies?: {[packageName: string]: CliPackageInfo}\n}\n\nexport async function localCliPackage(): Promise<CliPackageInfo | undefined> {\n  const {captureOutput} = await import('../system.js')\n\n  let npmListOutput = ''\n  let localShopifyCLI: PackageJSON = {}\n  try {\n    npmListOutput = await captureOutput('npm', ['list', '@shopify/cli', '--json', '-l'])\n    localShopifyCLI = JSON.parse(npmListOutput)\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch (err) {\n    return\n  }\n  const dependenciesList = {\n    ...localShopifyCLI.peerDependencies,\n    ...localShopifyCLI.devDependencies,\n    ...localShopifyCLI.dependencies,\n  }\n  return dependenciesList['@shopify/cli']\n}\n\nexport default runCLI\n"]}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/node/cli.ts"],"names":[],"mappings":"AAWA,SAAS,yBAAyB,CAAC,OAA2C;IAC5E;;;;OAIG;IACH,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE;QACtC,OAAO,CAAC,GAAG,CAAC,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,GAAG,CAAA;KAC7C;IACD,IAAI,OAAO,CAAC,WAAW,EAAE;QACvB,OAAO,CAAC,GAAG,CAAC,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,aAAa,CAAA;KAC3E;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,OAAsB;IACjD,yBAAyB,CAAC,OAAO,CAAC,CAAA;IAClC;;;;OAIG;IACH,MAAM,EAAC,YAAY,EAAC,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,CAAA;IACzD,MAAM,EAAC,aAAa,EAAC,GAAG,MAAM,MAAM,CAAC,yBAAyB,CAAC,CAAA;IAC/D,MAAM,EAAC,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAC,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,CAAA;IAE1D,IAAI,aAAa,EAAE,EAAE;QACnB,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAA;KACtB;IAED,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAA;AACnE,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,OAAsB;IACvD,yBAAyB,CAAC,OAAO,CAAC,CAAA;IAElC,MAAM,EAAC,wBAAwB,EAAC,GAAG,MAAM,MAAM,CAAC,2BAA2B,CAAC,CAAA;IAC5E,MAAM,EAAC,eAAe,EAAC,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,CAAA;IAEpD,MAAM,WAAW,GAAG,MAAM,wBAAwB,CAAC,eAAe,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAA;IACtF,8DAA8D;IAC9D,MAAM,WAAW,GAAI,WAAW,CAAC,OAAe,CAAC,IAAc,CAAA;IAC/D,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAA;IACxD,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAA;IACvE,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE;QACpB,MAAM,SAAS,GACb,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,yBAAyB,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QACtG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,EAAE,MAAM,CAAC,CAAA;KAC1C;IACD,MAAM,MAAM,CAAC,OAAO,CAAC,CAAA;AACvB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,QAAgB;IAC1D,MAAM,EAAC,QAAQ,EAAC,GAAG,MAAM,MAAM,CAAC,6BAA6B,CAAC,CAAA;IAC9D,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,iBAAiB,CAAC,CAAA;IACjD,MAAM,EAAC,IAAI,EAAC,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,CAAA;IACzC,MAAM,EAAC,IAAI,EAAC,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,CAAA;IAE3C,oFAAoF;IACpF,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;QAAE,OAAO,KAAK,CAAA;IAElG,8EAA8E;IAC9E,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,oBAAoB,CAAC,eAAe,CAAC,CAAC;QAAE,OAAO,KAAK,CAAA;IAE/F,wFAAwF;IACxF,IAAI,OAAO,CAAC,GAAG,CAAC,qBAAqB;QAAE,OAAO,KAAK,CAAA;IAEnD,MAAM,UAAU,GAAG,MAAM,eAAe,EAAE,CAAA;IAC1C,IAAI,CAAC,UAAU;QAAE,OAAO,KAAK,CAAA;IAE7B,MAAM,qBAAqB,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IAC3E,IAAI,qBAAqB,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IACpD,IAAI;QACF,MAAM,IAAI,CAAC,qBAAqB,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;YAC5E,KAAK,EAAE,SAAS;YAChB,GAAG,EAAE,EAAC,CAAC,SAAS,CAAC,OAAO,CAAC,oBAAoB,CAAC,eAAe,CAAC,EAAE,GAAG,EAAC;SACrE,CAAC,CAAA;QACF,yFAAyF;KAC1F;IAAC,OAAO,YAAiB,EAAE;QAC1B,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;KACpC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAaD,MAAM,CAAC,KAAK,UAAU,eAAe;IACnC,MAAM,EAAC,aAAa,EAAC,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,CAAA;IAEpD,IAAI,aAAa,GAAG,EAAE,CAAA;IACtB,IAAI,eAAe,GAAgB,EAAE,CAAA;IACrC,IAAI;QACF,aAAa,GAAG,MAAM,aAAa,CAAC,KAAK,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAA;QACpF,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAA;QAC3C,qDAAqD;KACtD;IAAC,OAAO,GAAG,EAAE;QACZ,OAAM;KACP;IACD,MAAM,gBAAgB,GAAG;QACvB,GAAG,eAAe,CAAC,gBAAgB;QACnC,GAAG,eAAe,CAAC,eAAe;QAClC,GAAG,eAAe,CAAC,YAAY;KAChC,CAAA;IACD,OAAO,gBAAgB,CAAC,cAAc,CAAC,CAAA;AACzC,CAAC;AAED,eAAe,MAAM,CAAA","sourcesContent":["/**\n * IMPORTANT NOTE: Imports in this module are dynamic to ensure that \"setupEnvironmentVariables\" can dynamically\n * set the DEBUG environment variable before the 'debug' package sets up its configuration when modules\n * are loaded statically.\n */\ninterface RunCLIOptions {\n  /** The value of import.meta.url of the CLI executable module */\n  moduleURL: string\n  development: boolean\n}\n\nfunction setupEnvironmentVariables(options: Pick<RunCLIOptions, 'development'>) {\n  /**\n   * By setting DEBUG=* when --verbose is passed we are increasing the\n   * verbosity of oclif. Oclif uses debug (https://www.npmjs.com/package/debug)\n   * for logging, and it's configured through the DEBUG= environment variable.\n   */\n  if (process.argv.includes('--verbose')) {\n    process.env.DEBUG = process.env.DEBUG ?? '*'\n  }\n  if (options.development) {\n    process.env.SHOPIFY_CLI_ENV = process.env.SHOPIFY_CLI_ENV ?? 'development'\n  }\n}\n\n/**\n * A function that abstracts away setting up the environment and running\n * a CLI\n * @param options - Options.\n */\nexport async function runCLI(options: RunCLIOptions) {\n  setupEnvironmentVariables(options)\n  /**\n   * These imports need to be dynamic because if they are static\n   * they are loaded before we set the DEBUG=* environment variable\n   * and therefore it has no effect.\n   */\n  const {errorHandler} = await import('./error-handler.js')\n  const {isDevelopment} = await import('../environment/local.js')\n  const {run, settings, flush} = await import('@oclif/core')\n\n  if (isDevelopment()) {\n    settings.debug = true\n  }\n\n  run(undefined, options.moduleURL).then(flush).catch(errorHandler)\n}\n\n/**\n * A function for create-x CLIs that automatically runs the \"init\" command.\n */\nexport async function runCreateCLI(options: RunCLIOptions) {\n  setupEnvironmentVariables(options)\n\n  const {findUpAndReadPackageJson} = await import('./node-package-manager.js')\n  const {moduleDirectory} = await import('../path.js')\n\n  const packageJson = await findUpAndReadPackageJson(moduleDirectory(options.moduleURL))\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  const packageName = (packageJson.content as any).name as string\n  const name = packageName.replace('@shopify/create-', '')\n  const initIndex = process.argv.findIndex((arg) => arg.includes('init'))\n  if (initIndex === -1) {\n    const initIndex =\n      process.argv.findIndex((arg) => arg.match(new RegExp(`bin(\\\\/|\\\\\\\\)+(create-${name}|dev|run)`))) + 1\n    process.argv.splice(initIndex, 0, 'init')\n  }\n  await runCLI(options)\n}\n\nexport async function useLocalCLIIfDetected(filepath: string): Promise<boolean> {\n  const {isTruthy} = await import('../environment/utilities.js')\n  const constants = await import('../constants.js')\n  const {join} = await import('../path.js')\n  const {exec} = await import('../system.js')\n\n  // Temporary flag while we test out this feature and ensure it won't break anything!\n  if (!isTruthy(process.env[constants.default.environmentVariables.enableCliRedirect])) return false\n\n  // Setting an env variable in the child process prevents accidental recursion.\n  if (isTruthy(process.env[constants.default.environmentVariables.skipCliRedirect])) return false\n\n  // If already running via package manager, we can assume it's running correctly already.\n  if (process.env.npm_config_user_agent) return false\n\n  const cliPackage = await localCliPackage()\n  if (!cliPackage) return false\n\n  const correctExecutablePath = join(cliPackage.path, cliPackage.bin.shopify)\n  if (correctExecutablePath === filepath) return false\n  try {\n    await exec(correctExecutablePath, process.argv.slice(2, process.argv.length), {\n      stdio: 'inherit',\n      env: {[constants.default.environmentVariables.skipCliRedirect]: '1'},\n    })\n    // eslint-disable-next-line no-catch-all/no-catch-all, @typescript-eslint/no-explicit-any\n  } catch (processError: any) {\n    process.exit(processError.exitCode)\n  }\n  return true\n}\n\ninterface CliPackageInfo {\n  path: string\n  bin: {shopify: string}\n}\n\ninterface PackageJSON {\n  dependencies?: {[packageName: string]: CliPackageInfo}\n  devDependencies?: {[packageName: string]: CliPackageInfo}\n  peerDependencies?: {[packageName: string]: CliPackageInfo}\n}\n\nexport async function localCliPackage(): Promise<CliPackageInfo | undefined> {\n  const {captureOutput} = await import('../system.js')\n\n  let npmListOutput = ''\n  let localShopifyCLI: PackageJSON = {}\n  try {\n    npmListOutput = await captureOutput('npm', ['list', '@shopify/cli', '--json', '-l'])\n    localShopifyCLI = JSON.parse(npmListOutput)\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch (err) {\n    return\n  }\n  const dependenciesList = {\n    ...localShopifyCLI.peerDependencies,\n    ...localShopifyCLI.devDependencies,\n    ...localShopifyCLI.dependencies,\n  }\n  return dependenciesList['@shopify/cli']\n}\n\nexport default runCLI\n"]}

package/dist/node/colors.d.ts

@@ -1 +1,2 @@
-export declare const colors: any;
+import chalk from 'chalk';
+export { chalk as colors };

package/dist/node/colors.js

@@ -1,8 +1,3 @@
-import { createRequire } from 'module';
-/**
- * ansi-colors is a commonjs dependency that can be imported as a module.
- * This file is a wrapper to require and export ansi-colors.
- */
-const require = createRequire(import.meta.url);
-export const colors = require('ansi-colors');
+import chalk from 'chalk';
+export { chalk as colors };
 //# sourceMappingURL=colors.js.map

package/dist/node/colors.js.map

@@ -1 +1 @@
-{"version":3,"file":"colors.js","sourceRoot":"","sources":["../../src/node/colors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,QAAQ,CAAA;AAEpC;;;GAGG;AACH,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAC9C,MAAM,CAAC,MAAM,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAA","sourcesContent":["import {createRequire} from 'module'\n\n/**\n * ansi-colors is a commonjs dependency that can be imported as a module.\n * This file is a wrapper to require and export ansi-colors.\n */\nconst require = createRequire(import.meta.url)\nexport const colors = require('ansi-colors')\n"]}
+{"version":3,"file":"colors.js","sourceRoot":"","sources":["../../src/node/colors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,OAAO,EAAC,KAAK,IAAI,MAAM,EAAC,CAAA","sourcesContent":["import chalk from 'chalk'\n\nexport {chalk as colors}\n"]}

package/dist/node/dot-env.d.ts

@@ -1,8 +1,8 @@
 import { Abort } from '../error.js';
 /**
  * Error that's thrown when the .env is not found.
- * @param path {string} Path to the .env file.
- * @returns {Abort} An abort error.
+ * @param path - Path to the .env file.
+ * @returns An abort error.
  */
 export declare const DotEnvNotFoundError: (path: string) => Abort;
 /**
@@ -22,20 +22,20 @@ export interface DotEnvFile {
 }
 /**
  * Reads and parses a .env file.
- * @param path {string} Path to the .env file
- * @returns {Promise<DotEnvFile>} An in-memory representation of the .env file.
+ * @param path - Path to the .env file
+ * @returns An in-memory representation of the .env file.
  */
 export declare function readAndParseDotEnv(path: string): Promise<DotEnvFile>;
 /**
  * Writes a .env file to disk.
- * @param file {DotEnvFile} .env file to be written.
+ * @param file - .env file to be written.
  */
 export declare function writeDotEnv(file: DotEnvFile): Promise<void>;
 /**
  * Given an .env file content, generates a new one with new values
  * without removing already existing lines.
- * @param envFileContent {string | null} .env file contents.
- * @param updatedValues {[key: string]: string}} object containing new env variables values.
+ * @param envFileContent - .env file contents.
+ * @param updatedValues - object containing new env variables values.
  */
 export declare function patchEnvFile(envFileContent: string | null, updatedValues: {
     [key: string]: string | undefined;

package/dist/node/dot-env.js

@@ -4,16 +4,16 @@ import { debug, content as outputContent, token } from '../output.js';
 import { parse, stringify } from 'envfile';
 /**
  * Error that's thrown when the .env is not found.
- * @param path {string} Path to the .env file.
- * @returns {Abort} An abort error.
+ * @param path - Path to the .env file.
+ * @returns An abort error.
  */
 export const DotEnvNotFoundError = (path) => {
     return new Abort(`The environment file at ${path} does not exist.`);
 };
 /**
  * Reads and parses a .env file.
- * @param path {string} Path to the .env file
- * @returns {Promise<DotEnvFile>} An in-memory representation of the .env file.
+ * @param path - Path to the .env file
+ * @returns An in-memory representation of the .env file.
  */
 export async function readAndParseDotEnv(path) {
     debug(outputContent `Reading the .env file at ${token.path(path)}`);
@@ -28,7 +28,7 @@ export async function readAndParseDotEnv(path) {
 }
 /**
  * Writes a .env file to disk.
- * @param file {DotEnvFile} .env file to be written.
+ * @param file - .env file to be written.
  */
 export async function writeDotEnv(file) {
     await writeFile(file.path, stringify(file.variables));
@@ -36,8 +36,8 @@ export async function writeDotEnv(file) {
 /**
  * Given an .env file content, generates a new one with new values
  * without removing already existing lines.
- * @param envFileContent {string | null} .env file contents.
- * @param updatedValues {[key: string]: string}} object containing new env variables values.
+ * @param envFileContent - .env file contents.
+ * @param updatedValues - object containing new env variables values.
  */
 export function patchEnvFile(envFileContent, updatedValues) {
     const outputLines = [];

package/dist/node/dot-env.js.map

@@ -1 +1 @@
-{"version":3,"file":"dot-env.js","sourceRoot":"","sources":["../../src/node/dot-env.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAC,MAAM,aAAa,CAAA;AACjC,OAAO,EAAC,MAAM,EAAE,IAAI,IAAI,QAAQ,EAAE,KAAK,IAAI,SAAS,EAAC,MAAM,YAAY,CAAA;AACvE,OAAO,EAAC,KAAK,EAAE,OAAO,IAAI,aAAa,EAAE,KAAK,EAAC,MAAM,cAAc,CAAA;AACnE,OAAO,EAAC,KAAK,EAAE,SAAS,EAAC,MAAM,SAAS,CAAA;AAExC;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,IAAY,EAAE,EAAE;IAClD,OAAO,IAAI,KAAK,CAAC,2BAA2B,IAAI,kBAAkB,CAAC,CAAA;AACrE,CAAC,CAAA;AAgBD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,IAAY;IACnD,KAAK,CAAC,aAAa,CAAA,4BAA4B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAClE,IAAI,CAAC,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE;QACzB,MAAM,mBAAmB,CAAC,IAAI,CAAC,CAAA;KAChC;IACD,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,CAAA;IACpC,OAAO;QACL,IAAI;QACJ,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC;KAC1B,CAAA;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,IAAgB;IAChD,MAAM,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;AACvD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAC1B,cAA6B,EAC7B,aAAkD;IAElD,MAAM,WAAW,GAAa,EAAE,CAAA;IAChC,MAAM,KAAK,GAAG,cAAc,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAEvE,MAAM,kBAAkB,GAAa,EAAE,CAAA;IAEvC,MAAM,MAAM,GAAG,CAAC,GAAW,EAAE,KAAc,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,KAAK,EAAE,CAAA;IAEjE,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;QACxB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAA;QAC/C,IAAI,WAAW,GAAG,IAAI,CAAA;QAEtB,IAAI,KAAK,EAAE;YACT,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC,IAAI,EAAE,CAAA;YAC5B,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,CAAA;YACnC,IAAI,QAAQ,EAAE;gBACZ,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;gBAC5B,WAAW,GAAG,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;aACpC;SACF;QAED,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;KAC9B;IAED,KAAK,MAAM,CAAC,QAAQ,EAAE,YAAY,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;QACpE,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;YAC1C,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAA;SACjD;KACF;IAED,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AAC/B,CAAC","sourcesContent":["import {Abort} from '../error.js'\nimport {exists, read as readFile, write as writeFile} from '../file.js'\nimport {debug, content as outputContent, token} from '../output.js'\nimport {parse, stringify} from 'envfile'\n\n/**\n * Error that's thrown when the .env is not found.\n * @param path {string} Path to the .env file.\n * @returns {Abort} An abort error.\n */\nexport const DotEnvNotFoundError = (path: string) => {\n  return new Abort(`The environment file at ${path} does not exist.`)\n}\n\n/**\n * This interface represents a .env file.\n */\nexport interface DotEnvFile {\n  /**\n   * Path to the .env file.\n   */\n  path: string\n  /**\n   * Variables of the .env file.\n   */\n  variables: {[name: string]: string}\n}\n\n/**\n * Reads and parses a .env file.\n * @param path {string} Path to the .env file\n * @returns {Promise<DotEnvFile>} An in-memory representation of the .env file.\n */\nexport async function readAndParseDotEnv(path: string): Promise<DotEnvFile> {\n  debug(outputContent`Reading the .env file at ${token.path(path)}`)\n  if (!(await exists(path))) {\n    throw DotEnvNotFoundError(path)\n  }\n  const content = await readFile(path)\n  return {\n    path,\n    variables: parse(content),\n  }\n}\n\n/**\n * Writes a .env file to disk.\n * @param file {DotEnvFile} .env file to be written.\n */\nexport async function writeDotEnv(file: DotEnvFile) {\n  await writeFile(file.path, stringify(file.variables))\n}\n\n/**\n * Given an .env file content, generates a new one with new values\n * without removing already existing lines.\n * @param envFileContent {string | null} .env file contents.\n * @param updatedValues {[key: string]: string}} object containing new env variables values.\n */\nexport function patchEnvFile(\n  envFileContent: string | null,\n  updatedValues: {[key: string]: string | undefined},\n): string {\n  const outputLines: string[] = []\n  const lines = envFileContent === null ? [] : envFileContent.split('\\n')\n\n  const alreadyPresentKeys: string[] = []\n\n  const toLine = (key: string, value?: string) => `${key}=${value}`\n\n  for (const line of lines) {\n    const match = line.match(/^([^=:#]+?)[=:](.*)/)\n    let lineToWrite = line\n\n    if (match) {\n      const key = match[1]!.trim()\n      const newValue = updatedValues[key]\n      if (newValue) {\n        alreadyPresentKeys.push(key)\n        lineToWrite = toLine(key, newValue)\n      }\n    }\n\n    outputLines.push(lineToWrite)\n  }\n\n  for (const [patchKey, updatedValue] of Object.entries(updatedValues)) {\n    if (!alreadyPresentKeys.includes(patchKey)) {\n      outputLines.push(toLine(patchKey, updatedValue))\n    }\n  }\n\n  return outputLines.join('\\n')\n}\n"]}
+{"version":3,"file":"dot-env.js","sourceRoot":"","sources":["../../src/node/dot-env.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAC,MAAM,aAAa,CAAA;AACjC,OAAO,EAAC,MAAM,EAAE,IAAI,IAAI,QAAQ,EAAE,KAAK,IAAI,SAAS,EAAC,MAAM,YAAY,CAAA;AACvE,OAAO,EAAC,KAAK,EAAE,OAAO,IAAI,aAAa,EAAE,KAAK,EAAC,MAAM,cAAc,CAAA;AACnE,OAAO,EAAC,KAAK,EAAE,SAAS,EAAC,MAAM,SAAS,CAAA;AAExC;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,IAAY,EAAE,EAAE;IAClD,OAAO,IAAI,KAAK,CAAC,2BAA2B,IAAI,kBAAkB,CAAC,CAAA;AACrE,CAAC,CAAA;AAgBD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,IAAY;IACnD,KAAK,CAAC,aAAa,CAAA,4BAA4B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAClE,IAAI,CAAC,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE;QACzB,MAAM,mBAAmB,CAAC,IAAI,CAAC,CAAA;KAChC;IACD,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,CAAA;IACpC,OAAO;QACL,IAAI;QACJ,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC;KAC1B,CAAA;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,IAAgB;IAChD,MAAM,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;AACvD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAC1B,cAA6B,EAC7B,aAAkD;IAElD,MAAM,WAAW,GAAa,EAAE,CAAA;IAChC,MAAM,KAAK,GAAG,cAAc,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAEvE,MAAM,kBAAkB,GAAa,EAAE,CAAA;IAEvC,MAAM,MAAM,GAAG,CAAC,GAAW,EAAE,KAAc,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,KAAK,EAAE,CAAA;IAEjE,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;QACxB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAA;QAC/C,IAAI,WAAW,GAAG,IAAI,CAAA;QAEtB,IAAI,KAAK,EAAE;YACT,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC,IAAI,EAAE,CAAA;YAC5B,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,CAAA;YACnC,IAAI,QAAQ,EAAE;gBACZ,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;gBAC5B,WAAW,GAAG,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;aACpC;SACF;QAED,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;KAC9B;IAED,KAAK,MAAM,CAAC,QAAQ,EAAE,YAAY,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;QACpE,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;YAC1C,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAA;SACjD;KACF;IAED,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AAC/B,CAAC","sourcesContent":["import {Abort} from '../error.js'\nimport {exists, read as readFile, write as writeFile} from '../file.js'\nimport {debug, content as outputContent, token} from '../output.js'\nimport {parse, stringify} from 'envfile'\n\n/**\n * Error that's thrown when the .env is not found.\n * @param path - Path to the .env file.\n * @returns An abort error.\n */\nexport const DotEnvNotFoundError = (path: string) => {\n  return new Abort(`The environment file at ${path} does not exist.`)\n}\n\n/**\n * This interface represents a .env file.\n */\nexport interface DotEnvFile {\n  /**\n   * Path to the .env file.\n   */\n  path: string\n  /**\n   * Variables of the .env file.\n   */\n  variables: {[name: string]: string}\n}\n\n/**\n * Reads and parses a .env file.\n * @param path - Path to the .env file\n * @returns An in-memory representation of the .env file.\n */\nexport async function readAndParseDotEnv(path: string): Promise<DotEnvFile> {\n  debug(outputContent`Reading the .env file at ${token.path(path)}`)\n  if (!(await exists(path))) {\n    throw DotEnvNotFoundError(path)\n  }\n  const content = await readFile(path)\n  return {\n    path,\n    variables: parse(content),\n  }\n}\n\n/**\n * Writes a .env file to disk.\n * @param file - .env file to be written.\n */\nexport async function writeDotEnv(file: DotEnvFile) {\n  await writeFile(file.path, stringify(file.variables))\n}\n\n/**\n * Given an .env file content, generates a new one with new values\n * without removing already existing lines.\n * @param envFileContent - .env file contents.\n * @param updatedValues - object containing new env variables values.\n */\nexport function patchEnvFile(\n  envFileContent: string | null,\n  updatedValues: {[key: string]: string | undefined},\n): string {\n  const outputLines: string[] = []\n  const lines = envFileContent === null ? [] : envFileContent.split('\\n')\n\n  const alreadyPresentKeys: string[] = []\n\n  const toLine = (key: string, value?: string) => `${key}=${value}`\n\n  for (const line of lines) {\n    const match = line.match(/^([^=:#]+?)[=:](.*)/)\n    let lineToWrite = line\n\n    if (match) {\n      const key = match[1]!.trim()\n      const newValue = updatedValues[key]\n      if (newValue) {\n        alreadyPresentKeys.push(key)\n        lineToWrite = toLine(key, newValue)\n      }\n    }\n\n    outputLines.push(lineToWrite)\n  }\n\n  for (const [patchKey, updatedValue] of Object.entries(updatedValues)) {\n    if (!alreadyPresentKeys.includes(patchKey)) {\n      outputLines.push(toLine(patchKey, updatedValue))\n    }\n  }\n\n  return outputLines.join('\\n')\n}\n"]}

package/dist/node/framework.d.ts

@@ -2,7 +2,7 @@
  * Tries to identify the using of a framework analyzing the existence and/or content of different files inside a
  * specific directory.
  *
- * @param {string} rootDirectory - Directory from which the files required for each framework are searched
- * @returns {string} The name of the framework used or 'unknown' otherwise
+ * @param rootDirectory - Directory from which the files required for each framework are searched
+ * @returns The name of the framework used or 'unknown' otherwise
  */
 export declare function resolveFramework(rootDirectory: string): Promise<string>;

package/dist/node/framework.js

@@ -102,8 +102,8 @@ const frameworks = [
  * Tries to identify the using of a framework analyzing the existence and/or content of different files inside a
  * specific directory.
  *
- * @param {string} rootDirectory - Directory from which the files required for each framework are searched
- * @returns {string} The name of the framework used or 'unknown' otherwise
+ * @param rootDirectory - Directory from which the files required for each framework are searched
+ * @returns The name of the framework used or 'unknown' otherwise
  */
 export async function resolveFramework(rootDirectory) {
     const fwConfigFiles = {};

package/dist/node/framework.js.map

@@ -1 +1 @@
-{"version":3,"file":"framework.js","sourceRoot":"","sources":["../../src/node/framework.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,IAAI,QAAQ,EAAC,MAAM,YAAY,CAAA;AAC3C,OAAO,EAAC,UAAU,EAAE,YAAY,EAAC,MAAM,SAAS,CAAA;AAuChD,MAAM,UAAU,GAAgB;IAC9B;QACE,IAAI,EAAE,OAAO;QACb,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,cAAc;oBACpB,YAAY,EAAE,sEAAsE;iBACrF;gBACD;oBACE,IAAI,EAAE,cAAc;oBACpB,YAAY,EAAE,4DAA4D;iBAC3E;aACF;SACF;KACF;IACD;QACE,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,cAAc;oBACpB,YAAY,EAAE,2DAA2D;iBAC1E;gBACD;oBACE,IAAI,EAAE,cAAc;oBACpB,YAAY,EAAE,4DAA4D;iBAC3E;aACF;SACF;KACF;IACD;QACE,IAAI,EAAE,SAAS;QACf,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,cAAc;oBACpB,YAAY,EAAE,8DAA8D;iBAC7E;aACF;SACF;KACF;IACD;QACE,IAAI,EAAE,OAAO;QACb,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,SAAS;oBACf,YAAY,EAAE,aAAa;iBAC5B;aACF;SACF;KACF;IACD;QACE,IAAI,EAAE,OAAO;QACb,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,SAAS;oBACf,YAAY,EAAE,OAAO;iBACtB;aACF;SACF;KACF;IACD;QACE,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,SAAS;oBACf,YAAY,EAAE,QAAQ;iBACvB;aACF;SACF;KACF;IACD;QACE,IAAI,EAAE,SAAS;QACf,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,eAAe;oBACrB,YAAY,EAAE,yDAAyD;iBACxE;aACF;SACF;KACF;IACD;QACE,IAAI,EAAE,SAAS;QACf,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,eAAe;oBACrB,YAAY,EAAE,oDAAoD;iBACnE;aACF;SACF;KACF;CACF,CAAA;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,aAAqB;IAC1D,MAAM,aAAa,GAAwC,EAAE,CAAA;IAE7D,MAAM,gBAAgB,GAAG,UAAU,CAAC,IAAI,CACtC,CAAC,SAAS,EAAE,EAAE,CACZ,CAAC,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI;QACzB,SAAS,CAAC,SAAS,EAAE,IAAI,EAAE,MAAM,CAC/B,CAAC,uBAAgC,EAAE,QAAQ,EAAE,EAAE,CAC7C,aAAa,CAAC,QAAQ,EAAE,gBAAgB,CAAC,aAAa,EAAE,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,EACxF,KAAK,CACN,CAAC;QACJ,CAAC,CAAC,SAAS,CAAC,SAAS,EAAE,KAAK;YAC1B,SAAS,CAAC,SAAS,EAAE,KAAK,EAAE,MAAM,CAChC,CAAC,sBAA+B,EAAE,QAAQ,EAAE,EAAE,CAC5C,sBAAsB;gBACpB,CAAC,CAAC,aAAa,CAAC,QAAQ,EAAE,gBAAgB,CAAC,aAAa,EAAE,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;gBACxF,CAAC,CAAC,KAAK,EACX,IAAI,CACL,CAAC,CACP,CAAA;IAED,OAAO,gBAAgB,CAAC,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAA;AAC7D,CAAC;AAED,SAAS,aAAa,CAAC,QAAmC,EAAE,gBAAqD,EAAE;IACjH,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAA;IAE/C,OAAO,CAAC,QAAQ,CAAC,YAAY,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAE,CAAC,CAAA;AACxG,CAAC;AAED,SAAS,gBAAgB,CACvB,QAAgB,EAChB,gBAAwB,EACxB,gBAAqD,EAAE;IAEvD,IAAI,aAAa,CAAC,gBAAgB,CAAC,EAAE;QACnC,OAAO,aAAa,CAAA;KACrB;IAED,MAAM,gBAAgB,GAAG,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAA;IAC7D,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE;QACjC,OAAO,aAAa,CAAA;KACrB;IAED,MAAM,UAAU,GAAG,YAAY,CAAC,gBAAgB,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAAA;IAErE,aAAa,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAA;IAC5C,OAAO,aAAa,CAAA;AACtB,CAAC","sourcesContent":["import {join as pathJoin} from '../path.js'\nimport {existsSync, readFileSync} from 'node:fs'\n\ninterface FrameworkDetectionPattern {\n  /**\n   * A file path\n   * @example \"package.json\"\n   */\n  path: string\n  /**\n   * A matcher\n   * @example \"\\\"(dev)?(d|D)ependencies\\\":\\\\s*{[^}]*\\\"next\\\":\\\\s*\\\".+?\\\"[^}]*}\"\n   */\n  matchContent?: string\n}\n\ninterface Framework {\n  /**\n   * Name of the framework\n   * @example \"nextjs\"\n   */\n  name: string\n\n  /**\n   * Detectors used to find out the framework\n   */\n  detectors: {\n    /**\n     * Collection of detectors that must be matched for the framework\n     * to be detected.\n     */\n    every?: FrameworkDetectionPattern[]\n    /**\n     * Collection of detectors where one match triggers the framework\n     * to be detected.\n     */\n    some?: FrameworkDetectionPattern[]\n  }\n}\n\nconst frameworks: Framework[] = [\n  {\n    name: 'remix',\n    detectors: {\n      every: [\n        {\n          path: 'package.json',\n          matchContent: '\"(dev)?(d|D)ependencies\":\\\\s*{[^}]*\"@remix-run\\\\/.*\":\\\\s*\".+?\"[^}]*}',\n        },\n        {\n          path: 'package.json',\n          matchContent: '\"(dev)?(d|D)ependencies\":\\\\s*{[^}]*\"react\":\\\\s*\".+?\"[^}]*}',\n        },\n      ],\n    },\n  },\n  {\n    name: 'nextjs',\n    detectors: {\n      every: [\n        {\n          path: 'package.json',\n          matchContent: '\"(dev)?(d|D)ependencies\":\\\\s*{[^}]*\"next\":\\\\s*\".+?\"[^}]*}',\n        },\n        {\n          path: 'package.json',\n          matchContent: '\"(dev)?(d|D)ependencies\":\\\\s*{[^}]*\"react\":\\\\s*\".+?\"[^}]*}',\n        },\n      ],\n    },\n  },\n  {\n    name: 'express',\n    detectors: {\n      every: [\n        {\n          path: 'package.json',\n          matchContent: '\"(dev)?(d|D)ependencies\":\\\\s*{[^}]*\"express\":\\\\s*\".+?\"[^}]*}',\n        },\n      ],\n    },\n  },\n  {\n    name: 'rails',\n    detectors: {\n      every: [\n        {\n          path: 'Gemfile',\n          matchContent: 'gem \"rails\"',\n        },\n      ],\n    },\n  },\n  {\n    name: 'flask',\n    detectors: {\n      every: [\n        {\n          path: 'Pipfile',\n          matchContent: 'flask',\n        },\n      ],\n    },\n  },\n  {\n    name: 'django',\n    detectors: {\n      every: [\n        {\n          path: 'Pipfile',\n          matchContent: 'django',\n        },\n      ],\n    },\n  },\n  {\n    name: 'laravel',\n    detectors: {\n      every: [\n        {\n          path: 'composer.json',\n          matchContent: '\"require\":\\\\s*{[^}]*\"laravel/framework\":\\\\s*\".+?\"[^}]*}',\n        },\n      ],\n    },\n  },\n  {\n    name: 'symfony',\n    detectors: {\n      every: [\n        {\n          path: 'composer.json',\n          matchContent: '\"require\":\\\\s*{[^}]*\"symfony\\\\/.*\":\\\\s*\".+?\"[^}]*}',\n        },\n      ],\n    },\n  },\n]\n\n/**\n * Tries to identify the using of a framework analyzing the existence and/or content of different files inside a\n * specific directory.\n *\n * @param {string} rootDirectory - Directory from which the files required for each framework are searched\n * @returns {string} The name of the framework used or 'unknown' otherwise\n */\nexport async function resolveFramework(rootDirectory: string) {\n  const fwConfigFiles: {[key: string]: string | undefined} = {}\n\n  const matchedFramework = frameworks.find(\n    (framework) =>\n      (!framework.detectors?.some ||\n        framework.detectors?.some?.reduce(\n          (_previousDetectorsMatch: boolean, detector) =>\n            matchDetector(detector, loadFwConfigFile(rootDirectory, detector.path, fwConfigFiles)),\n          false,\n        )) &&\n      (!framework.detectors?.every ||\n        framework.detectors?.every?.reduce(\n          (previousDetectorsMatch: boolean, detector) =>\n            previousDetectorsMatch\n              ? matchDetector(detector, loadFwConfigFile(rootDirectory, detector.path, fwConfigFiles))\n              : false,\n          true,\n        )),\n  )\n\n  return matchedFramework ? matchedFramework.name : 'unknown'\n}\n\nfunction matchDetector(detector: FrameworkDetectionPattern, fwConfigFiles: {[key: string]: string | undefined} = {}) {\n  if (!fwConfigFiles[detector.path]) return false\n\n  return !detector.matchContent || new RegExp(detector.matchContent).test(fwConfigFiles[detector.path]!)\n}\n\nfunction loadFwConfigFile(\n  rootPath: string,\n  fwConfigFileName: string,\n  fwConfigFiles: {[key: string]: string | undefined} = {},\n) {\n  if (fwConfigFiles[fwConfigFileName]) {\n    return fwConfigFiles\n  }\n\n  const fwConfigFilePath = pathJoin(rootPath, fwConfigFileName)\n  if (!existsSync(fwConfigFilePath)) {\n    return fwConfigFiles\n  }\n\n  const rawContent = readFileSync(fwConfigFilePath, {encoding: 'utf8'})\n\n  fwConfigFiles[fwConfigFileName] = rawContent\n  return fwConfigFiles\n}\n"]}
+{"version":3,"file":"framework.js","sourceRoot":"","sources":["../../src/node/framework.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,IAAI,QAAQ,EAAC,MAAM,YAAY,CAAA;AAC3C,OAAO,EAAC,UAAU,EAAE,YAAY,EAAC,MAAM,SAAS,CAAA;AA2ChD,MAAM,UAAU,GAAgB;IAC9B;QACE,IAAI,EAAE,OAAO;QACb,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,cAAc;oBACpB,YAAY,EAAE,sEAAsE;iBACrF;gBACD;oBACE,IAAI,EAAE,cAAc;oBACpB,YAAY,EAAE,4DAA4D;iBAC3E;aACF;SACF;KACF;IACD;QACE,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,cAAc;oBACpB,YAAY,EAAE,2DAA2D;iBAC1E;gBACD;oBACE,IAAI,EAAE,cAAc;oBACpB,YAAY,EAAE,4DAA4D;iBAC3E;aACF;SACF;KACF;IACD;QACE,IAAI,EAAE,SAAS;QACf,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,cAAc;oBACpB,YAAY,EAAE,8DAA8D;iBAC7E;aACF;SACF;KACF;IACD;QACE,IAAI,EAAE,OAAO;QACb,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,SAAS;oBACf,YAAY,EAAE,aAAa;iBAC5B;aACF;SACF;KACF;IACD;QACE,IAAI,EAAE,OAAO;QACb,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,SAAS;oBACf,YAAY,EAAE,OAAO;iBACtB;aACF;SACF;KACF;IACD;QACE,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,SAAS;oBACf,YAAY,EAAE,QAAQ;iBACvB;aACF;SACF;KACF;IACD;QACE,IAAI,EAAE,SAAS;QACf,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,eAAe;oBACrB,YAAY,EAAE,yDAAyD;iBACxE;aACF;SACF;KACF;IACD;QACE,IAAI,EAAE,SAAS;QACf,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,eAAe;oBACrB,YAAY,EAAE,oDAAoD;iBACnE;aACF;SACF;KACF;CACF,CAAA;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,aAAqB;IAC1D,MAAM,aAAa,GAAwC,EAAE,CAAA;IAE7D,MAAM,gBAAgB,GAAG,UAAU,CAAC,IAAI,CACtC,CAAC,SAAS,EAAE,EAAE,CACZ,CAAC,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI;QACzB,SAAS,CAAC,SAAS,EAAE,IAAI,EAAE,MAAM,CAC/B,CAAC,uBAAgC,EAAE,QAAQ,EAAE,EAAE,CAC7C,aAAa,CAAC,QAAQ,EAAE,gBAAgB,CAAC,aAAa,EAAE,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,EACxF,KAAK,CACN,CAAC;QACJ,CAAC,CAAC,SAAS,CAAC,SAAS,EAAE,KAAK;YAC1B,SAAS,CAAC,SAAS,EAAE,KAAK,EAAE,MAAM,CAChC,CAAC,sBAA+B,EAAE,QAAQ,EAAE,EAAE,CAC5C,sBAAsB;gBACpB,CAAC,CAAC,aAAa,CAAC,QAAQ,EAAE,gBAAgB,CAAC,aAAa,EAAE,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;gBACxF,CAAC,CAAC,KAAK,EACX,IAAI,CACL,CAAC,CACP,CAAA;IAED,OAAO,gBAAgB,CAAC,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAA;AAC7D,CAAC;AAED,SAAS,aAAa,CAAC,QAAmC,EAAE,gBAAqD,EAAE;IACjH,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAA;IAE/C,OAAO,CAAC,QAAQ,CAAC,YAAY,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAE,CAAC,CAAA;AACxG,CAAC;AAED,SAAS,gBAAgB,CACvB,QAAgB,EAChB,gBAAwB,EACxB,gBAAqD,EAAE;IAEvD,IAAI,aAAa,CAAC,gBAAgB,CAAC,EAAE;QACnC,OAAO,aAAa,CAAA;KACrB;IAED,MAAM,gBAAgB,GAAG,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAA;IAC7D,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE;QACjC,OAAO,aAAa,CAAA;KACrB;IAED,MAAM,UAAU,GAAG,YAAY,CAAC,gBAAgB,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAAA;IAErE,aAAa,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAA;IAC5C,OAAO,aAAa,CAAA;AACtB,CAAC","sourcesContent":["import {join as pathJoin} from '../path.js'\nimport {existsSync, readFileSync} from 'node:fs'\n\ninterface FrameworkDetectionPattern {\n  /**\n   * @example A file path\n   * ```\n   * \"package.json\"\n   * ```\n   */\n  path: string\n  /**\n   * @example A matcher\n   * ```\n   * \"\\\"(dev)?(d|D)ependencies\\\":\\\\s*{[^}]*\\\"next\\\":\\\\s*\\\".+?\\\"[^}]*}\"\n   * ```\n   */\n  matchContent?: string\n}\n\ninterface Framework {\n  /**\n   * Name of the framework\n   * @example \"nextjs\"\n   */\n  name: string\n\n  /**\n   * Detectors used to find out the framework\n   */\n  detectors: {\n    /**\n     * Collection of detectors that must be matched for the framework\n     * to be detected.\n     */\n    every?: FrameworkDetectionPattern[]\n    /**\n     * Collection of detectors where one match triggers the framework\n     * to be detected.\n     */\n    some?: FrameworkDetectionPattern[]\n  }\n}\n\nconst frameworks: Framework[] = [\n  {\n    name: 'remix',\n    detectors: {\n      every: [\n        {\n          path: 'package.json',\n          matchContent: '\"(dev)?(d|D)ependencies\":\\\\s*{[^}]*\"@remix-run\\\\/.*\":\\\\s*\".+?\"[^}]*}',\n        },\n        {\n          path: 'package.json',\n          matchContent: '\"(dev)?(d|D)ependencies\":\\\\s*{[^}]*\"react\":\\\\s*\".+?\"[^}]*}',\n        },\n      ],\n    },\n  },\n  {\n    name: 'nextjs',\n    detectors: {\n      every: [\n        {\n          path: 'package.json',\n          matchContent: '\"(dev)?(d|D)ependencies\":\\\\s*{[^}]*\"next\":\\\\s*\".+?\"[^}]*}',\n        },\n        {\n          path: 'package.json',\n          matchContent: '\"(dev)?(d|D)ependencies\":\\\\s*{[^}]*\"react\":\\\\s*\".+?\"[^}]*}',\n        },\n      ],\n    },\n  },\n  {\n    name: 'express',\n    detectors: {\n      every: [\n        {\n          path: 'package.json',\n          matchContent: '\"(dev)?(d|D)ependencies\":\\\\s*{[^}]*\"express\":\\\\s*\".+?\"[^}]*}',\n        },\n      ],\n    },\n  },\n  {\n    name: 'rails',\n    detectors: {\n      every: [\n        {\n          path: 'Gemfile',\n          matchContent: 'gem \"rails\"',\n        },\n      ],\n    },\n  },\n  {\n    name: 'flask',\n    detectors: {\n      every: [\n        {\n          path: 'Pipfile',\n          matchContent: 'flask',\n        },\n      ],\n    },\n  },\n  {\n    name: 'django',\n    detectors: {\n      every: [\n        {\n          path: 'Pipfile',\n          matchContent: 'django',\n        },\n      ],\n    },\n  },\n  {\n    name: 'laravel',\n    detectors: {\n      every: [\n        {\n          path: 'composer.json',\n          matchContent: '\"require\":\\\\s*{[^}]*\"laravel/framework\":\\\\s*\".+?\"[^}]*}',\n        },\n      ],\n    },\n  },\n  {\n    name: 'symfony',\n    detectors: {\n      every: [\n        {\n          path: 'composer.json',\n          matchContent: '\"require\":\\\\s*{[^}]*\"symfony\\\\/.*\":\\\\s*\".+?\"[^}]*}',\n        },\n      ],\n    },\n  },\n]\n\n/**\n * Tries to identify the using of a framework analyzing the existence and/or content of different files inside a\n * specific directory.\n *\n * @param rootDirectory - Directory from which the files required for each framework are searched\n * @returns The name of the framework used or 'unknown' otherwise\n */\nexport async function resolveFramework(rootDirectory: string) {\n  const fwConfigFiles: {[key: string]: string | undefined} = {}\n\n  const matchedFramework = frameworks.find(\n    (framework) =>\n      (!framework.detectors?.some ||\n        framework.detectors?.some?.reduce(\n          (_previousDetectorsMatch: boolean, detector) =>\n            matchDetector(detector, loadFwConfigFile(rootDirectory, detector.path, fwConfigFiles)),\n          false,\n        )) &&\n      (!framework.detectors?.every ||\n        framework.detectors?.every?.reduce(\n          (previousDetectorsMatch: boolean, detector) =>\n            previousDetectorsMatch\n              ? matchDetector(detector, loadFwConfigFile(rootDirectory, detector.path, fwConfigFiles))\n              : false,\n          true,\n        )),\n  )\n\n  return matchedFramework ? matchedFramework.name : 'unknown'\n}\n\nfunction matchDetector(detector: FrameworkDetectionPattern, fwConfigFiles: {[key: string]: string | undefined} = {}) {\n  if (!fwConfigFiles[detector.path]) return false\n\n  return !detector.matchContent || new RegExp(detector.matchContent).test(fwConfigFiles[detector.path]!)\n}\n\nfunction loadFwConfigFile(\n  rootPath: string,\n  fwConfigFileName: string,\n  fwConfigFiles: {[key: string]: string | undefined} = {},\n) {\n  if (fwConfigFiles[fwConfigFileName]) {\n    return fwConfigFiles\n  }\n\n  const fwConfigFilePath = pathJoin(rootPath, fwConfigFileName)\n  if (!existsSync(fwConfigFilePath)) {\n    return fwConfigFiles\n  }\n\n  const rawContent = readFileSync(fwConfigFilePath, {encoding: 'utf8'})\n\n  fwConfigFiles[fwConfigFileName] = rawContent\n  return fwConfigFiles\n}\n"]}

package/dist/node/hooks/prerun.js

@@ -29,8 +29,8 @@ function parseNormalCommand(id, aliases) {
  * Create commands implement Init by default, so the name of the command must be extracted from
  * the plugin/module name. Neither alias or topic are supported
  *
- * @param {Interfaces.Command.Class} commandClass - Oclif command configuration
- * @returns {(CommandContent | undefined)} Command content with the name of the command or undefined otherwise
+ * @param commandClass - Oclif command configuration
+ * @returns Command content with the name of the command or undefined otherwise
  */
 function parseCreateCommand(pluginAlias) {
     if (!pluginAlias || !pluginAlias.startsWith('@shopify/create-')) {
@@ -42,8 +42,8 @@ function parseCreateCommand(pluginAlias) {
  * Commands use this pattern topic:subtopic1:...:subtopicN:command. This method extract the topic and subtopic
  * information replacing the ':' separator with one space
  *
- * @param {string} cmd - Complete command string to extract the topic information
- * @returns {(string | undefined)} The topic name or undefined otherwise
+ * @param cmd - Complete command string to extract the topic information
+ * @returns The topic name or undefined otherwise
  */
 function parseTopic(cmd) {
     if (cmd.lastIndexOf(':') === -1) {
@@ -54,8 +54,8 @@ function parseTopic(cmd) {
 /**
  * Identifies if the command was launched using an alias instead of the oficial command name
  *
- * @param {string[]} aliases - List of possible alias a command has
- * @returns {(string | undefined)} The alias used or undefined otherwise
+ * @param aliases - List of possible alias a command has
+ * @returns The alias used or undefined otherwise
  */
 function findAlias(aliases) {
     const existingAlias = aliases.find((alias) => alias.split(':').every((aliasToken) => process.argv.includes(aliasToken)));

package/dist/node/hooks/prerun.js.map

@@ -1 +1 @@
-{"version":3,"file":"prerun.js","sourceRoot":"","sources":["../../../src/node/hooks/prerun.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAC,MAAM,oBAAoB,CAAA;AACxC,OAAO,EAAC,KAAK,EAAC,MAAM,iBAAiB,CAAA;AASrC,sFAAsF;AACtF,MAAM,CAAC,MAAM,IAAI,GAAgB,KAAK,EAAE,OAAO,EAAE,EAAE;IACjD,MAAM,cAAc,GAAG,mBAAmB,CAAC;QACzC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE;QACtB,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO;QAChC,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK;KAC3C,CAAC,CAAA;IACF,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;IACzB,KAAK,CAAC,mBAAmB,cAAc,CAAC,OAAO,EAAE,CAAC,CAAA;IAClD,MAAM,KAAK,CAAC,EAAC,cAAc,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,OAAoC,EAAC,CAAC,CAAA;AACjG,CAAC,CAAA;AAED,MAAM,UAAU,mBAAmB,CAAC,OAA8D;IAChG,IAAI,cAAc,GAAG,kBAAkB,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;IAC5D,IAAI,CAAC,cAAc,EAAE;QACnB,cAAc,GAAG,kBAAkB,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,CAAA;KACjE;IACD,OAAO,cAAc,CAAA;AACvB,CAAC;AAED,SAAS,kBAAkB,CAAC,EAAU,EAAE,OAAiB;IACvD,OAAO;QACL,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC;QAC9B,KAAK,EAAE,UAAU,CAAC,EAAE,CAAC;QACrB,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC;KAC1B,CAAA;AACH,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,WAAoB;IAC9C,IAAI,CAAC,WAAW,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE;QAC/D,OAAO,SAAS,CAAA;KACjB;IAED,OAAO,EAAC,OAAO,EAAE,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAC,CAAA;AACvE,CAAC;AAED;;;;;;GAMG;AACH,SAAS,UAAU,CAAC,GAAW;IAC7B,IAAI,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE;QAC/B,OAAM;KACP;IACD,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;AAC9D,CAAC;AAED;;;;;GAKG;AACH,SAAS,SAAS,CAAC,OAAiB;IAClC,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAC3C,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAC1E,CAAA;IACD,IAAI,aAAa,EAAE;QACjB,OAAO,aAAa,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;KACxC;AACH,CAAC","sourcesContent":["import {start} from '../../analytics.js'\nimport {debug} from '../../output.js'\nimport Command from '../base-command.js'\nimport {Hook} from '@oclif/core'\n\nexport declare interface CommandContent {\n  command: string\n  topic?: string\n  alias?: string\n}\n// This hook is called before each command run. More info: https://oclif.io/docs/hooks\nexport const hook: Hook.Prerun = async (options) => {\n  const commandContent = parseCommandContent({\n    id: options.Command.id,\n    aliases: options.Command.aliases,\n    pluginAlias: options.Command.plugin?.alias,\n  })\n  const args = options.argv\n  debug(`Running command ${commandContent.command}`)\n  await start({commandContent, args, commandClass: options.Command as unknown as typeof Command})\n}\n\nexport function parseCommandContent(cmdInfo: {id: string; aliases: string[]; pluginAlias?: string}) {\n  let commandContent = parseCreateCommand(cmdInfo.pluginAlias)\n  if (!commandContent) {\n    commandContent = parseNormalCommand(cmdInfo.id, cmdInfo.aliases)\n  }\n  return commandContent\n}\n\nfunction parseNormalCommand(id: string, aliases: string[]): CommandContent {\n  return {\n    command: id.replace(/:/g, ' '),\n    topic: parseTopic(id),\n    alias: findAlias(aliases),\n  }\n}\n\n/**\n * Create commands implement Init by default, so the name of the command must be extracted from\n * the plugin/module name. Neither alias or topic are supported\n *\n * @param {Interfaces.Command.Class} commandClass - Oclif command configuration\n * @returns {(CommandContent | undefined)} Command content with the name of the command or undefined otherwise\n */\nfunction parseCreateCommand(pluginAlias?: string): CommandContent | undefined {\n  if (!pluginAlias || !pluginAlias.startsWith('@shopify/create-')) {\n    return undefined\n  }\n\n  return {command: pluginAlias.substring(pluginAlias.indexOf('/') + 1)}\n}\n\n/**\n * Commands use this pattern topic:subtopic1:...:subtopicN:command. This method extract the topic and subtopic\n * information replacing the ':' separator with one space\n *\n * @param {string} cmd - Complete command string to extract the topic information\n * @returns {(string | undefined)} The topic name or undefined otherwise\n */\nfunction parseTopic(cmd: string) {\n  if (cmd.lastIndexOf(':') === -1) {\n    return\n  }\n  return cmd.slice(0, cmd.lastIndexOf(':')).replace(/:/g, ' ')\n}\n\n/**\n * Identifies if the command was launched using an alias instead of the oficial command name\n *\n * @param {string[]} aliases - List of possible alias a command has\n * @returns {(string | undefined)} The alias used or undefined otherwise\n */\nfunction findAlias(aliases: string[]) {\n  const existingAlias = aliases.find((alias) =>\n    alias.split(':').every((aliasToken) => process.argv.includes(aliasToken)),\n  )\n  if (existingAlias) {\n    return existingAlias.replace(/:/g, ' ')\n  }\n}\n"]}
+{"version":3,"file":"prerun.js","sourceRoot":"","sources":["../../../src/node/hooks/prerun.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAC,MAAM,oBAAoB,CAAA;AACxC,OAAO,EAAC,KAAK,EAAC,MAAM,iBAAiB,CAAA;AASrC,sFAAsF;AACtF,MAAM,CAAC,MAAM,IAAI,GAAgB,KAAK,EAAE,OAAO,EAAE,EAAE;IACjD,MAAM,cAAc,GAAG,mBAAmB,CAAC;QACzC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE;QACtB,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO;QAChC,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK;KAC3C,CAAC,CAAA;IACF,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;IACzB,KAAK,CAAC,mBAAmB,cAAc,CAAC,OAAO,EAAE,CAAC,CAAA;IAClD,MAAM,KAAK,CAAC,EAAC,cAAc,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,OAAoC,EAAC,CAAC,CAAA;AACjG,CAAC,CAAA;AAED,MAAM,UAAU,mBAAmB,CAAC,OAA8D;IAChG,IAAI,cAAc,GAAG,kBAAkB,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;IAC5D,IAAI,CAAC,cAAc,EAAE;QACnB,cAAc,GAAG,kBAAkB,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,CAAA;KACjE;IACD,OAAO,cAAc,CAAA;AACvB,CAAC;AAED,SAAS,kBAAkB,CAAC,EAAU,EAAE,OAAiB;IACvD,OAAO;QACL,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC;QAC9B,KAAK,EAAE,UAAU,CAAC,EAAE,CAAC;QACrB,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC;KAC1B,CAAA;AACH,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,WAAoB;IAC9C,IAAI,CAAC,WAAW,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE;QAC/D,OAAO,SAAS,CAAA;KACjB;IAED,OAAO,EAAC,OAAO,EAAE,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAC,CAAA;AACvE,CAAC;AAED;;;;;;GAMG;AACH,SAAS,UAAU,CAAC,GAAW;IAC7B,IAAI,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE;QAC/B,OAAM;KACP;IACD,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;AAC9D,CAAC;AAED;;;;;GAKG;AACH,SAAS,SAAS,CAAC,OAAiB;IAClC,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAC3C,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAC1E,CAAA;IACD,IAAI,aAAa,EAAE;QACjB,OAAO,aAAa,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;KACxC;AACH,CAAC","sourcesContent":["import {start} from '../../analytics.js'\nimport {debug} from '../../output.js'\nimport Command from '../base-command.js'\nimport {Hook} from '@oclif/core'\n\nexport declare interface CommandContent {\n  command: string\n  topic?: string\n  alias?: string\n}\n// This hook is called before each command run. More info: https://oclif.io/docs/hooks\nexport const hook: Hook.Prerun = async (options) => {\n  const commandContent = parseCommandContent({\n    id: options.Command.id,\n    aliases: options.Command.aliases,\n    pluginAlias: options.Command.plugin?.alias,\n  })\n  const args = options.argv\n  debug(`Running command ${commandContent.command}`)\n  await start({commandContent, args, commandClass: options.Command as unknown as typeof Command})\n}\n\nexport function parseCommandContent(cmdInfo: {id: string; aliases: string[]; pluginAlias?: string}) {\n  let commandContent = parseCreateCommand(cmdInfo.pluginAlias)\n  if (!commandContent) {\n    commandContent = parseNormalCommand(cmdInfo.id, cmdInfo.aliases)\n  }\n  return commandContent\n}\n\nfunction parseNormalCommand(id: string, aliases: string[]): CommandContent {\n  return {\n    command: id.replace(/:/g, ' '),\n    topic: parseTopic(id),\n    alias: findAlias(aliases),\n  }\n}\n\n/**\n * Create commands implement Init by default, so the name of the command must be extracted from\n * the plugin/module name. Neither alias or topic are supported\n *\n * @param commandClass - Oclif command configuration\n * @returns Command content with the name of the command or undefined otherwise\n */\nfunction parseCreateCommand(pluginAlias?: string): CommandContent | undefined {\n  if (!pluginAlias || !pluginAlias.startsWith('@shopify/create-')) {\n    return undefined\n  }\n\n  return {command: pluginAlias.substring(pluginAlias.indexOf('/') + 1)}\n}\n\n/**\n * Commands use this pattern topic:subtopic1:...:subtopicN:command. This method extract the topic and subtopic\n * information replacing the ':' separator with one space\n *\n * @param cmd - Complete command string to extract the topic information\n * @returns The topic name or undefined otherwise\n */\nfunction parseTopic(cmd: string) {\n  if (cmd.lastIndexOf(':') === -1) {\n    return\n  }\n  return cmd.slice(0, cmd.lastIndexOf(':')).replace(/:/g, ' ')\n}\n\n/**\n * Identifies if the command was launched using an alias instead of the oficial command name\n *\n * @param aliases - List of possible alias a command has\n * @returns The alias used or undefined otherwise\n */\nfunction findAlias(aliases: string[]) {\n  const existingAlias = aliases.find((alias) =>\n    alias.split(':').every((aliasToken) => process.argv.includes(aliasToken)),\n  )\n  if (existingAlias) {\n    return existingAlias.replace(/:/g, ' ')\n  }\n}\n"]}

package/dist/node/node-package-manager.d.ts

@@ -25,26 +25,26 @@ export declare type PackageManager = typeof packageManager[number];
 /**
  * Returns an abort error that's thrown when a directory that's expected to have
  * a package.json doesn't have it.
- * @param directory {string} The path to the directory that should contain a package.json
- * @returns {Abort} An abort error.
+ * @param directory - The path to the directory that should contain a package.json
+ * @returns An abort error.
  */
 export declare const PackageJsonNotFoundError: (directory: string) => Abort;
 /**
  * Returns a bug error that's thrown when the lookup of the package.json traversing the directory
  * hierarchy up can't find a package.json
- * @param directory {string} The directory from which the traverse has been done
- * @returns {Abort} An abort error.
+ * @param directory - The directory from which the traverse has been done
+ * @returns An abort error.
  */
 export declare const FindUpAndReadPackageJsonNotFoundError: (directory: string) => Bug;
 /**
  * Returns the dependency manager used to run the create workflow.
- * @param env {Object} The environment variables of the process in which the CLI runs.
+ * @param env - The environment variables of the process in which the CLI runs.
  * @returns The dependency manager
  */
 export declare function packageManagerUsedForCreating(env?: NodeJS.ProcessEnv): PackageManager | 'unknown';
 /**
  * Returns the dependency manager used by an existing project.
- * @param directory {string} The root directory of the project.
+ * @param directory - The root directory of the project.
  * @returns The dependency manager
  */
 export declare function getPackageManager(directory: string): Promise<PackageManager>;
@@ -66,7 +66,7 @@ interface InstallNPMDependenciesRecursivelyOptions {
  * This function traverses down a directory tree to find directories containing a package.json
  * and installs the dependencies if needed. To know if it's needed, it uses the "check" command
  * provided by dependency managers.
- * @param options {InstallNPMDependenciesRecursivelyOptions} Options to install dependencies recursively.
+ * @param options - Options to install dependencies recursively.
  */
 export declare function installNPMDependenciesRecursively(options: InstallNPMDependenciesRecursivelyOptions): Promise<void>;
 interface InstallNodeModulesOptions {
@@ -80,13 +80,13 @@ interface InstallNodeModulesOptions {
 export declare function installNodeModules(options: InstallNodeModulesOptions): Promise<void>;
 /**
  * Returns the name of the package configured in its package.json
- * @param packageJsonPath {string} Path to the package.json file
+ * @param packageJsonPath - Path to the package.json file
  * @returns A promise that resolves with the name.
  */
 export declare function getPackageName(packageJsonPath: string): Promise<string | undefined>;
 /**
  * Returns the list of production and dev dependencies of a package.json
- * @param packageJsonPath {string} Path to the package.json file
+ * @param packageJsonPath - Path to the package.json file
  * @returns A promise that resolves with the list of dependencies.
  */
 export declare function getDependencies(packageJsonPath: string): Promise<{
@@ -94,16 +94,16 @@ export declare function getDependencies(packageJsonPath: string): Promise<{
 }>;
 /**
  * Returns true if the app uses workspaces, false otherwise.
- * @param packageJsonPath {string} Path to the package.json file
- * @param pnpmWorkspacePath {string} Path to the pnpm-workspace.yaml file
+ * @param packageJsonPath - Path to the package.json file
+ * @param pnpmWorkspacePath - Path to the pnpm-workspace.yaml file
  * @returns A promise that resolves with true if the app uses workspaces, false otherwise.
  */
 export declare function usesWorkspaces(appDirectory: string): Promise<boolean>;
 /**
  * Given an NPM dependency, it checks if there's a more recent version, and if there is, it returns its value.
- * @param dependency {string} The dependency name (e.g. react)
- * @param currentVersion {string} The current version.
- * @returns {Promise<string>} A promise that resolves with a more recent version or undefined if there's no more recent version.
+ * @param dependency - The dependency name (e.g. react)
+ * @param currentVersion - The current version.
+ * @returns A promise that resolves with a more recent version or undefined if there's no more recent version.
  */
 export declare function checkForNewVersion(dependency: string, currentVersion: string): Promise<string | undefined>;
 /**
@@ -155,8 +155,8 @@ export interface PackageJson {
 }
 /**
  * Reads and parses a package.json
- * @param packageJsonPath {string} Path to the package.json
- * @returns {Promise<PackageJson>} An promise that resolves with an in-memory representation
+ * @param packageJsonPath - Path to the package.json
+ * @returns An promise that resolves with an in-memory representation
  *    of the package.json or rejects with an error if the file is not found or the content is
  *    not decodable.
  */
@@ -183,27 +183,31 @@ export interface DependencyVersion {
      * The name of the NPM dependency as it's reflected in the package.json:
      *
      * @example
-     *  In the example below name would be "react"
-     *  {
-     *    "react": "1.2.3"
-     *  }
+     * In the example below name would be "react"
+     * ```
+     * {
+     *   "react": "1.2.3"
+     * }
+     * ```
      */
     name: string;
     /**
      * The version of the NPM dependency as it's reflected in the package.json:
      *
      * @example
-     *  In the example below version would be "1.2.3"
-     *  {
-     *    "react": "1.2.3"
-     *  }
+     * In the example below version would be "1.2.3"
+     * ```
+     * {
+     *   "react": "1.2.3"
+     * }
+     * ```
      */
     version: string | undefined;
 }
 /**
  * Adds dependencies to a Node project (i.e. a project that has a package.json)
- * @param dependencies {string[]} List of dependencies to be added.
- * @param options {AddNPMDependenciesIfNeededOptions} Options for adding dependencies.
+ * @param dependencies - List of dependencies to be added.
+ * @param options - Options for adding dependencies.
  */
 export declare function addNPMDependenciesIfNeeded(dependencies: DependencyVersion[], options: AddNPMDependenciesIfNeededOptions): Promise<void>;
 export declare function addNPMDependencies(dependencies: DependencyVersion[], options: AddNPMDependenciesIfNeededOptions): Promise<void>;
@@ -211,8 +215,8 @@ export declare function addNPMDependenciesWithoutVersionIfNeeded(dependencies: s
 /**
  * Given a directory it traverses the directory up looking for a package.json and if found, it reads it
  * decodes the JSON, and returns its content as a Javascript object.
- * @param options {string} The directory from which traverse up.
- * @returns {Promise<{path: string; content: unknown}>} If found, the promise resolves with the path to the
+ * @param options - The directory from which traverse up.
+ * @returns If found, the promise resolves with the path to the
  *  package.json and its content. If not found, it throws a FindUpAndReadPackageJsonNotFoundError error.
  */
 export declare function findUpAndReadPackageJson(fromDirectory: string): Promise<{

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

@@ -21,8 +21,8 @@ export const packageManager = ['yarn', 'npm', 'pnpm'];
 /**
  * Returns an abort error that's thrown when a directory that's expected to have
  * a package.json doesn't have it.
- * @param directory {string} The path to the directory that should contain a package.json
- * @returns {Abort} An abort error.
+ * @param directory - The path to the directory that should contain a package.json
+ * @returns An abort error.
  */
 export const PackageJsonNotFoundError = (directory) => {
     return new Abort(`The directory ${directory} doesn't have a package.json.`);
@@ -30,15 +30,15 @@ export const PackageJsonNotFoundError = (directory) => {
 /**
  * Returns a bug error that's thrown when the lookup of the package.json traversing the directory
  * hierarchy up can't find a package.json
- * @param directory {string} The directory from which the traverse has been done
- * @returns {Abort} An abort error.
+ * @param directory - The directory from which the traverse has been done
+ * @returns An abort error.
  */
 export const FindUpAndReadPackageJsonNotFoundError = (directory) => {
     return new Bug(content `Couldn't find a a package.json traversing directories from ${token.path(directory)}`);
 };
 /**
  * Returns the dependency manager used to run the create workflow.
- * @param env {Object} The environment variables of the process in which the CLI runs.
+ * @param env - The environment variables of the process in which the CLI runs.
  * @returns The dependency manager
  */
 export function packageManagerUsedForCreating(env = process.env) {
@@ -55,7 +55,7 @@ export function packageManagerUsedForCreating(env = process.env) {
 }
 /**
  * Returns the dependency manager used by an existing project.
- * @param directory {string} The root directory of the project.
+ * @param directory - The root directory of the project.
  * @returns The dependency manager
  */
 export async function getPackageManager(directory) {
@@ -76,7 +76,7 @@ export async function getPackageManager(directory) {
  * This function traverses down a directory tree to find directories containing a package.json
  * and installs the dependencies if needed. To know if it's needed, it uses the "check" command
  * provided by dependency managers.
- * @param options {InstallNPMDependenciesRecursivelyOptions} Options to install dependencies recursively.
+ * @param options - Options to install dependencies recursively.
  */
 export async function installNPMDependenciesRecursively(options) {
     const packageJsons = await glob(pathJoin(options.directory, '**/package.json'), {
@@ -120,7 +120,7 @@ export async function installNodeModules(options) {
 }
 /**
  * Returns the name of the package configured in its package.json
- * @param packageJsonPath {string} Path to the package.json file
+ * @param packageJsonPath - Path to the package.json file
  * @returns A promise that resolves with the name.
  */
 export async function getPackageName(packageJsonPath) {
@@ -129,7 +129,7 @@ export async function getPackageName(packageJsonPath) {
 }
 /**
  * Returns the list of production and dev dependencies of a package.json
- * @param packageJsonPath {string} Path to the package.json file
+ * @param packageJsonPath - Path to the package.json file
  * @returns A promise that resolves with the list of dependencies.
  */
 export async function getDependencies(packageJsonPath) {
@@ -140,8 +140,8 @@ export async function getDependencies(packageJsonPath) {
 }
 /**
  * Returns true if the app uses workspaces, false otherwise.
- * @param packageJsonPath {string} Path to the package.json file
- * @param pnpmWorkspacePath {string} Path to the pnpm-workspace.yaml file
+ * @param packageJsonPath - Path to the package.json file
+ * @param pnpmWorkspacePath - Path to the pnpm-workspace.yaml file
  * @returns A promise that resolves with true if the app uses workspaces, false otherwise.
  */
 export async function usesWorkspaces(appDirectory) {
@@ -152,9 +152,9 @@ export async function usesWorkspaces(appDirectory) {
 }
 /**
  * Given an NPM dependency, it checks if there's a more recent version, and if there is, it returns its value.
- * @param dependency {string} The dependency name (e.g. react)
- * @param currentVersion {string} The current version.
- * @returns {Promise<string>} A promise that resolves with a more recent version or undefined if there's no more recent version.
+ * @param dependency - The dependency name (e.g. react)
+ * @param currentVersion - The current version.
+ * @returns A promise that resolves with a more recent version or undefined if there's no more recent version.
  */
 export async function checkForNewVersion(dependency, currentVersion) {
     debug(content `Checking if there's a version of ${dependency} newer than ${currentVersion}`);
@@ -174,8 +174,8 @@ export async function checkForNewVersion(dependency, currentVersion) {
 }
 /**
  * Reads and parses a package.json
- * @param packageJsonPath {string} Path to the package.json
- * @returns {Promise<PackageJson>} An promise that resolves with an in-memory representation
+ * @param packageJsonPath - Path to the package.json
+ * @returns An promise that resolves with an in-memory representation
  *    of the package.json or rejects with an error if the file is not found or the content is
  *    not decodable.
  */
@@ -187,8 +187,8 @@ export async function readAndParsePackageJson(packageJsonPath) {
 }
 /**
  * Adds dependencies to a Node project (i.e. a project that has a package.json)
- * @param dependencies {string[]} List of dependencies to be added.
- * @param options {AddNPMDependenciesIfNeededOptions} Options for adding dependencies.
+ * @param dependencies - List of dependencies to be added.
+ * @param options - Options for adding dependencies.
  */
 export async function addNPMDependenciesIfNeeded(dependencies, options) {
     debug(content `Adding the following dependencies if needed:
@@ -241,9 +241,9 @@ export async function addNPMDependenciesWithoutVersionIfNeeded(dependencies, opt
 }
 /**
  * Returns the arguments to add dependencies using NPM.
- * @param dependencies {string[]} The list of dependencies to add
- * @param type {DependencyType} The dependency type.
- * @returns {string[]} An array with the arguments.
+ * @param dependencies - The list of dependencies to add
+ * @param type - The dependency type.
+ * @returns An array with the arguments.
  */
 function argumentsToAddDependenciesWithNPM(dependencies, type) {
     let command = ['install'];
@@ -263,9 +263,9 @@ function argumentsToAddDependenciesWithNPM(dependencies, type) {
 }
 /**
  * Returns the arguments to add dependencies using Yarn.
- * @param dependencies {string[]} The list of dependencies to add
- * @param type {DependencyType} The dependency type.
- * @returns {string[]} An array with the arguments.
+ * @param dependencies - The list of dependencies to add
+ * @param type - The dependency type.
+ * @returns An array with the arguments.
  */
 function argumentsToAddDependenciesWithYarn(dependencies, type) {
     let command = ['add'];
@@ -285,9 +285,9 @@ function argumentsToAddDependenciesWithYarn(dependencies, type) {
 }
 /**
  * Returns the arguments to add dependencies using PNPM.
- * @param dependencies {string[]} The list of dependencies to add
- * @param type {DependencyType} The dependency type.
- * @returns {string[]} An array with the arguments.
+ * @param dependencies - The list of dependencies to add
+ * @param type - The dependency type.
+ * @returns An array with the arguments.
  */
 function argumentsToAddDependenciesWithPNPM(dependencies, type) {
     let command = ['add'];
@@ -308,8 +308,8 @@ function argumentsToAddDependenciesWithPNPM(dependencies, type) {
 /**
  * Given a directory it traverses the directory up looking for a package.json and if found, it reads it
  * decodes the JSON, and returns its content as a Javascript object.
- * @param options {string} The directory from which traverse up.
- * @returns {Promise<{path: string; content: unknown}>} If found, the promise resolves with the path to the
+ * @param options - The directory from which traverse up.
+ * @returns If found, the promise resolves with the path to the
  *  package.json and its content. If not found, it throws a FindUpAndReadPackageJsonNotFoundError error.
  */
 export async function findUpAndReadPackageJson(fromDirectory) {