File Explorer

1const reifyFinish = require('../utils/reify-finish.js')2const runScript = require('@npmcli/run-script')3const fs = require('node:fs/promises')4const path = require('node:path')5const { log, time } = require('proc-log')6const validateLockfile = require('../utils/validate-lockfile.js')7const ArboristWorkspaceCmd = require('../arborist-cmd.js')8const getWorkspaces = require('../utils/get-workspaces.js')9 10class CI extends ArboristWorkspaceCmd {11  static description = 'Clean install a project'12  static name = 'ci'13 14  // These are in the order they will show up in when running "-h"15  static params = [16    'install-strategy',17    'legacy-bundling',18    'global-style',19    'omit',20    'include',21    'strict-peer-deps',22    'foreground-scripts',23    'ignore-scripts',24    'allow-git',25    'audit',26    'bin-links',27    'fund',28    'dry-run',29    ...super.params,30  ]31 32  async exec () {33    if (this.npm.global) {34      throw Object.assign(new Error('`npm ci` does not work for global packages'), {35        code: 'ECIGLOBAL',36      })37    }38 39    const where = this.npm.prefix40    const Arborist = require('@npmcli/arborist')41    const opts = {42      ...this.npm.flatOptions,43      packageLock: true, // npm ci should never skip lock files44      path: where,45      save: false, // npm ci should never modify the lockfile or package.json46      workspaces: this.workspaceNames,47    }48 49    const arb = new Arborist(opts)50    await arb.loadVirtual().catch(er => {51      log.verbose('loadVirtual', er.stack)52      const msg =53        'The `npm ci` command can only install with an existing package-lock.json or\n' +54        'npm-shrinkwrap.json with lockfileVersion >= 1. Run an install with npm@5 or\n' +55        'later to generate a package-lock.json file, then try again.'56      throw this.usageError(msg)57    })58 59    // retrieves inventory of packages from loaded virtual tree (lock file)60    const virtualInventory = new Map(arb.virtualTree.inventory)61 62    // build ideal tree step needs to come right after retrieving the virtual63    // inventory since it's going to erase the previous ref to virtualTree64    await arb.buildIdealTree()65 66    // verifies that the packages from the ideal tree will match67    // the same versions that are present in the virtual tree (lock file)68    // throws a validation error in case of mismatches69    const errors = validateLockfile(virtualInventory, arb.idealTree.inventory)70    if (errors.length) {71      throw this.usageError(72        '`npm ci` can only install packages when your package.json and ' +73        'package-lock.json or npm-shrinkwrap.json are in sync. Please ' +74        'update your lock file with `npm install` ' +75        'before continuing.\n\n' +76        errors.join('\n')77      )78    }79 80    const dryRun = this.npm.config.get('dry-run')81    if (!dryRun) {82      const workspacePaths = await getWorkspaces([], {83        path: this.npm.localPrefix,84        includeWorkspaceRoot: true,85      })86 87      // Only remove node_modules after we've successfully loaded the virtual88      // tree and validated the lockfile89      await time.start('npm-ci:rm', async () => {90        return await Promise.all([...workspacePaths.values()].map(async modulePath => {91          const fullPath = path.join(modulePath, 'node_modules')92          // get the list of entries so we can skip the glob for performance93          const entries = await fs.readdir(fullPath, null).catch(() => [])94          return Promise.all(entries.map(folder => {95            return fs.rm(path.join(fullPath, folder), { force: true, recursive: true })96          }))97        }))98      })99    }100 101    await arb.reify(opts)102 103    const ignoreScripts = this.npm.config.get('ignore-scripts')104    // run the same set of scripts that `npm install` runs.105    if (!ignoreScripts) {106      const scripts = [107        'preinstall',108        'install',109        'postinstall',110        'prepublish', // XXX should we remove this finally??111        'preprepare',112        'prepare',113        'postprepare',114      ]115      const scriptShell = this.npm.config.get('script-shell') || undefined116      for (const event of scripts) {117        await runScript({118          path: where,119          args: [],120          scriptShell,121          stdio: 'inherit',122          event,123        })124      }125    }126    await reifyFinish(this.npm, arb)127  }128}129 130module.exports = CI131