@yarnpkg/plugin-essentials 4.0.0-rc.9 → 4.0.1

package/lib/commands/explain/peerRequirements.js

@@ -11,8 +11,7 @@ class ExplainPeerRequirementsCommand extends cli_1.BaseCommand {
     constructor() {
         super(...arguments);
         this.hash = clipanion_1.Option.String({
-            required: false,
-            validator: t.applyCascade(t.isString(), [
+            validator: t.cascade(t.isString(), [
                 t.matchesRegExp(/^p[0-9a-f]{5}$/),
             ]),
         });
@@ -23,46 +22,12 @@ class ExplainPeerRequirementsCommand extends cli_1.BaseCommand {
         await project.restoreInstallState({
             restoreResolutions: false,
         });
-        // peerRequirements aren't stored inside the install state
         await project.applyLightResolution();
-        if (typeof this.hash !== `undefined`) {
-            return await explainPeerRequirements(this.hash, project, {
-                stdout: this.context.stdout,
-            });
-        }
-        const report = await core_1.StreamReport.start({
-            configuration,
+        return await explainPeerRequirements(this.hash, project, {
             stdout: this.context.stdout,
-            includeFooter: false,
-        }, async (report) => {
-            var _a;
-            const sortCriterias = [
-                ([, requirement]) => core_1.structUtils.stringifyLocator(project.storedPackages.get(requirement.subject)),
-                ([, requirement]) => core_1.structUtils.stringifyIdent(requirement.requested),
-            ];
-            for (const [hash, requirement] of core_1.miscUtils.sortMap(project.peerRequirements, sortCriterias)) {
-                const subject = project.storedPackages.get(requirement.subject);
-                if (typeof subject === `undefined`)
-                    throw new Error(`Assertion failed: Expected the subject package to have been registered`);
-                const rootRequester = project.storedPackages.get(requirement.rootRequester);
-                if (typeof rootRequester === `undefined`)
-                    throw new Error(`Assertion failed: Expected the root package to have been registered`);
-                const providedDescriptor = (_a = subject.dependencies.get(requirement.requested.identHash)) !== null && _a !== void 0 ? _a : null;
-                const prettyHash = core_1.formatUtils.pretty(configuration, hash, core_1.formatUtils.Type.CODE);
-                const prettySubject = core_1.structUtils.prettyLocator(configuration, subject);
-                const prettyIdent = core_1.structUtils.prettyIdent(configuration, requirement.requested);
-                const prettyRoot = core_1.structUtils.prettyIdent(configuration, rootRequester);
-                const descendantCount = requirement.allRequesters.length - 1;
-                const pluralized = `descendant${descendantCount === 1 ? `` : `s`}`;
-                const maybeDescendants = descendantCount > 0 ? ` and ${descendantCount} ${pluralized}` : ``;
-                const provides = providedDescriptor !== null ? `provides` : `doesn't provide`;
-                report.reportInfo(null, `${prettyHash} → ${prettySubject} ${provides} ${prettyIdent} to ${prettyRoot}${maybeDescendants}`);
-            }
         });
-        return report.exitCode();
     }
 }
-exports.default = ExplainPeerRequirementsCommand;
 ExplainPeerRequirementsCommand.paths = [
     [`explain`, `peer-requirements`],
 ];
@@ -85,81 +50,85 @@ ExplainPeerRequirementsCommand.usage = clipanion_1.Command.Usage({
             `$0 explain peer-requirements`,
         ]],
 });
+exports.default = ExplainPeerRequirementsCommand;
 async function explainPeerRequirements(peerRequirementsHash, project, opts) {
-    const { configuration } = project;
-    const requirement = project.peerRequirements.get(peerRequirementsHash);
-    if (typeof requirement === `undefined`)
+    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,
+        configuration: project.configuration,
         stdout: opts.stdout,
         includeFooter: false,
+        includePrefix: false,
     }, async (report) => {
-        var _a, _b;
-        const subject = project.storedPackages.get(requirement.subject);
-        if (typeof subject === `undefined`)
-            throw new Error(`Assertion failed: Expected the subject package to have been registered`);
-        const rootRequester = project.storedPackages.get(requirement.rootRequester);
-        if (typeof rootRequester === `undefined`)
-            throw new Error(`Assertion failed: Expected the root package to have been registered`);
-        const providedDescriptor = (_a = subject.dependencies.get(requirement.requested.identHash)) !== null && _a !== void 0 ? _a : null;
-        const providedResolution = providedDescriptor !== null
-            ? project.storedResolutions.get(providedDescriptor.descriptorHash)
-            : null;
-        if (typeof providedResolution === `undefined`)
-            throw new Error(`Assertion failed: Expected the resolution to have been registered`);
-        const provided = providedResolution !== null
-            ? project.storedPackages.get(providedResolution)
-            : null;
-        if (typeof provided === `undefined`)
-            throw new Error(`Assertion failed: Expected the provided package to have been registered`);
-        const allRequesters = [...requirement.allRequesters.values()].map(requesterHash => {
-            const pkg = project.storedPackages.get(requesterHash);
-            if (typeof pkg === `undefined`)
-                throw new Error(`Assertion failed: Expected the package to be registered`);
-            const devirtualizedLocator = core_1.structUtils.devirtualizeLocator(pkg);
-            const devirtualizedPkg = project.storedPackages.get(devirtualizedLocator.locatorHash);
-            if (typeof devirtualizedPkg === `undefined`)
-                throw new Error(`Assertion failed: Expected the package to be registered`);
-            const peerDependency = devirtualizedPkg.peerDependencies.get(requirement.requested.identHash);
-            if (typeof peerDependency === `undefined`)
-                throw new Error(`Assertion failed: Expected the peer dependency to be registered`);
-            return { pkg, peerDependency };
-        });
-        if (provided !== null) {
-            const satisfiesAllRanges = allRequesters.every(({ peerDependency }) => {
-                return core_1.semverUtils.satisfiesWithPrereleases(provided.version, peerDependency.range);
-            });
-            report.reportInfo(core_1.MessageName.UNNAMED, `${core_1.structUtils.prettyLocator(configuration, subject)} provides ${core_1.structUtils.prettyLocator(configuration, provided)} with version ${core_1.structUtils.prettyReference(configuration, (_b = provided.version) !== null && _b !== void 0 ? _b : `<missing>`)}, which ${satisfiesAllRanges ? `satisfies` : `doesn't satisfy`} the following requirements:`);
-        }
-        else {
-            report.reportInfo(core_1.MessageName.UNNAMED, `${core_1.structUtils.prettyLocator(configuration, subject)} doesn't provide ${core_1.structUtils.prettyIdent(configuration, requirement.requested)}, breaking the following requirements:`);
-        }
-        report.reportSeparator();
-        const Mark = core_1.formatUtils.mark(configuration);
-        const requirements = [];
-        for (const { pkg, peerDependency } of core_1.miscUtils.sortMap(allRequesters, requester => core_1.structUtils.stringifyLocator(requester.pkg))) {
-            const isSatisfied = provided !== null
-                ? core_1.semverUtils.satisfiesWithPrereleases(provided.version, peerDependency.range)
-                : false;
-            const mark = isSatisfied ? Mark.Check : Mark.Cross;
-            requirements.push({
-                stringifiedLocator: core_1.structUtils.stringifyLocator(pkg),
-                prettyLocator: core_1.structUtils.prettyLocator(configuration, pkg),
-                prettyRange: core_1.structUtils.prettyRange(configuration, peerDependency.range),
-                mark,
-            });
-        }
-        const maxStringifiedLocatorLength = Math.max(...requirements.map(({ stringifiedLocator }) => stringifiedLocator.length));
-        const maxPrettyRangeLength = Math.max(...requirements.map(({ prettyRange }) => prettyRange.length));
-        for (const { stringifiedLocator, prettyLocator, prettyRange, mark } of core_1.miscUtils.sortMap(requirements, ({ stringifiedLocator }) => stringifiedLocator)) {
-            report.reportInfo(null, `${
-            // We have to do this because prettyLocators can contain multiple colors
-            prettyLocator.padEnd(maxStringifiedLocatorLength + (prettyLocator.length - stringifiedLocator.length), ` `)} → ${prettyRange.padEnd(maxPrettyRangeLength, ` `)} ${mark}`);
-        }
-        if (requirements.length > 1) {
-            report.reportSeparator();
-            report.reportInfo(core_1.MessageName.UNNAMED, `Note: these requirements start with ${core_1.structUtils.prettyLocator(project.configuration, rootRequester)}`);
+        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)}`);
+                        }
+                    }
+                }
+                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.`);
+                }
+                break;
         }
     });
     return report.exitCode();

