e75ac3c918PR-URL: https://github.com/nodejs/node/pull/62448 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
116 lines
3.6 KiB
JavaScript
116 lines
3.6 KiB
JavaScript
const { relative } = require('node:path')
|
|
|
|
const explainNode = (node, depth, chalk, seen = new Set()) =>
|
|
printNode(node, chalk) +
|
|
explainDependents(node, depth, chalk, seen) +
|
|
explainLinksIn(node, depth, chalk, seen)
|
|
|
|
const colorType = (type, chalk) => {
|
|
const style = type === 'extraneous' ? chalk.red
|
|
: type === 'dev' ? chalk.blue
|
|
: type === 'optional' ? chalk.magenta
|
|
: type === 'peer' ? chalk.magentaBright
|
|
: type === 'bundled' ? chalk.underline.cyan
|
|
: type === 'workspace' ? chalk.blueBright
|
|
: type === 'overridden' ? chalk.dim
|
|
: /* istanbul ignore next */ s => s
|
|
return style(type)
|
|
}
|
|
|
|
const printNode = (node, chalk) => {
|
|
const extra = []
|
|
|
|
for (const meta of ['extraneous', 'dev', 'optional', 'peer', 'bundled', 'overridden']) {
|
|
if (node[meta]) {
|
|
extra.push(` ${colorType(meta, chalk)}`)
|
|
}
|
|
}
|
|
|
|
const pkgid = node.isWorkspace
|
|
? chalk.blueBright(`${node.name}@${node.version}`)
|
|
: `${node.name}@${node.version}`
|
|
|
|
return `${pkgid}${extra.join('')}` +
|
|
(node.location ? chalk.dim(`\n${node.location}`) : '')
|
|
}
|
|
|
|
const explainLinksIn = ({ linksIn }, depth, chalk, seen) => {
|
|
if (!linksIn || !linksIn.length || depth <= 0) {
|
|
return ''
|
|
}
|
|
|
|
const messages = linksIn.map(link => explainNode(link, depth - 1, chalk, seen))
|
|
const str = '\n' + messages.join('\n')
|
|
return str.split('\n').join('\n ')
|
|
}
|
|
|
|
const explainDependents = ({ dependents }, depth, chalk, seen) => {
|
|
if (!dependents || !dependents.length || depth <= 0) {
|
|
return ''
|
|
}
|
|
|
|
const max = Math.ceil(depth / 2)
|
|
const messages = dependents.slice(0, max)
|
|
.map(edge => explainEdge(edge, depth, chalk, seen))
|
|
|
|
// show just the names of the first 5 deps that overflowed the list
|
|
if (dependents.length > max) {
|
|
let len = 0
|
|
const maxLen = 50
|
|
const showNames = []
|
|
for (let i = max; i < dependents.length; i++) {
|
|
const { from: { name: depName = 'the root project' } } = dependents[i]
|
|
len += depName.length
|
|
if (len >= maxLen && i < dependents.length - 1) {
|
|
showNames.push('...')
|
|
break
|
|
}
|
|
showNames.push(depName)
|
|
}
|
|
const show = `(${showNames.join(', ')})`
|
|
messages.push(`${dependents.length - max} more ${show}`)
|
|
}
|
|
|
|
const str = '\n' + messages.join('\n')
|
|
return str.split('\n').join('\n ')
|
|
}
|
|
|
|
const explainEdge = (
|
|
{ name, type, bundled, from, spec, rawSpec, overridden },
|
|
depth, chalk, seen = new Set()
|
|
) => {
|
|
let dep = type === 'workspace'
|
|
? chalk.bold(relative(from.location, spec.slice('file:'.length)))
|
|
: `${name}@"${spec}"`
|
|
if (overridden) {
|
|
dep = `${colorType('overridden', chalk)} ${dep} (was "${rawSpec}")`
|
|
}
|
|
|
|
const fromMsg = ` from ${explainFrom(from, depth, chalk, seen)}`
|
|
|
|
return (type === 'prod' ? '' : `${colorType(type, chalk)} `) +
|
|
(bundled ? `${colorType('bundled', chalk)} ` : '') +
|
|
`${dep}${fromMsg}`
|
|
}
|
|
|
|
const explainFrom = (from, depth, chalk, seen) => {
|
|
if (!from.name && !from.version) {
|
|
return 'the root project'
|
|
}
|
|
|
|
// Prevent infinite recursion from cycles in the dependency graph (e.g. linked strategy store nodes). Use stack-based tracking so diamond dependencies (same node reached via different paths) are still explained, but recursive cycles are broken.
|
|
const nodeId = `${from.name}@${from.version}:${from.location}`
|
|
if (seen.has(nodeId)) {
|
|
return printNode(from, chalk)
|
|
}
|
|
seen.add(nodeId)
|
|
|
|
const result = printNode(from, chalk) +
|
|
explainDependents(from, depth - 1, chalk, seen) +
|
|
explainLinksIn(from, depth - 1, chalk, seen)
|
|
|
|
seen.delete(nodeId)
|
|
return result
|
|
}
|
|
|
|
module.exports = { explainNode, printNode, explainEdge }
|