@yarnpkg/plugin-essentials 4.0.0-rc.50 → 4.0.0-rc.52

package/lib/commands/config/get.d.ts

@@ -3,6 +3,7 @@ import { Usage } from 'clipanion';
 export default class ConfigGetCommand extends BaseCommand {
     static paths: string[][];
     static usage: Usage;
+    why: boolean;
     json: boolean;
     unsafe: boolean;
     name: string;

package/lib/commands/config/get.js

@@ -10,6 +10,9 @@ const util_1 = require("util");
 class ConfigGetCommand extends cli_1.BaseCommand {
     constructor() {
         super(...arguments);
+        this.why = clipanion_1.Option.Boolean(`--why`, false, {
+            description: `Print the explanation for why a setting has its value`,
+        });
         this.json = clipanion_1.Option.Boolean(`--json`, false, {
             description: `Format the output as an NDJSON stream`,
         });

package/lib/commands/config.d.ts

@@ -3,8 +3,10 @@ import { Usage } from 'clipanion';
 export default class ConfigCommand extends BaseCommand {
     static paths: string[][];
     static usage: Usage;
-    verbose: boolean;
-    why: boolean;
+    noDefaults: boolean;
     json: boolean;
+    verbose: boolean | undefined;
+    why: boolean | undefined;
+    names: string[];
     execute(): Promise<0 | 1>;
 }

package/lib/commands/config.js

@@ -2,31 +2,50 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const cli_1 = require("@yarnpkg/cli");
 const core_1 = require("@yarnpkg/core");
-const core_2 = require("@yarnpkg/core");
+const fslib_1 = require("@yarnpkg/fslib");
 const clipanion_1 = require("clipanion");
 const util_1 = require("util");
 // eslint-disable-next-line arca/no-default-export
 class ConfigCommand extends cli_1.BaseCommand {
     constructor() {
         super(...arguments);
-        this.verbose = clipanion_1.Option.Boolean(`-v,--verbose`, false, {
-            description: `Print the setting description on top of the regular key/value information`,
-        });
-        this.why = clipanion_1.Option.Boolean(`--why`, false, {
-            description: `Print the reason why a setting is set a particular way`,
+        this.noDefaults = clipanion_1.Option.Boolean(`--no-defaults`, false, {
+            description: `Omit the default values from the display`,
         });
         this.json = clipanion_1.Option.Boolean(`--json`, false, {
             description: `Format the output as an NDJSON stream`,
         });
+        // Legacy flags; will emit errors or warnings when used
+        this.verbose = clipanion_1.Option.Boolean(`-v,--verbose`, { hidden: true });
+        this.why = clipanion_1.Option.Boolean(`--why`, { hidden: true });
+        this.names = clipanion_1.Option.Rest();
     }
     async execute() {
         const configuration = await core_1.Configuration.find(this.context.cwd, this.context.plugins, {
             strict: false,
         });
+        const deprecationExitCode = await (0, core_1.reportOptionDeprecations)({
+            configuration,
+            stdout: this.context.stdout,
+            forceError: this.json,
+        }, [{
+                option: this.verbose,
+                message: `The --verbose option is deprecated, the settings' descriptions are now always displayed`,
+            }, {
+                option: this.why,
+                message: `The --why option is deprecated, the settings' sources are now always displayed`,
+            }]);
+        if (deprecationExitCode !== null)
+            return deprecationExitCode;
+        const names = this.names.length > 0
+            ? [...new Set(this.names)].sort()
+            : [...configuration.settings.keys()].sort();
+        let trailingValue;
         const report = await core_1.StreamReport.start({
             configuration,
             json: this.json,
             stdout: this.context.stdout,
+            includeFooter: false,
         }, async (report) => {
             if (configuration.invalid.size > 0 && !this.json) {
                 for (const [key, source] of configuration.invalid)
@@ -34,54 +53,92 @@ class ConfigCommand extends cli_1.BaseCommand {
                 report.reportSeparator();
             }
             if (this.json) {
-                const keys = core_2.miscUtils.sortMap(configuration.settings.keys(), key => key);
-                for (const key of keys) {
-                    const data = configuration.settings.get(key);
-                    const effective = configuration.getSpecial(key, {
+                for (const name of names) {
+                    const data = configuration.settings.get(name);
+                    if (typeof data === `undefined`)
+                        report.reportError(core_1.MessageName.INVALID_CONFIGURATION_KEY, `No configuration key named "${name}"`);
+                    const effective = configuration.getSpecial(name, {
                         hideSecrets: true,
                         getNativePaths: true,
                     });
-                    const source = configuration.sources.get(key);
-                    if (this.verbose) {
-                        report.reportJson({ key, effective, source });
-                    }
-                    else {
-                        report.reportJson({ key, effective, source, ...data });
-                    }
+                    const source = configuration.sources.get(name) ?? `<default>`;
+                    const sourceAsNativePath = source && source[0] !== `<`
+                        ? fslib_1.npath.fromPortablePath(source)
+                        : source;
+                    report.reportJson({ key: name, effective, source: sourceAsNativePath, ...data });
                 }
             }
             else {
-                const keys = core_2.miscUtils.sortMap(configuration.settings.keys(), key => key);
-                const maxKeyLength = keys.reduce((max, key) => Math.max(max, key.length), 0);
                 const inspectConfig = {
                     breakLength: Infinity,
                     colors: configuration.get(`enableColors`),
                     maxArrayLength: 2,
                 };
-                if (this.why || this.verbose) {
-                    const keysAndDescriptions = keys.map(key => {
-                        const setting = configuration.settings.get(key);
-                        if (!setting)
-                            throw new Error(`Assertion failed: This settings ("${key}") should have been registered`);
-                        const description = this.why
-                            ? configuration.sources.get(key) || `<default>`
-                            : setting.description;
-                        return [key, description];
-                    });
-                    const maxDescriptionLength = keysAndDescriptions.reduce((max, [, description]) => {
-                        return Math.max(max, description.length);
-                    }, 0);
-                    for (const [key, description] of keysAndDescriptions) {
-                        report.reportInfo(null, `${key.padEnd(maxKeyLength, ` `)}   ${description.padEnd(maxDescriptionLength, ` `)}   ${(0, util_1.inspect)(configuration.getSpecial(key, { hideSecrets: true, getNativePaths: true }), inspectConfig)}`);
+                const configTreeChildren = {};
+                const configTree = { children: configTreeChildren };
+                for (const name of names) {
+                    if (this.noDefaults && !configuration.sources.has(name))
+                        continue;
+                    const setting = configuration.settings.get(name);
+                    const source = configuration.sources.get(name) ?? `<default>`;
+                    const value = configuration.getSpecial(name, { hideSecrets: true, getNativePaths: true });
+                    const fields = {
+                        Description: {
+                            label: `Description`,
+                            value: core_1.formatUtils.tuple(core_1.formatUtils.Type.MARKDOWN, { text: setting.description, format: this.cli.format(), paragraphs: false }),
+                        },
+                        Source: {
+                            label: `Source`,
+                            value: core_1.formatUtils.tuple(source[0] === `<` ? core_1.formatUtils.Type.CODE : core_1.formatUtils.Type.PATH, source),
+                        },
+                    };
+                    configTreeChildren[name] = {
+                        value: core_1.formatUtils.tuple(core_1.formatUtils.Type.CODE, name),
+                        children: fields,
+                    };
+                    const setValueTo = (node, value) => {
+                        for (const [key, subValue] of value) {
+                            if (subValue instanceof Map) {
+                                const subFields = {};
+                                node[key] = { children: subFields };
+                                setValueTo(subFields, subValue);
+                            }
+                            else {
+                                node[key] = {
+                                    label: key,
+                                    value: core_1.formatUtils.tuple(core_1.formatUtils.Type.NO_HINT, (0, util_1.inspect)(subValue, inspectConfig)),
+                                };
+                            }
+                        }
+                    };
+                    if (value instanceof Map) {
+                        setValueTo(fields, value);
                     }
-                }
-                else {
-                    for (const key of keys) {
-                        report.reportInfo(null, `${key.padEnd(maxKeyLength, ` `)}   ${(0, util_1.inspect)(configuration.getSpecial(key, { hideSecrets: true, getNativePaths: true }), inspectConfig)}`);
+                    else {
+                        fields.Value = {
+                            label: `Value`,
+                            value: core_1.formatUtils.tuple(core_1.formatUtils.Type.NO_HINT, (0, util_1.inspect)(value, inspectConfig)),
+                        };
                     }
                 }
+                if (names.length !== 1)
+                    trailingValue = undefined;
+                core_1.treeUtils.emitTree(configTree, {
+                    configuration,
+                    json: this.json,
+                    stdout: this.context.stdout,
+                    separators: 2,
+                });
             }
         });
+        if (!this.json && typeof trailingValue !== `undefined`) {
+            const name = names[0];
+            const value = (0, util_1.inspect)(configuration.getSpecial(name, { hideSecrets: true, getNativePaths: true }), {
+                colors: configuration.get(`enableColors`),
+            });
+            this.context.stdout.write(`\n`);
+            this.context.stdout.write(`${value}\n`);
+        }
         return report.exitCode();
     }
 }

package/lib/commands/info.js

@@ -183,16 +183,12 @@ class InfoCommand extends cli_1.BaseCommand {
             async (pkg, extra, registerData) => {
                 if (!extra.has(`cache`))
                     return;
-                const cacheOptions = {
-                    mockedPackages: project.disabledLocators,
-                    unstablePackages: project.conditionalLocators,
-                };
                 const checksum = project.storedChecksums.get(pkg.locatorHash) ?? null;
-                const cachePath = cache.getLocatorPath(pkg, checksum, cacheOptions);
+                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 { }
                 }

package/lib/commands/install.js

@@ -70,109 +70,68 @@ class YarnCommand extends cli_1.BaseCommand {
         // in process of deploying Google Cloud Functions and
         // Google App Engine
         const isGCP = !!process.env.FUNCTION_TARGET || !!process.env.GOOGLE_RUNTIME;
-        const reportDeprecation = async (message, { error }) => {
-            const deprecationReport = await core_1.StreamReport.start({
-                configuration,
-                stdout: this.context.stdout,
-                includeFooter: false,
-            }, async (report) => {
-                if (error) {
-                    report.reportError(core_1.MessageName.DEPRECATED_CLI_SETTINGS, message);
-                }
-                else {
-                    report.reportWarning(core_1.MessageName.DEPRECATED_CLI_SETTINGS, message);
-                }
-            });
-            if (deprecationReport.hasErrors()) {
-                return deprecationReport.exitCode();
-            }
-            else {
-                return null;
-            }
-        };
-        // The ignoreEngines flag isn't implemented at the moment. I'm still
-        // considering how it should work in the context of plugins - would it
-        // make sense to allow them (or direct dependencies) to define new
-        // "engine check"? Since it has implications regarding the architecture,
-        // I prefer to postpone the decision to later. Also it wouldn't be a flag,
-        // it would definitely be a configuration setting.
-        if (typeof this.ignoreEngines !== `undefined`) {
-            const exitCode = await reportDeprecation(`The --ignore-engines option is deprecated; engine checking isn't a core feature anymore`, {
+        const deprecationExitCode = await (0, core_1.reportOptionDeprecations)({
+            configuration,
+            stdout: this.context.stdout,
+        }, [{
+                // The ignoreEngines flag isn't implemented at the moment. I'm still
+                // considering how it should work in the context of plugins - would it
+                // make sense to allow them (or direct dependencies) to define new
+                // "engine check"? Since it has implications regarding the architecture,
+                // I prefer to postpone the decision to later. Also it wouldn't be a flag,
+                // it would definitely be a configuration setting.
+                option: this.ignoreEngines,
+                message: `The --ignore-engines option is deprecated; engine checking isn't a core feature anymore`,
                 error: !ci_info_1.default.VERCEL,
-            });
-            if (exitCode !== null) {
-                return exitCode;
-            }
-        }
-        // The registry flag isn't supported anymore because it makes little sense
-        // to use a registry for a single install. You instead want to configure it
-        // for all installs inside a project, so through the .yarnrc.yml file. Note
-        // that if absolutely necessary, the old behavior can be emulated by adding
-        // the YARN_NPM_REGISTRY_SERVER variable to the environment.
-        if (typeof this.registry !== `undefined`) {
-            const exitCode = await reportDeprecation(`The --registry option is deprecated; prefer setting npmRegistryServer in your .yarnrc.yml file`, {
-                error: false,
-            });
-            if (exitCode !== null) {
-                return exitCode;
-            }
-        }
-        // The preferOffline flag doesn't make much sense with our architecture.
-        // It would require the fetchers to also act as resolvers, which is
-        // doable but quirky. Since a similar behavior is available via the
-        // --cached flag in yarn add, I prefer to move it outside of the core and
-        // let someone implement this "resolver-that-reads-the-cache" logic.
-        if (typeof this.preferOffline !== `undefined`) {
-            const exitCode = await reportDeprecation(`The --prefer-offline flag is deprecated; use the --cached flag with 'yarn add' instead`, {
+            }, {
+                // The registry flag isn't supported anymore because it makes little sense
+                // to use a registry for a single install. You instead want to configure it
+                // for all installs inside a project, so through the .yarnrc.yml file. Note
+                // that if absolutely necessary, the old behavior can be emulated by adding
+                // the YARN_NPM_REGISTRY_SERVER variable to the environment.
+                option: this.registry,
+                message: `The --registry option is deprecated; prefer setting npmRegistryServer in your .yarnrc.yml file`,
+            }, {
+                // The preferOffline flag doesn't make much sense with our architecture.
+                // It would require the fetchers to also act as resolvers, which is
+                // doable but quirky. Since a similar behavior is available via the
+                // --cached flag in yarn add, I prefer to move it outside of the core and
+                // let someone implement this "resolver-that-reads-the-cache" logic.
+                option: this.preferOffline,
+                message: `The --prefer-offline flag is deprecated; use the --cached flag with 'yarn add' instead`,
                 error: !ci_info_1.default.VERCEL,
-            });
-            if (exitCode !== null) {
-                return exitCode;
-            }
-        }
-        // Since the production flag would yield a different lockfile than the
-        // regular installs, it's not part of the regular `install` command anymore.
-        // Instead, we expect users to use it with `yarn workspaces focus` (which can
-        // be used even outside of monorepos).
-        if (typeof this.production !== `undefined`) {
-            const exitCode = await reportDeprecation(`The --production option is deprecated on 'install'; use 'yarn workspaces focus' instead`, {
+            }, {
+                // Since the production flag would yield a different lockfile than the
+                // regular installs, it's not part of the regular `install` command anymore.
+                // Instead, we expect users to use it with `yarn workspaces focus` (which can
+                // be used even outside of monorepos).
+                option: this.production,
+                message: `The --production option is deprecated on 'install'; use 'yarn workspaces focus' instead`,
                 error: true,
-            });
-            if (exitCode !== null) {
-                return exitCode;
-            }
-        }
-        // Yarn 2 isn't interactive during installs anyway, so there's no real point
-        // to this flag at the moment.
-        if (typeof this.nonInteractive !== `undefined`) {
-            const exitCode = await reportDeprecation(`The --non-interactive option is deprecated`, {
+            }, {
+                // Yarn 2+ isn't interactive during installs anyway, so there's no real point
+                // to this flag at the moment.
+                option: this.nonInteractive,
+                message: `The --non-interactive option is deprecated`,
                 error: !isGCP,
-            });
-            if (exitCode !== null) {
-                return exitCode;
-            }
-        }
-        // We want to prevent people from using --frozen-lockfile
-        // Note: it's been deprecated because we're now locking more than just the
-        // lockfile - for example the PnP artifacts will also be locked.
-        if (typeof this.frozenLockfile !== `undefined`) {
-            await reportDeprecation(`The --frozen-lockfile option is deprecated; use --immutable and/or --immutable-cache instead`, {
-                error: false,
-            });
-            this.immutable = this.frozenLockfile;
-        }
-        // We also want to prevent them from using --cache-folder
-        // Note: it's been deprecated because the cache folder should be set from
-        // the settings. Otherwise there would be a very high chance that multiple
-        // Yarn commands would use different caches, causing unexpected behaviors.
-        if (typeof this.cacheFolder !== `undefined`) {
-            const exitCode = await reportDeprecation(`The cache-folder option has been deprecated; use rc settings instead`, {
+            }, {
+                // We want to prevent people from using --frozen-lockfile
+                // Note: it's been deprecated because we're now locking more than just the
+                // lockfile - for example the PnP artifacts will also be locked.
+                option: this.frozenLockfile,
+                message: `The --frozen-lockfile option is deprecated; use --immutable and/or --immutable-cache instead`,
+                callback: () => this.immutable = this.frozenLockfile,
+            }, {
+                // We also want to prevent them from using --cache-folder
+                // Note: it's been deprecated because the cache folder should be set from
+                // the settings. Otherwise there would be a very high chance that multiple
+                // Yarn commands would use different caches, causing unexpected behaviors.
+                option: this.cacheFolder,
+                message: `The cache-folder option has been deprecated; use rc settings instead`,
                 error: !ci_info_1.default.NETLIFY,
-            });
-            if (exitCode !== null) {
-                return exitCode;
-            }
-        }
+            }]);
+        if (deprecationExitCode !== null)
+            return deprecationExitCode;
         const updateMode = this.mode === core_1.InstallMode.UpdateLockfile;
         if (updateMode && (this.immutable || this.immutableCache))
             throw new clipanion_1.UsageError(`${core_1.formatUtils.pretty(configuration, `--immutable`, core_1.formatUtils.Type.CODE)} and ${core_1.formatUtils.pretty(configuration, `--immutable-cache`, core_1.formatUtils.Type.CODE)} cannot be used with ${core_1.formatUtils.pretty(configuration, `--mode=update-lockfile`, core_1.formatUtils.Type.CODE)}`);

package/lib/suggestUtils.js

@@ -269,6 +269,8 @@ async function getSuggestedDescriptors(request, { project, workspace, cache, tar
                 break;
             case Strategy.LATEST:
                 {
+                    const hasNetwork = project.configuration.get(`enableNetwork`);
+                    const isOfflineMode = project.configuration.get(`enableOfflineMode`);
                     await trySuggest(async () => {
                         if (target === Target.PEER) {
                             suggested.push({
@@ -277,7 +279,7 @@ async function getSuggestedDescriptors(request, { project, workspace, cache, tar
                                 reason: `(catch-all peer dependency pattern)`,
                             });
                         }
-                        else if (!project.configuration.get(`enableNetwork`)) {
+                        else if (!hasNetwork && !isOfflineMode) {
                             suggested.push({
                                 descriptor: null,
                                 name: `Resolve from latest`,
@@ -290,7 +292,7 @@ async function getSuggestedDescriptors(request, { project, workspace, cache, tar
                                 suggested.push({
                                     descriptor: latest,
                                     name: `Use ${core_2.structUtils.prettyDescriptor(project.configuration, latest)}`,
-                                    reason: `(resolved from latest)`,
+                                    reason: `(resolved from ${isOfflineMode ? `the cache` : `latest`})`,
                                 });
                             }
                         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yarnpkg/plugin-essentials",
-  "version": "4.0.0-rc.50",
+  "version": "4.0.0-rc.52",
   "stableVersion": "3.3.0",
   "license": "BSD-2-Clause",
   "main": "./lib/index.js",
@@ -9,8 +9,8 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@yarnpkg/fslib": "^3.0.0-rc.50",
-    "@yarnpkg/parsers": "^3.0.0-rc.50",
+    "@yarnpkg/fslib": "^3.0.0-rc.52",
+    "@yarnpkg/parsers": "^3.0.0-rc.52",
     "ci-info": "^3.2.0",
     "clipanion": "^4.0.0-rc.2",
     "enquirer": "^2.3.6",
@@ -21,17 +21,17 @@
     "typanion": "^3.14.0"
   },
   "peerDependencies": {
-    "@yarnpkg/cli": "^4.0.0-rc.50",
-    "@yarnpkg/core": "^4.0.0-rc.50",
-    "@yarnpkg/plugin-git": "^3.0.0-rc.50"
+    "@yarnpkg/cli": "^4.0.0-rc.52",
+    "@yarnpkg/core": "^4.0.0-rc.52",
+    "@yarnpkg/plugin-git": "^3.0.0-rc.52"
   },
   "devDependencies": {
     "@types/lodash": "^4.14.136",
     "@types/micromatch": "^4.0.1",
     "@types/semver": "^7.1.0",
-    "@yarnpkg/cli": "^4.0.0-rc.50",
-    "@yarnpkg/core": "^4.0.0-rc.50",
-    "@yarnpkg/plugin-git": "^3.0.0-rc.50"
+    "@yarnpkg/cli": "^4.0.0-rc.52",
+    "@yarnpkg/core": "^4.0.0-rc.52",
+    "@yarnpkg/plugin-git": "^3.0.0-rc.52"
   },
   "repository": {
     "type": "git",