File Explorer

1const reifyFinish = require('../utils/reify-finish.js')2const resolveAllowScripts = require('../utils/resolve-allow-scripts.js')3const strictAllowScriptsPreflight = require('../utils/strict-allow-scripts-preflight.js')4const runScript = require('@npmcli/run-script')5const fs = require('node:fs/promises')6const path = require('node:path')7const { log, time } = require('proc-log')8const validateLockfile = require('../utils/validate-lockfile.js')9const ArboristWorkspaceCmd = require('../arborist-cmd.js')10const getWorkspaces = require('../utils/get-workspaces.js')11 12class CI extends ArboristWorkspaceCmd {13  static description = 'Clean install a project'14  static name = 'ci'15 16  // These are in the order they will show up in when running "-h"17  static params = [18    'install-strategy',19    'legacy-bundling',20    'global-style',21    'omit',22    'include',23    'strict-peer-deps',24    'foreground-scripts',25    'ignore-scripts',26    'allow-directory',27    'allow-file',28    'allow-git',29    'allow-remote',30    'allow-scripts',31    'strict-allow-scripts',32    'dangerously-allow-all-scripts',33    'audit',34    'bin-links',35    'fund',36    'dry-run',37    ...super.params,38  ]39 40  async exec () {41    if (this.npm.global) {42      throw Object.assign(new Error('`npm ci` does not work for global packages'), {43        code: 'ECIGLOBAL',44      })45    }46 47    const dryRun = this.npm.config.get('dry-run')48    const ignoreScripts = this.npm.config.get('ignore-scripts')49    const where = this.npm.prefix50    const Arborist = require('@npmcli/arborist')51    const { policy: allowScriptsPolicy } = await resolveAllowScripts(this.npm)52    const opts = {53      ...this.npm.flatOptions,54      packageLock: true, // npm ci should never skip lock files55      path: where,56      save: false, // npm ci should never modify the lockfile or package.json57      workspaces: this.workspaceNames,58      allowScripts: allowScriptsPolicy,59    }60 61    // generate an inventory from the virtual tree in the lockfile62    const virtualArb = new Arborist(opts)63    try {64      await virtualArb.loadVirtual()65    } catch (err) {66      log.verbose('loadVirtual', err.stack)67      const msg =68        'The `npm ci` command can only install with an existing package-lock.json or\n' +69        'npm-shrinkwrap.json with lockfileVersion >= 1. Run an install with npm@5 or\n' +70        'later to generate a package-lock.json file, then try again.'71      throw this.usageError(msg)72    }73    const virtualInventory = new Map(virtualArb.virtualTree.inventory)74 75    // Now we make our real Arborist.76    // We need a new one because the virtual tree fromt the lockfile can have extraneous dependencies in it that won't install on this platform77    const arb = new Arborist(opts)78    await arb.buildIdealTree()79    await strictAllowScriptsPreflight({ arb, npm: this.npm, idealTreeOpts: opts })80 81    // Verifies that the packages from the ideal tree will match the same versions that are present in the virtual tree (lock file).82    const errors = validateLockfile(virtualInventory, arb.idealTree.inventory)83    if (errors.length) {84      throw this.usageError(85        '`npm ci` can only install packages when your package.json and package-lock.json or npm-shrinkwrap.json are in sync. ' +86        'Please update your lock file with `npm install` before continuing.\n\n' +87        errors.join('\n')88      )89    }90 91    if (!dryRun) {92      const workspacePaths = await getWorkspaces([], {93        path: this.npm.localPrefix,94        includeWorkspaceRoot: true,95      })96 97      // Only remove node_modules after we've successfully loaded the virtual tree and validated the lockfile98      await time.start('npm-ci:rm', async () => {99        return await Promise.all([...workspacePaths.values()].map(async modulePath => {100          const fullPath = path.join(modulePath, 'node_modules')101          // get the list of entries so we can skip the glob for performance102          const entries = await fs.readdir(fullPath, null).catch(() => [])103          return Promise.all(entries.map(folder => {104            return fs.rm(path.join(fullPath, folder), { force: true, recursive: true })105          }))106        }))107      })108    }109 110    await arb.reify(opts)111 112    // run the same set of scripts that `npm install` runs.113    if (!ignoreScripts) {114      const scripts = [115        'preinstall',116        'install',117        'postinstall',118        'prepublish', // XXX should we remove this finally??119        'preprepare',120        'prepare',121        'postprepare',122      ]123      const scriptShell = this.npm.config.get('script-shell') || undefined124      for (const event of scripts) {125        await runScript({126          path: where,127          args: [],128          scriptShell,129          stdio: 'inherit',130          event,131        })132      }133    }134    await reifyFinish(this.npm, arb)135  }136}137 138module.exports = CI139