PHP 8.2.31
Preview: explain.js Size: 3.55 KB
/proc/self/root/opt/alt/alt-nodejs24/root/lib/node_modules/npm/lib/commands/explain.js

const { explainNode } = require('../utils/explain-dep.js')
const npa = require('npm-package-arg')
const semver = require('semver')
const { relative, resolve } = require('node:path')
const validName = require('validate-npm-package-name')
const { output } = require('proc-log')
const ArboristWorkspaceCmd = require('../arborist-cmd.js')

class Explain extends ArboristWorkspaceCmd {
  static description = 'Explain installed packages'
  static name = 'explain'
  static usage = ['<package-spec>']
  static params = [
    'json',
    'workspace',
  ]

  static ignoreImplicitWorkspace = false

  static async completion (opts, npm) {
    const completion = require('../utils/installed-deep.js')
    return completion(npm, opts)
  }

  async exec (args) {
    if (!args.length) {
      throw this.usageError()
    }

    const Arborist = require('@npmcli/arborist')
    const arb = new Arborist({ path: this.npm.prefix, ...this.npm.flatOptions })
    const tree = await arb.loadActual()

    if (this.npm.flatOptions.workspacesEnabled
      && this.workspaceNames
      && this.workspaceNames.length
    ) {
      this.filterSet = arb.workspaceDependencySet(tree, this.workspaceNames)
    } else if (!this.npm.flatOptions.workspacesEnabled) {
      this.filterSet =
        arb.excludeWorkspacesDependencySet(tree)
    }

    const nodes = new Set()
    for (const arg of args) {
      for (const node of this.getNodes(tree, arg)) {
        const filteredOut = this.filterSet
          && this.filterSet.size > 0
          && !this.filterSet.has(node)
        if (!filteredOut) {
          nodes.add(node)
        }
      }
    }
    if (nodes.size === 0) {
      throw new Error(`No dependencies found matching ${args.join(', ')}`)
    }

    const expls = []
    for (const node of nodes) {
      const { extraneous, dev, optional, devOptional, peer, inBundle, overridden } = node
      const expl = node.explain()
      if (extraneous) {
        expl.extraneous = true
      } else {
        expl.dev = dev
        expl.optional = optional
        expl.devOptional = devOptional
        expl.peer = peer
        expl.bundled = inBundle
        expl.overridden = overridden
      }
      expls.push(expl)
    }

    if (this.npm.flatOptions.json) {
      output.buffer(expls)
    } else {
      output.standard(expls.map(expl => {
        return explainNode(expl, Infinity, this.npm.chalk)
      }).join('\n\n'))
    }
  }

  getNodes (tree, arg) {
    // if it's just a name, return packages by that name
    const { validForOldPackages: valid } = validName(arg)
    if (valid) {
      return tree.inventory.query('packageName', arg)
    }

    // if it's a location, get that node
    const maybeLoc = arg.replace(/\\/g, '/').replace(/(?<!\/)\/+$/, '')
    const nodeByLoc = tree.inventory.get(maybeLoc)
    if (nodeByLoc) {
      return [nodeByLoc]
    }

    // maybe a path to a node_modules folder
    const maybePath = relative(this.npm.prefix, resolve(maybeLoc))
      .replace(/\\/g, '/').replace(/(?<!\/)\/+$/, '')
    const nodeByPath = tree.inventory.get(maybePath)
    if (nodeByPath) {
      return [nodeByPath]
    }

    // otherwise, try to select all matching nodes
    try {
      return this.getNodesByVersion(tree, arg)
    } catch {
      return []
    }
  }

  getNodesByVersion (tree, arg) {
    const spec = npa(arg, this.npm.prefix)
    if (spec.type !== 'version' && spec.type !== 'range') {
      return []
    }

    return tree.inventory.filter(node => {
      return node.package.name === spec.name &&
        semver.satisfies(node.package.version, spec.rawSpec)
    })
  }
}

module.exports = Explain

Directory Contents

Dirs: 1 × Files: 67

Name Size Perms Modified Actions
trust DIR
- drwxr-xr-x 2026-05-14 21:13:30
Edit Download
6.17 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
1.29 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
3.17 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
847 B lrw-r--r-- 2026-04-24 15:56:02
Edit Download
11.48 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
4.24 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
10.83 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
11.48 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
1.42 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
2.43 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
7.92 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
5.50 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
449 B lrw-r--r-- 2026-04-24 15:56:02
Edit Download
9.99 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
1.72 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
3.39 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
3.55 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
2.11 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
578 B lrw-r--r-- 2026-04-24 15:56:02
Edit Download
6.38 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
538 B lrw-r--r-- 2026-04-24 15:56:02
Edit Download
5.53 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
3.64 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
7.02 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
308 B lrw-r--r-- 2026-04-24 15:56:02
Edit Download
303 B lrw-r--r-- 2026-04-24 15:56:02
Edit Download
5.10 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
5.24 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
234 B lrw-r--r-- 2026-04-24 15:56:02
Edit Download
1.29 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
1.42 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
18.03 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
3.96 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
7.92 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
5.95 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
2.77 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
873 B lrw-r--r-- 2026-04-24 15:56:02
Edit Download
3.58 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
309 B lrw-r--r-- 2026-04-24 15:56:02
Edit Download
10.30 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
770 B lrw-r--r-- 2026-04-24 15:56:02
Edit Download
9.47 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
3.75 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
2.15 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
1.24 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
303 B lrw-r--r-- 2026-04-24 15:56:02
Edit Download
295 B lrw-r--r-- 2026-04-24 15:56:02
Edit Download
6.27 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
4.47 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
1.83 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
632 B lrw-r--r-- 2026-04-24 15:56:02
Edit Download
2.63 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
1.88 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
1.03 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
293 B lrw-r--r-- 2026-04-24 15:56:02
Edit Download
288 B lrw-r--r-- 2026-04-24 15:56:02
Edit Download
4.33 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
288 B lrw-r--r-- 2026-04-24 15:56:02
Edit Download
7.96 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
302 B lrw-r--r-- 2026-04-24 15:56:02
Edit Download
1.49 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
5.24 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
183 B lrw-r--r-- 2026-04-24 15:56:02
Edit Download
1.69 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
3.54 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
13.48 KB lrw-r--r-- 2026-04-24 15:56:02
Edit Download
527 B lrw-r--r-- 2026-04-24 15:56:02
Edit Download

If ZipArchive is unavailable, a .tar will be created (no compression).