package/lib/commands/explain.js

@@ -78,7 +78,6 @@ class ExplainCommand extends cli_1.BaseCommand {
         }
     }
 }
-exports.default = ExplainCommand;
 ExplainCommand.paths = [
     [`explain`],
 ];
@@ -97,3 +96,4 @@ ExplainCommand.usage = clipanion_1.Command.Usage({
             `$0 explain`,
         ]],
 });
+exports.default = ExplainCommand;

package/lib/commands/info.js

@@ -160,11 +160,10 @@ class InfoCommand extends cli_1.BaseCommand {
         const infoTreeChildren = {};
         const infoTree = { children: infoTreeChildren };
         const fetcher = configuration.makeFetcher();
-        const fetcherOptions = { project, fetcher, cache, checksums: project.storedChecksums, report: new core_1.ThrowReport(), cacheOptions: { skipIntegrityCheck: true }, skipIntegrityCheck: true };
+        const fetcherOptions = { project, fetcher, cache, checksums: project.storedChecksums, report: new core_1.ThrowReport(), cacheOptions: { skipIntegrityCheck: true } };
         const builtinInfoBuilders = [
             // Manifest fields
             async (pkg, extra, registerData) => {
-                var _a, _b;
                 if (!extra.has(`manifest`))
                     return;
                 const fetchResult = await fetcher.fetch(pkg, fetcherOptions);
@@ -173,28 +172,23 @@ class InfoCommand extends cli_1.BaseCommand {
                     manifest = await core_1.Manifest.find(fetchResult.prefixPath, { baseFs: fetchResult.packageFs });
                 }
                 finally {
-                    (_a = fetchResult.releaseFs) === null || _a === void 0 ? void 0 : _a.call(fetchResult);
+                    fetchResult.releaseFs?.();
                 }
                 registerData(`Manifest`, {
                     [`License`]: core_1.formatUtils.tuple(core_1.formatUtils.Type.NO_HINT, manifest.license),
-                    [`Homepage`]: core_1.formatUtils.tuple(core_1.formatUtils.Type.URL, (_b = manifest.raw.homepage) !== null && _b !== void 0 ? _b : null),
+                    [`Homepage`]: core_1.formatUtils.tuple(core_1.formatUtils.Type.URL, manifest.raw.homepage ?? null),
                 });
             },
             // Cache info
             async (pkg, extra, registerData) => {
-                var _a;
                 if (!extra.has(`cache`))
                     return;
-                const cacheOptions = {
-                    mockedPackages: project.disabledLocators,
-                    unstablePackages: project.conditionalLocators,
-                };
-                const checksum = (_a = project.storedChecksums.get(pkg.locatorHash)) !== null && _a !== void 0 ? _a : null;
-                const cachePath = cache.getLocatorPath(pkg, checksum, cacheOptions);
+                const checksum = project.storedChecksums.get(pkg.locatorHash) ?? null;
+                const cachePath = cache.getLocatorPath(pkg, checksum);
                 let stat;
                 if (cachePath !== null) {
                     try {
-                        stat = fslib_1.xfs.statSync(cachePath);
+                        stat = await fslib_1.xfs.statPromise(cachePath);
                     }
                     catch { }
                 }
@@ -272,10 +266,9 @@ class InfoCommand extends cli_1.BaseCommand {
             }
             if (pkg.dependencies.size > 0 && !isVirtual) {
                 registerData(`Dependencies`, [...pkg.dependencies.values()].map(dependency => {
-                    var _a;
                     const resolutionHash = project.storedResolutions.get(dependency.descriptorHash);
                     const resolution = typeof resolutionHash !== `undefined`
-                        ? (_a = project.storedPackages.get(resolutionHash)) !== null && _a !== void 0 ? _a : null
+                        ? project.storedPackages.get(resolutionHash) ?? null
                         : null;
                     return core_1.formatUtils.tuple(core_1.formatUtils.Type.RESOLUTION, {
                         descriptor: dependency,
@@ -285,13 +278,12 @@ class InfoCommand extends cli_1.BaseCommand {
             }
             if (pkg.peerDependencies.size > 0 && isVirtual) {
                 registerData(`Peer dependencies`, [...pkg.peerDependencies.values()].map(peerDependency => {
-                    var _a, _b;
                     const dependency = pkg.dependencies.get(peerDependency.identHash);
                     const resolutionHash = typeof dependency !== `undefined`
-                        ? (_a = project.storedResolutions.get(dependency.descriptorHash)) !== null && _a !== void 0 ? _a : null
+                        ? project.storedResolutions.get(dependency.descriptorHash) ?? null
                         : null;
                     const resolution = resolutionHash !== null
-                        ? (_b = project.storedPackages.get(resolutionHash)) !== null && _b !== void 0 ? _b : null
+                        ? project.storedPackages.get(resolutionHash) ?? null
                         : null;
                     return core_1.formatUtils.tuple(core_1.formatUtils.Type.RESOLUTION, {
                         descriptor: peerDependency,
@@ -308,7 +300,6 @@ class InfoCommand extends cli_1.BaseCommand {
         });
     }
 }
-exports.default = InfoCommand;
 InfoCommand.paths = [
     [`info`],
 ];
@@ -328,3 +319,4 @@ InfoCommand.usage = clipanion_1.Command.Usage({
             `$0 info lodash`,
         ]],
 });
+exports.default = InfoCommand;

package/lib/commands/install.d.ts

@@ -21,5 +21,5 @@ export default class YarnCommand extends BaseCommand {
     registry: string | undefined;
     silent: boolean | undefined;
     networkTimeout: string | undefined;
-    execute(): Promise<1 | 0>;
+    execute(): Promise<0 | 1>;
 }