@yarnpkg/plugin-essentials 4.1.2 → 4.2.0

package/lib/commands/explain/peerRequirements.d.ts

@@ -4,9 +4,12 @@ import { Writable } from 'stream';
 export default class ExplainPeerRequirementsCommand extends BaseCommand {
     static paths: string[][];
     static usage: import("clipanion").Usage;
-    hash: string;
+    hash: string | undefined;
     execute(): Promise<0 | 1>;
 }
-export declare function explainPeerRequirements(peerRequirementsHash: string, project: Project, opts: {
+export declare function explainPeerRequirement(peerRequirementsHash: string, project: Project, opts: {
+    stdout: Writable;
+}): Promise<0 | 1>;
+export declare function explainPeerRequirements(project: Project, opts: {
     stdout: Writable;
 }): Promise<0 | 1>;

package/lib/commands/explain/peerRequirements.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.explainPeerRequirement = explainPeerRequirement;
 exports.explainPeerRequirements = explainPeerRequirements;
 const tslib_1 = require("tslib");
 const cli_1 = require("@yarnpkg/cli");
@@ -11,6 +12,7 @@ class ExplainPeerRequirementsCommand extends cli_1.BaseCommand {
     constructor() {
         super(...arguments);
         this.hash = clipanion_1.Option.String({
+            required: false,
             validator: t.cascade(t.isString(), [
                 t.matchesRegExp(/^p[0-9a-f]{5}$/),
             ]),
@@ -23,9 +25,16 @@ class ExplainPeerRequirementsCommand extends cli_1.BaseCommand {
             restoreResolutions: false,
         });
         await project.applyLightResolution();
-        return await explainPeerRequirements(this.hash, project, {
-            stdout: this.context.stdout,
-        });
+        if (typeof this.hash !== `undefined`) {
+            return await explainPeerRequirement(this.hash, project, {
+                stdout: this.context.stdout,
+            });
+        }
+        else {
+            return await explainPeerRequirements(project, {
+                stdout: this.context.stdout,
+            });
+        }
     }
 }
 ExplainPeerRequirementsCommand.paths = [
@@ -34,29 +43,51 @@ ExplainPeerRequirementsCommand.paths = [
 ExplainPeerRequirementsCommand.usage = clipanion_1.Command.Usage({
     description: `explain a set of peer requirements`,
     details: `
-      A set of peer requirements represents all peer requirements that a dependent must satisfy when providing a given peer request to a requester and its descendants.
+      A peer requirement represents all peer requests that a subject must satisfy when providing a requested package to requesters.
 
-      When the hash argument is specified, this command prints a detailed explanation of all requirements of the set corresponding to the hash and whether they're satisfied or not.
+      When the hash argument is specified, this command prints a detailed explanation of the peer requirement corresponding to the hash and whether it is satisfied or not.
 
-      When used without arguments, this command lists all sets of peer requirements and the corresponding hash that can be used to get detailed information about a given set.
+      When used without arguments, this command lists all peer requirements and the corresponding hash that can be used to get detailed information about a given requirement.
 
       **Note:** A hash is a six-letter p-prefixed code that can be obtained from peer dependency warnings or from the list of all peer requirements (\`yarn explain peer-requirements\`).
     `,
     examples: [[
-            `Explain the corresponding set of peer requirements for a hash`,
+            `Explain the corresponding peer requirement for a hash`,
             `$0 explain peer-requirements p1a4ed`,
         ], [
-            `List all sets of peer requirements`,
+            `List all peer requirements`,
             `$0 explain peer-requirements`,
         ]],
 });
 exports.default = ExplainPeerRequirementsCommand;
-async function explainPeerRequirements(peerRequirementsHash, project, opts) {
+async function explainPeerRequirement(peerRequirementsHash, project, opts) {
+    const root = project.peerRequirementNodes.get(peerRequirementsHash);
+    if (typeof root === `undefined`)
+        throw new Error(`No peerDependency requirements found for hash: "${peerRequirementsHash}"`);
+    const seen = new Set();
+    const makeTreeNode = (request) => {
+        if (seen.has(request.requester.locatorHash)) {
+            return {
+                value: core_1.formatUtils.tuple(core_1.formatUtils.Type.DEPENDENT, { locator: request.requester, descriptor: request.descriptor }),
+                children: request.children.size > 0
+                    ? [{ value: core_1.formatUtils.tuple(core_1.formatUtils.Type.NO_HINT, `...`) }]
+                    : [],
+            };
+        }
+        seen.add(request.requester.locatorHash);
+        return {
+            value: core_1.formatUtils.tuple(core_1.formatUtils.Type.DEPENDENT, { locator: request.requester, descriptor: request.descriptor }),
+            children: Object.fromEntries(Array.from(request.children.values(), child => {
+                return [
+                    core_1.structUtils.stringifyLocator(child.requester),
+                    makeTreeNode(child),
+                ];
+            })),
+        };
+    };
     const warning = project.peerWarnings.find(warning => {
         return warning.hash === peerRequirementsHash;
     });
-    if (typeof warning === `undefined`)
-        throw new Error(`No peerDependency requirements found for hash: "${peerRequirementsHash}"`);
     const report = await core_1.StreamReport.start({
         configuration: project.configuration,
         stdout: opts.stdout,
@@ -64,71 +95,97 @@ async function explainPeerRequirements(peerRequirementsHash, project, opts) {
         includePrefix: false,
     }, async (report) => {
         const Marks = core_1.formatUtils.mark(project.configuration);
-        switch (warning.type) {
-            case core_1.PeerWarningType.NotCompatibleAggregate:
-                {
-                    report.reportInfo(core_1.MessageName.UNNAMED, `We have a problem with ${core_1.formatUtils.pretty(project.configuration, warning.requested, core_1.formatUtils.Type.IDENT)}, which is provided with version ${core_1.structUtils.prettyReference(project.configuration, warning.version)}.`);
-                    report.reportInfo(core_1.MessageName.UNNAMED, `It is needed by the following direct dependencies of workspaces in your project:`);
-                    report.reportSeparator();
-                    for (const dependent of warning.requesters.values()) {
-                        const dependentPkg = project.storedPackages.get(dependent.locatorHash);
-                        if (!dependentPkg)
-                            throw new Error(`Assertion failed: Expected the package to be registered`);
-                        const descriptor = dependentPkg?.peerDependencies.get(warning.requested.identHash);
-                        if (!descriptor)
-                            throw new Error(`Assertion failed: Expected the package to list the peer dependency`);
-                        const mark = core_1.semverUtils.satisfiesWithPrereleases(warning.version, descriptor.range)
-                            ? Marks.Check
-                            : Marks.Cross;
-                        report.reportInfo(null, `  ${mark} ${core_1.structUtils.prettyLocator(project.configuration, dependent)} (via ${core_1.structUtils.prettyRange(project.configuration, descriptor.range)})`);
-                    }
-                    const transitiveLinks = [...warning.links.values()].filter(link => {
-                        return !warning.requesters.has(link.locatorHash);
-                    });
-                    if (transitiveLinks.length > 0) {
-                        report.reportSeparator();
-                        report.reportInfo(core_1.MessageName.UNNAMED, `However, those packages themselves have more dependencies listing ${core_1.structUtils.prettyIdent(project.configuration, warning.requested)} as peer dependency:`);
-                        report.reportSeparator();
-                        for (const link of transitiveLinks) {
-                            const linkPkg = project.storedPackages.get(link.locatorHash);
-                            if (!linkPkg)
-                                throw new Error(`Assertion failed: Expected the package to be registered`);
-                            const descriptor = linkPkg?.peerDependencies.get(warning.requested.identHash);
-                            if (!descriptor)
-                                throw new Error(`Assertion failed: Expected the package to list the peer dependency`);
-                            const mark = core_1.semverUtils.satisfiesWithPrereleases(warning.version, descriptor.range)
-                                ? Marks.Check
-                                : Marks.Cross;
-                            report.reportInfo(null, `  ${mark} ${core_1.structUtils.prettyLocator(project.configuration, link)} (via ${core_1.structUtils.prettyRange(project.configuration, descriptor.range)})`);
-                        }
-                    }
-                    const allRanges = Array.from(warning.links.values(), locator => {
-                        const pkg = project.storedPackages.get(locator.locatorHash);
-                        if (typeof pkg === `undefined`)
-                            throw new Error(`Assertion failed: Expected the package to be registered`);
-                        const peerDependency = pkg.peerDependencies.get(warning.requested.identHash);
-                        if (typeof peerDependency === `undefined`)
-                            throw new Error(`Assertion failed: Expected the ident to be registered`);
-                        return peerDependency.range;
-                    });
-                    if (allRanges.length > 1) {
-                        const resolvedRange = core_1.semverUtils.simplifyRanges(allRanges);
-                        report.reportSeparator();
-                        if (resolvedRange === null) {
-                            report.reportInfo(core_1.MessageName.UNNAMED, `Unfortunately, put together, we found no single range that can satisfy all those peer requirements.`);
-                            report.reportInfo(core_1.MessageName.UNNAMED, `Your best option may be to try to upgrade some dependencies with ${core_1.formatUtils.pretty(project.configuration, `yarn up`, core_1.formatUtils.Type.CODE)}, or silence the warning via ${core_1.formatUtils.pretty(project.configuration, `logFilters`, core_1.formatUtils.Type.CODE)}.`);
-                        }
-                        else {
-                            report.reportInfo(core_1.MessageName.UNNAMED, `Put together, the final range we computed is ${core_1.formatUtils.pretty(project.configuration, resolvedRange, core_1.formatUtils.Type.RANGE)}`);
-                        }
-                    }
+        const mark = warning ? Marks.Cross : Marks.Check;
+        report.reportInfo(core_1.MessageName.UNNAMED, `Package ${core_1.formatUtils.pretty(project.configuration, root.subject, core_1.formatUtils.Type.LOCATOR)} is requested to provide ${core_1.formatUtils.pretty(project.configuration, root.ident, core_1.formatUtils.Type.IDENT)} by its descendants`);
+        report.reportSeparator();
+        report.reportInfo(core_1.MessageName.UNNAMED, core_1.formatUtils.pretty(project.configuration, root.subject, core_1.formatUtils.Type.LOCATOR));
+        core_1.treeUtils.emitTree({
+            children: Object.fromEntries(Array.from(root.requests.values(), request => {
+                return [
+                    core_1.structUtils.stringifyLocator(request.requester),
+                    makeTreeNode(request),
+                ];
+            })),
+        }, {
+            configuration: project.configuration,
+            stdout: opts.stdout,
+            json: false,
+        });
+        report.reportSeparator();
+        if (root.provided.range === `missing:`) {
+            const problem = warning ? `` : ` , but all peer requests are optional`;
+            report.reportInfo(core_1.MessageName.UNNAMED, `${mark} Package ${core_1.formatUtils.pretty(project.configuration, root.subject, core_1.formatUtils.Type.LOCATOR)} does not provide ${core_1.formatUtils.pretty(project.configuration, root.ident, core_1.formatUtils.Type.IDENT)}${problem}.`);
+        }
+        else {
+            const providedLocatorHash = project.storedResolutions.get(root.provided.descriptorHash);
+            if (!providedLocatorHash)
+                throw new Error(`Assertion failed: Expected the descriptor to be registered`);
+            const providedPackage = project.storedPackages.get(providedLocatorHash);
+            if (!providedPackage)
+                throw new Error(`Assertion failed: Expected the package to be registered`);
+            report.reportInfo(core_1.MessageName.UNNAMED, `${mark} Package ${core_1.formatUtils.pretty(project.configuration, root.subject, core_1.formatUtils.Type.LOCATOR)} provides ${core_1.formatUtils.pretty(project.configuration, root.ident, core_1.formatUtils.Type.IDENT)} with version ${core_1.structUtils.prettyReference(project.configuration, providedPackage.version ?? `0.0.0`)}, ${warning ? `which does not satisfy all requests.` : `which satisfies all requests`}`);
+            if (warning?.type === core_1.PeerWarningType.NodeNotCompatible) {
+                if (warning.range) {
+                    report.reportInfo(core_1.MessageName.UNNAMED, `  The combined requested range is ${core_1.formatUtils.pretty(project.configuration, warning.range, core_1.formatUtils.Type.RANGE)}`);
+                }
+                else {
+                    report.reportInfo(core_1.MessageName.UNNAMED, `  Unfortunately, the requested ranges have no overlap`);
+                }
+            }
+        }
+    });
+    return report.exitCode();
+}
+async function explainPeerRequirements(project, opts) {
+    const report = await core_1.StreamReport.start({
+        configuration: project.configuration,
+        stdout: opts.stdout,
+        includeFooter: false,
+        includePrefix: false,
+    }, async (report) => {
+        const Marks = core_1.formatUtils.mark(project.configuration);
+        const sorted = core_1.miscUtils.sortMap(project.peerRequirementNodes, [
+            ([, requirement]) => core_1.structUtils.stringifyLocator(requirement.subject),
+            ([, requirement]) => core_1.structUtils.stringifyIdent(requirement.ident),
+        ]);
+        for (const [, peerRequirement] of sorted.values()) {
+            if (!peerRequirement.root)
+                continue;
+            const warning = project.peerWarnings.find(warning => {
+                return warning.hash === peerRequirement.hash;
+            });
+            const allRequests = [...core_1.structUtils.allPeerRequests(peerRequirement)];
+            let andOthers;
+            if (allRequests.length > 2)
+                andOthers = ` and ${allRequests.length - 1} other dependencies`;
+            else if (allRequests.length === 2)
+                andOthers = ` and 1 other dependency`;
+            else
+                andOthers = ``;
+            if (peerRequirement.provided.range !== `missing:`) {
+                const providedResolution = project.storedResolutions.get(peerRequirement.provided.descriptorHash);
+                if (!providedResolution)
+                    throw new Error(`Assertion failed: Expected the resolution to have been registered`);
+                const providedPkg = project.storedPackages.get(providedResolution);
+                if (!providedPkg)
+                    throw new Error(`Assertion failed: Expected the provided package to have been registered`);
+                const message = `${core_1.formatUtils.pretty(project.configuration, peerRequirement.hash, core_1.formatUtils.Type.CODE)} → ${warning ? Marks.Cross : Marks.Check} ${core_1.structUtils.prettyLocator(project.configuration, peerRequirement.subject)} provides ${core_1.structUtils.prettyLocator(project.configuration, providedPkg)} to ${core_1.structUtils.prettyLocator(project.configuration, allRequests[0].requester)}${andOthers}`;
+                if (warning) {
+                    report.reportWarning(core_1.MessageName.UNNAMED, message);
+                }
+                else {
+                    report.reportInfo(core_1.MessageName.UNNAMED, message);
+                }
+            }
+            else {
+                const message = `${core_1.formatUtils.pretty(project.configuration, peerRequirement.hash, core_1.formatUtils.Type.CODE)} → ${warning ? Marks.Cross : Marks.Check} ${core_1.structUtils.prettyLocator(project.configuration, peerRequirement.subject)} doesn't provide ${core_1.structUtils.prettyIdent(project.configuration, peerRequirement.ident)} to ${core_1.structUtils.prettyLocator(project.configuration, allRequests[0].requester)}${andOthers}`;
+                if (warning) {
+                    report.reportWarning(core_1.MessageName.UNNAMED, message);
                 }
-                break;
-            default:
-                {
-                    report.reportInfo(core_1.MessageName.UNNAMED, `The ${core_1.formatUtils.pretty(project.configuration, `yarn explain peer-requirements`, core_1.formatUtils.Type.CODE)} command doesn't support this warning type yet.`);
+                else {
+                    report.reportInfo(core_1.MessageName.UNNAMED, message);
                 }
-                break;
+            }
         }
     });
     return report.exitCode();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yarnpkg/plugin-essentials",
-  "version": "4.1.2",
+  "version": "4.2.0",
   "license": "BSD-2-Clause",
   "main": "./lib/index.js",
   "exports": {
@@ -20,16 +20,16 @@
     "typanion": "^3.14.0"
   },
   "peerDependencies": {
-    "@yarnpkg/cli": "^4.2.2",
-    "@yarnpkg/core": "^4.0.5",
+    "@yarnpkg/cli": "^4.3.0",
+    "@yarnpkg/core": "^4.1.0",
     "@yarnpkg/plugin-git": "^3.0.0"
   },
   "devDependencies": {
     "@types/lodash": "^4.14.136",
     "@types/micromatch": "^4.0.1",
     "@types/semver": "^7.1.0",
-    "@yarnpkg/cli": "^4.2.2",
-    "@yarnpkg/core": "^4.0.5",
+    "@yarnpkg/cli": "^4.3.0",
+    "@yarnpkg/core": "^4.1.0",
     "@yarnpkg/plugin-git": "^3.0.0"
   },
   "repository": {