File Explorer

1const { resolve, basename } = require('node:path')2const { unlink } = require('node:fs/promises')3const { log } = require('proc-log')4const BaseCommand = require('../base-cmd.js')5 6class Shrinkwrap extends BaseCommand {7  static description = 'Lock down dependency versions for publication'8  static name = 'shrinkwrap'9  static ignoreImplicitWorkspace = false10 11  async exec () {12    // if has a npm-shrinkwrap.json, nothing to do13    // if has a package-lock.json, rename to npm-shrinkwrap.json14    // if has neither, load the actual tree and save that as npm-shrinkwrap.json15    //16    // loadVirtual, fall back to loadActual17    // rename shrinkwrap file type, and tree.meta.save()18    if (this.npm.global) {19      const er = new Error('`npm shrinkwrap` does not work for global packages')20      er.code = 'ESHRINKWRAPGLOBAL'21      throw er22    }23 24    const Arborist = require('@npmcli/arborist')25    const path = this.npm.prefix26    const sw = resolve(path, 'npm-shrinkwrap.json')27    const arb = new Arborist({ ...this.npm.flatOptions, path })28    const tree = await arb.loadVirtual().catch(() => arb.loadActual())29    const { meta } = tree30    const newFile = meta.hiddenLockfile || !meta.loadedFromDisk31    const oldFilename = meta.filename32    const notSW = !newFile && basename(oldFilename) !== 'npm-shrinkwrap.json'33 34    // The computed lockfile version of a hidden lockfile is always 335    // even if the actual value of the property is a different.36    // When shrinkwrap is run with only a hidden lockfile we want to37    // set the shrinkwrap lockfile version as whatever was explicitly38    // requested with a fallback to the actual value from the hidden39    // lockfile.40    if (meta.hiddenLockfile) {41      meta.lockfileVersion = arb.options.lockfileVersion ||42        meta.originalLockfileVersion43    }44    meta.hiddenLockfile = false45    meta.filename = sw46    await meta.save()47 48    const updatedVersion = meta.originalLockfileVersion !== meta.lockfileVersion49      ? meta.lockfileVersion50      : null51 52    if (newFile) {53      let message = 'created a lockfile as npm-shrinkwrap.json'54      if (updatedVersion) {55        message += ` with version ${updatedVersion}`56      }57      log.notice('', message)58    } else if (notSW) {59      await unlink(oldFilename)60      let message = 'package-lock.json has been renamed to npm-shrinkwrap.json'61      if (updatedVersion) {62        message += ` and updated to version ${updatedVersion}`63      }64      log.notice('', message)65    } else if (updatedVersion) {66      log.notice('', `npm-shrinkwrap.json updated to version ${updatedVersion}`)67    } else {68      log.notice('', 'npm-shrinkwrap.json up to date')69    }70  }71}72 73module.exports = Shrinkwrap74