Function getPostInstallTrigger

packages/blitz-next/scripts/postinstall.js:242–292

* Get the command that triggered this postinstall script being run. If there is * an error while attempting to get this value then the string constant * 'ERROR_WHILE_FINDING_POSTINSTALL_TRIGGER' is returned. * This information is just necessary for telemetry. * This get's passed in to Ge

()

   * This get's passed in to Generate, which then automatically get's propagated to telemetry.
   */
  function getPostInstallTrigger() {
    /*
  npm_config_argv` is not officially documented so here are our (Prisma's) research notes
  `npm_config_argv` is available to the postinstall script when the containing package has been installed by npm into some project.
  An example of its value:
  ```
  npm_config_argv: '{"remain":["../test"],"cooked":["add","../test"],"original":["add","../test"]}',
  ```
  We are interesting in the data contained in the "original" field.
  Trivia/Note: `npm_config_argv` is not available when running e.g. `npm install` on the containing package itself (e.g. when working on it)
  Yarn mimics this data and environment variable. Here is an example following `yarn add` for the same package:
  ```
  npm_config_argv: '{"remain":[],"cooked":["add"],"original":["add","../test"]}'
  ```
  Other package managers like `pnpm` have not been tested.
  */

    const maybe_npm_config_argv_string = process.env.npm_config_argv

    if (maybe_npm_config_argv_string === undefined) {
      return UNABLE_TO_FIND_POSTINSTALL_TRIGGER__ENVAR_MISSING
    }

    let npm_config_argv
    try {
      npm_config_argv = JSON.parse(maybe_npm_config_argv_string)
    } catch (e) {
      return `${UNABLE_TO_FIND_POSTINSTALL_TRIGGER_JSON_PARSE_ERROR}: ${maybe_npm_config_argv_string}`
    }

    if (typeof npm_config_argv !== "object" || npm_config_argv === null) {
      return `${UNABLE_TO_FIND_POSTINSTALL_TRIGGER_JSON_SCHEMA_ERROR}: ${maybe_npm_config_argv_string}`
    }

    const npm_config_arv_original_arr = npm_config_argv.original

    if (!Array.isArray(npm_config_arv_original_arr)) {
      return `${UNABLE_TO_FIND_POSTINSTALL_TRIGGER_JSON_SCHEMA_ERROR}: ${maybe_npm_config_argv_string}`
    }

    const npm_config_arv_original = npm_config_arv_original_arr
      .filter((arg) => arg !== "")
      .join(" ")

    const command =
      npm_config_arv_original === ""
        ? getPackageManagerName()
        : [getPackageManagerName(), npm_config_arv_original].join(" ")

    return command
  }

  /**
   * Wrap double quotes around the given string.