mirror of
https://github.com/nodejs/node.git
synced 2025-05-20 21:13:12 +00:00
bc531d1860
PR-URL: https://github.com/nodejs/node/pull/38030 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Ruy Adorno <ruyadorno@github.com>
77 lines
2.6 KiB
JavaScript
77 lines
2.6 KiB
JavaScript
// this is called when an ERESOLVE error is caught in the error-handler,
|
|
// or when there's a log.warn('eresolve', msg, explanation), to turn it
|
|
// into a human-intelligible explanation of what's wrong and how to fix.
|
|
//
|
|
// TODO: abstract out the explainNode methods into a separate util for
|
|
// use by a future `npm explain <path || spec>` command.
|
|
|
|
const npm = require('../npm.js')
|
|
const { writeFileSync } = require('fs')
|
|
const { resolve } = require('path')
|
|
const { explainEdge, explainNode, printNode } = require('./explain-dep.js')
|
|
|
|
// expl is an explanation object that comes from Arborist. It looks like:
|
|
// Depth is how far we want to want to descend into the object making a report.
|
|
// The full report (ie, depth=Infinity) is always written to the cache folder
|
|
// at ${cache}/eresolve-report.txt along with full json.
|
|
const explainEresolve = (expl, color, depth) => {
|
|
const { edge, current, peerConflict, currentEdge } = expl
|
|
|
|
const out = []
|
|
if (edge.from && edge.from.whileInstalling)
|
|
out.push('While resolving: ' + printNode(edge.from.whileInstalling, color))
|
|
|
|
// it "should" be impossible for an ERESOLVE explanation to lack both
|
|
// current and currentEdge, but better to have a less helpful error
|
|
// than a crashing failure.
|
|
if (current)
|
|
out.push('Found: ' + explainNode(current, depth, color))
|
|
else if (currentEdge)
|
|
out.push('Found: ' + explainEdge(currentEdge, depth, color))
|
|
|
|
out.push('\nCould not resolve dependency:\n' +
|
|
explainEdge(edge, depth, color))
|
|
|
|
if (peerConflict) {
|
|
const heading = '\nConflicting peer dependency:'
|
|
const pc = explainNode(peerConflict, depth, color)
|
|
out.push(heading + ' ' + pc)
|
|
}
|
|
|
|
return out.join('\n')
|
|
}
|
|
|
|
// generate a full verbose report and tell the user how to fix it
|
|
const report = (expl, depth = 4) => {
|
|
const fullReport = resolve(npm.cache, 'eresolve-report.txt')
|
|
|
|
const orNoStrict = expl.strictPeerDeps ? '--no-strict-peer-deps, ' : ''
|
|
const fix = `Fix the upstream dependency conflict, or retry
|
|
this command with ${orNoStrict}--force, or --legacy-peer-deps
|
|
to accept an incorrect (and potentially broken) dependency resolution.`
|
|
|
|
writeFileSync(fullReport, `# npm resolution error report
|
|
|
|
${new Date().toISOString()}
|
|
|
|
${explainEresolve(expl, false, Infinity)}
|
|
|
|
${fix}
|
|
|
|
Raw JSON explanation object:
|
|
|
|
${JSON.stringify(expl, null, 2)}
|
|
`, 'utf8')
|
|
|
|
return explainEresolve(expl, npm.color, depth) +
|
|
`\n\n${fix}\n\nSee ${fullReport} for a full report.`
|
|
}
|
|
|
|
// the terser explain method for the warning when using --force
|
|
const explain = (expl, depth = 2) => explainEresolve(expl, npm.color, depth)
|
|
|
|
module.exports = {
|
|
explain,
|
|
report,
|
|
}
|