File Explorer

1const { readdir } = require('node:fs/promises')2const { resolve, join } = require('node:path')3const { log } = require('proc-log')4const runScript = require('@npmcli/run-script')5const pacote = require('pacote')6const checks = require('npm-install-checks')7const reifyFinish = require('../utils/reify-finish.js')8const ArboristWorkspaceCmd = require('../arborist-cmd.js')9 10class Install extends ArboristWorkspaceCmd {11  static description = 'Install a package'12  static name = 'install'13 14  // These are in the order they will show up in when running "-h"15  // If adding to this list, consider adding also to ci.js16  static params = [17    'save',18    'save-exact',19    'global',20    'install-strategy',21    'legacy-bundling',22    'global-style',23    'omit',24    'include',25    'strict-peer-deps',26    'prefer-dedupe',27    'package-lock',28    'package-lock-only',29    'foreground-scripts',30    'ignore-scripts',31    'allow-git',32    'audit',33    'before',34    'min-release-age',35    'bin-links',36    'fund',37    'dry-run',38    'cpu',39    'os',40    'libc',41    ...super.params,42  ]43 44  static usage = ['[<package-spec> ...]']45 46  static async completion (opts) {47    const { partialWord } = opts48    // install can complete to a folder with a package.json, or any package.49    // if it has a slash, then it's gotta be a folder50    // if it starts with https?://, then just give up, because it's a url51    if (/^https?:\/\//.test(partialWord)) {52      // do not complete to URLs53      return []54    }55 56    if (/\//.test(partialWord)) {57      // Complete fully to folder if there is exactly one match and it58      // is a folder containing a package.json file.  If that is not the59      // case we return 0 matches, which will trigger the default bash60      // complete.61      const lastSlashIdx = partialWord.lastIndexOf('/')62      const partialName = partialWord.slice(lastSlashIdx + 1)63      const partialPath = partialWord.slice(0, lastSlashIdx) || '/'64 65      const isDirMatch = async sibling => {66        if (sibling.slice(0, partialName.length) !== partialName) {67          return false68        }69 70        try {71          const contents = await readdir(join(partialPath, sibling))72          const result = (contents.indexOf('package.json') !== -1)73          return result74        } catch {75          return false76        }77      }78 79      try {80        const siblings = await readdir(partialPath)81        const matches = []82        for (const sibling of siblings) {83          if (await isDirMatch(sibling)) {84            matches.push(sibling)85          }86        }87        if (matches.length === 1) {88          return [join(partialPath, matches[0])]89        }90        // no matches91        return []92      } catch {93        return [] // invalid dir: no matching94      }95    }96    // Note: there used to be registry completion here,97    // but it stopped making sense somewhere around98    // 50,000 packages on the registry99  }100 101  async exec (args) {102    // the /path/to/node_modules/..103    const globalTop = resolve(this.npm.globalDir, '..')104    const ignoreScripts = this.npm.config.get('ignore-scripts')105    const isGlobalInstall = this.npm.global106    const where = isGlobalInstall ? globalTop : this.npm.prefix107    const forced = this.npm.config.get('force')108    const scriptShell = this.npm.config.get('script-shell') || undefined109 110    // be very strict about engines when trying to update npm itself111    const npmInstall = args.find(arg => arg.startsWith('npm@') || arg === 'npm')112    if (isGlobalInstall && npmInstall) {113      const npmOptions = this.npm.flatOptions114      const npmManifest = await pacote.manifest(npmInstall, npmOptions)115      try {116        checks.checkEngine(npmManifest, npmManifest.version, process.version)117      } catch (e) {118        if (forced) {119          log.warn(120            'install',121            `Forcing global npm install with incompatible version ${npmManifest.version} into node ${process.version}`122          )123        } else {124          throw e125        }126      }127    }128 129    // don't try to install the prefix into itself130    args = args.filter(a => resolve(a) !== this.npm.prefix)131 132    // `npm i -g` => "install this package globally"133    if (isGlobalInstall && !args.length) {134      args = ['.']135    }136 137    // throw usage error if trying to install empty package138    // name to global space, e.g: `npm i -g ""`139    if (where === globalTop && !args.every(Boolean)) {140      throw this.usageError()141    }142 143    const Arborist = require('@npmcli/arborist')144    const opts = {145      ...this.npm.flatOptions,146      auditLevel: null,147      path: where,148      add: args,149      workspaces: this.workspaceNames,150    }151    const arb = new Arborist(opts)152    await arb.reify(opts)153 154    if (!args.length && !isGlobalInstall && !ignoreScripts) {155      const scripts = [156        'preinstall',157        'install',158        'postinstall',159        'prepublish', // XXX(npm9) should we remove this finally??160        'preprepare',161        'prepare',162        'postprepare',163      ]164      for (const event of scripts) {165        await runScript({166          path: where,167          args: [],168          scriptShell,169          stdio: 'inherit',170          event,171        })172      }173    }174    await reifyFinish(this.npm, arb)175  }176}177 178module.exports = Install179