@yarnpkg/plugin-essentials 3.2.2 → 3.3.0

package/lib/commands/add.js

@@ -84,21 +84,24 @@ class AddCommand extends cli_1.BaseCommand {
                 throw new clipanion_1.UsageError(`It seems you are trying to add a package using a ${core_1.formatUtils.pretty(configuration, `${unsupportedPrefix[0]}...`, core_1.FormatType.RANGE)} url; we now require package names to be explicitly specified.\nTry running the command again with the package name prefixed: ${core_1.formatUtils.pretty(configuration, `yarn add`, core_1.FormatType.CODE)} ${core_1.formatUtils.pretty(configuration, core_3.structUtils.makeDescriptor(core_3.structUtils.makeIdent(null, `my-package`), `${unsupportedPrefix[0]}...`), core_1.FormatType.DESCRIPTOR)}`);
             if (!request)
                 throw new clipanion_1.UsageError(`The ${core_1.formatUtils.pretty(configuration, pseudoDescriptor, core_1.FormatType.CODE)} string didn't match the required format (package-name@range). Did you perhaps forget to explicitly reference the package name?`);
-            const target = suggestTarget(workspace, request, {
+            const targetList = suggestTargetList(workspace, request, {
                 dev: this.dev,
                 peer: this.peer,
                 preferDev: this.preferDev,
                 optional: this.optional,
             });
-            const suggestions = await suggestUtils.getSuggestedDescriptors(request, { project, workspace, cache, target, modifier, strategies, maxResults });
-            return [request, suggestions, target];
-        }));
+            const results = await Promise.all(targetList.map(async (target) => {
+                const suggestedDescriptors = await suggestUtils.getSuggestedDescriptors(request, { project, workspace, cache, target, modifier, strategies, maxResults });
+                return { request, suggestedDescriptors, target };
+            }));
+            return results;
+        })).then(results => results.flat());
         const checkReport = await core_1.LightReport.start({
             configuration,
             stdout: this.context.stdout,
             suggestInstall: false,
         }, async (report) => {
-            for (const [request, { suggestions, rejections }] of allSuggestions) {
+            for (const { request, suggestedDescriptors: { suggestions, rejections } } of allSuggestions) {
                 const nonNullSuggestions = suggestions.filter(suggestion => {
                     return suggestion.descriptor !== null;
                 });
@@ -120,7 +123,7 @@ class AddCommand extends cli_1.BaseCommand {
         let askedQuestions = false;
         const afterWorkspaceDependencyAdditionList = [];
         const afterWorkspaceDependencyReplacementList = [];
-        for (const [/*request*/ , { suggestions }, target] of allSuggestions) {
+        for (const { suggestedDescriptors: { suggestions }, target } of allSuggestions) {
             let selected;
             const nonNullSuggestions = suggestions.filter(suggestion => {
                 return suggestion.descriptor !== null;
@@ -231,7 +234,7 @@ AddCommand.usage = clipanion_1.Command.Usage({
 
       If the \`--mode=<mode>\` option is set, Yarn will change which artifacts are generated. The modes currently supported are:
 
-      - \`skip-build\` will not run the build scripts at all. Note that this is different from setting \`enableScripts\` to false because the later will disable build scripts, and thus affect the content of the artifacts generated on disk, whereas the former will just disable the build step - but not the scripts themselves, which just won't run.
+      - \`skip-build\` will not run the build scripts at all. Note that this is different from setting \`enableScripts\` to false because the latter will disable build scripts, and thus affect the content of the artifacts generated on disk, whereas the former will just disable the build step - but not the scripts themselves, which just won't run.
 
       - \`update-lockfile\` will skip the link step altogether, and only fetch packages that are missing from the lockfile (or that have no associated checksums). This mode is typically used by tools like Renovate or Dependabot to keep a lockfile up-to-date without incurring the full install cost.
 
@@ -257,7 +260,7 @@ AddCommand.usage = clipanion_1.Command.Usage({
             `$0 add lodash-es@lodash/lodash#es`,
         ]],
 });
-function suggestTarget(workspace, ident, { dev, peer, preferDev, optional }) {
+function suggestTargetList(workspace, ident, { dev, peer, preferDev, optional }) {
     const hasRegular = workspace.manifest[suggestUtils.Target.REGULAR].has(ident.identHash);
     const hasDev = workspace.manifest[suggestUtils.Target.DEVELOPMENT].has(ident.identHash);
     const hasPeer = workspace.manifest[suggestUtils.Target.PEER].has(ident.identHash);
@@ -271,13 +274,21 @@ function suggestTarget(workspace, ident, { dev, peer, preferDev, optional }) {
         throw new clipanion_1.UsageError(`Package "${core_3.structUtils.prettyIdent(workspace.project.configuration, ident)}" is already listed as a peer dependency - remove the -O flag or add the -P flag or remove it from your peer dependencies first`);
     if ((dev || preferDev) && optional)
         throw new clipanion_1.UsageError(`Package "${core_3.structUtils.prettyIdent(workspace.project.configuration, ident)}" cannot simultaneously be a dev dependency and an optional dependency`);
+    // When the program executes this line, the command is expected to be legal
+    const targetList = [];
     if (peer)
-        return suggestUtils.Target.PEER;
+        targetList.push(suggestUtils.Target.PEER);
     if (dev || preferDev)
-        return suggestUtils.Target.DEVELOPMENT;
-    if (hasRegular)
-        return suggestUtils.Target.REGULAR;
+        targetList.push(suggestUtils.Target.DEVELOPMENT);
+    if (optional)
+        targetList.push(suggestUtils.Target.REGULAR);
+    // The user explicitly define the targets
+    if (targetList.length > 0)
+        return targetList;
+    // The user does not define the targets, find it from the `workspace.manifest`
     if (hasDev)
-        return suggestUtils.Target.DEVELOPMENT;
-    return suggestUtils.Target.REGULAR;
+        return [suggestUtils.Target.DEVELOPMENT];
+    if (hasPeer)
+        return [suggestUtils.Target.PEER];
+    return [suggestUtils.Target.REGULAR];
 }

package/lib/commands/dedupe.js

@@ -91,7 +91,7 @@ DedupeCommand.usage = clipanion_1.Command.Usage({
 
       If the \`--mode=<mode>\` option is set, Yarn will change which artifacts are generated. The modes currently supported are:
 
-      - \`skip-build\` will not run the build scripts at all. Note that this is different from setting \`enableScripts\` to false because the later will disable build scripts, and thus affect the content of the artifacts generated on disk, whereas the former will just disable the build step - but not the scripts themselves, which just won't run.
+      - \`skip-build\` will not run the build scripts at all. Note that this is different from setting \`enableScripts\` to false because the latter will disable build scripts, and thus affect the content of the artifacts generated on disk, whereas the former will just disable the build step - but not the scripts themselves, which just won't run.
 
       - \`update-lockfile\` will skip the link step altogether, and only fetch packages that are missing from the lockfile (or that have no associated checksums). This mode is typically used by tools like Renovate or Dependabot to keep a lockfile up-to-date without incurring the full install cost.
 

package/lib/commands/install.js

@@ -276,7 +276,7 @@ YarnCommand.usage = clipanion_1.Command.Usage({
 
       If the \`--mode=<mode>\` option is set, Yarn will change which artifacts are generated. The modes currently supported are:
 
-      - \`skip-build\` will not run the build scripts at all. Note that this is different from setting \`enableScripts\` to false because the later will disable build scripts, and thus affect the content of the artifacts generated on disk, whereas the former will just disable the build step - but not the scripts themselves, which just won't run.
+      - \`skip-build\` will not run the build scripts at all. Note that this is different from setting \`enableScripts\` to false because the latter will disable build scripts, and thus affect the content of the artifacts generated on disk, whereas the former will just disable the build step - but not the scripts themselves, which just won't run.
 
       - \`update-lockfile\` will skip the link step altogether, and only fetch packages that are missing from the lockfile (or that have no associated checksums). This mode is typically used by tools like Renovate or Dependabot to keep a lockfile up-to-date without incurring the full install cost.
     `,

package/lib/commands/plugin/import/sources.d.ts

@@ -14,7 +14,7 @@ export default class PluginDlSourcesCommand extends BaseCommand {
     name: string;
     execute(): Promise<1 | 0>;
 }
-export declare type BuildAndSavePluginsSpec = {
+export type BuildAndSavePluginsSpec = {
     context: CommandContext;
     noMinify: boolean;
 };

package/lib/commands/remove.js

@@ -114,7 +114,7 @@ RemoveCommand.usage = clipanion_1.Command.Usage({
 
       If the \`--mode=<mode>\` option is set, Yarn will change which artifacts are generated. The modes currently supported are:
 
-      - \`skip-build\` will not run the build scripts at all. Note that this is different from setting \`enableScripts\` to false because the later will disable build scripts, and thus affect the content of the artifacts generated on disk, whereas the former will just disable the build step - but not the scripts themselves, which just won't run.
+      - \`skip-build\` will not run the build scripts at all. Note that this is different from setting \`enableScripts\` to false because the latter will disable build scripts, and thus affect the content of the artifacts generated on disk, whereas the former will just disable the build step - but not the scripts themselves, which just won't run.
 
       - \`update-lockfile\` will skip the link step altogether, and only fetch packages that are missing from the lockfile (or that have no associated checksums). This mode is typically used by tools like Renovate or Dependabot to keep a lockfile up-to-date without incurring the full install cost.
 

package/lib/commands/set/version/sources.d.ts

@@ -19,7 +19,7 @@ export declare function runWorkflow(workflow: Array<Array<string>>, { configurat
     context: CommandContext;
     target: PortablePath;
 }): Promise<void>;
-export declare type PrepareSpec = {
+export type PrepareSpec = {
     branch: string;
     context: CommandContext;
     force: boolean;

package/lib/commands/set/version.d.ts

@@ -3,7 +3,7 @@
 import { BaseCommand } from '@yarnpkg/cli';
 import { Configuration, Report } from '@yarnpkg/core';
 import { Usage } from 'clipanion';
-export declare type Tags = {
+export type Tags = {
     latest: Record<string, string>;
     tags: Array<string>;
 };

package/lib/commands/set/version.js

@@ -18,9 +18,17 @@ class SetVersionCommand extends cli_1.BaseCommand {
         this.version = clipanion_1.Option.String();
     }
     async execute() {
+        var _a;
         const configuration = await core_1.Configuration.find(this.context.cwd, this.context.plugins);
-        if (configuration.get(`yarnPath`) && this.onlyIfNeeded)
-            return 0;
+        if (this.onlyIfNeeded && configuration.get(`yarnPath`)) {
+            const yarnPathSource = configuration.sources.get(`yarnPath`);
+            if (!yarnPathSource)
+                throw new Error(`Assertion failed: Expected 'yarnPath' to have a source`);
+            const projectCwd = (_a = configuration.projectCwd) !== null && _a !== void 0 ? _a : configuration.startingCwd;
+            if (fslib_1.ppath.contains(projectCwd, yarnPathSource)) {
+                return 0;
+            }
+        }
         const getBundlePath = () => {
             if (typeof core_1.YarnVersion === `undefined`)
                 throw new clipanion_1.UsageError(`The --install flag can only be used without explicit version specifier from the Yarn CLI`);
@@ -34,7 +42,7 @@ class SetVersionCommand extends cli_1.BaseCommand {
         else if (this.version === `canary`)
             bundleUrl = `https://repo.yarnpkg.com/${await resolveTag(configuration, `canary`)}/packages/yarnpkg-cli/bin/yarn.js`;
         else if (this.version === `classic`)
-            bundleUrl = `https://nightly.yarnpkg.com/latest.js`;
+            bundleUrl = `https://classic.yarnpkg.com/latest.js`;
         else if (this.version.match(/^https?:/))
             bundleUrl = this.version;
         else if (this.version.match(/^\.{0,2}[\\/]/) || fslib_1.npath.isAbsolute(this.version))
@@ -159,28 +167,24 @@ async function setVersion(configuration, bundleVersion, bundleBuffer, { report }
     const absolutePath = fslib_1.ppath.resolve(releaseFolder, `yarn-${bundleVersion}.cjs`);
     const displayPath = fslib_1.ppath.relative(configuration.startingCwd, absolutePath);
     const projectPath = fslib_1.ppath.relative(projectCwd, absolutePath);
-    const yarnPath = configuration.get(`yarnPath`);
-    const updateConfig = yarnPath === null || yarnPath.startsWith(`${releaseFolder}/`);
     report.reportInfo(core_1.MessageName.UNNAMED, `Saving the new release in ${core_2.formatUtils.pretty(configuration, displayPath, `magenta`)}`);
     await fslib_1.xfs.removePromise(fslib_1.ppath.dirname(absolutePath));
     await fslib_1.xfs.mkdirPromise(fslib_1.ppath.dirname(absolutePath), { recursive: true });
     await fslib_1.xfs.writeFilePromise(absolutePath, bundleBuffer, { mode: 0o755 });
-    if (updateConfig) {
-        await core_1.Configuration.updateConfiguration(projectCwd, {
-            yarnPath: projectPath,
-        });
-        const manifest = (await core_1.Manifest.tryFind(projectCwd)) || new core_1.Manifest();
-        manifest.packageManager = `yarn@${bundleVersion && core_2.miscUtils.isTaggedYarnVersion(bundleVersion)
-            ? bundleVersion
-            // If the version isn't tagged, we use the latest stable version as the wrapper
-            : await resolveTag(configuration, `stable`)}`;
-        const data = {};
-        manifest.exportTo(data);
-        const path = fslib_1.ppath.join(projectCwd, core_1.Manifest.fileName);
-        const content = `${JSON.stringify(data, null, manifest.indent)}\n`;
-        await fslib_1.xfs.changeFilePromise(path, content, {
-            automaticNewlines: true,
-        });
-    }
+    await core_1.Configuration.updateConfiguration(projectCwd, {
+        yarnPath: projectPath,
+    });
+    const manifest = (await core_1.Manifest.tryFind(projectCwd)) || new core_1.Manifest();
+    manifest.packageManager = `yarn@${bundleVersion && core_2.miscUtils.isTaggedYarnVersion(bundleVersion)
+        ? bundleVersion
+        // If the version isn't tagged, we use the latest stable version as the wrapper
+        : await resolveTag(configuration, `stable`)}`;
+    const data = {};
+    manifest.exportTo(data);
+    const path = fslib_1.ppath.join(projectCwd, core_1.Manifest.fileName);
+    const content = `${JSON.stringify(data, null, manifest.indent)}\n`;
+    await fslib_1.xfs.changeFilePromise(path, content, {
+        automaticNewlines: true,
+    });
 }
 exports.setVersion = setVersion;

package/lib/commands/up.js

@@ -252,7 +252,7 @@ UpCommand.usage = clipanion_1.Command.Usage({
 
       If the \`--mode=<mode>\` option is set, Yarn will change which artifacts are generated. The modes currently supported are:
 
-      - \`skip-build\` will not run the build scripts at all. Note that this is different from setting \`enableScripts\` to false because the later will disable build scripts, and thus affect the content of the artifacts generated on disk, whereas the former will just disable the build step - but not the scripts themselves, which just won't run.
+      - \`skip-build\` will not run the build scripts at all. Note that this is different from setting \`enableScripts\` to false because the latter will disable build scripts, and thus affect the content of the artifacts generated on disk, whereas the former will just disable the build step - but not the scripts themselves, which just won't run.
 
       - \`update-lockfile\` will skip the link step altogether, and only fetch packages that are missing from the lockfile (or that have no associated checksums). This mode is typically used by tools like Renovate or Dependabot to keep a lockfile up-to-date without incurring the full install cost.
 

package/lib/commands/workspace.js

@@ -18,10 +18,7 @@ class WorkspaceCommand extends cli_1.BaseCommand {
         if (!cwdWorkspace)
             throw new cli_1.WorkspaceRequiredError(project.cwd, this.context.cwd);
         const candidates = project.workspaces;
-        const candidatesByName = new Map(candidates.map((workspace) => {
-            const ident = core_2.structUtils.convertToIdent(workspace.locator);
-            return [core_2.structUtils.stringifyIdent(ident), workspace];
-        }));
+        const candidatesByName = new Map(candidates.map(workspace => [core_2.structUtils.stringifyIdent(workspace.locator), workspace]));
         const workspace = candidatesByName.get(this.workspaceName);
         if (workspace === undefined) {
             const otherNames = Array.from(candidatesByName.keys()).sort();

package/lib/commands/workspaces/list.d.ts

@@ -5,6 +5,7 @@ export default class WorkspacesListCommand extends BaseCommand {
     static usage: Usage;
     since: string | boolean | undefined;
     recursive: boolean;
+    noPrivate: boolean | undefined;
     verbose: boolean;
     json: boolean;
     execute(): Promise<1 | 0>;

package/lib/commands/workspaces/list.js

@@ -15,6 +15,9 @@ class WorkspacesListCommand extends cli_1.BaseCommand {
         this.recursive = clipanion_1.Option.Boolean(`-R,--recursive`, false, {
             description: `Find packages via dependencies/devDependencies instead of using the workspaces field`,
         });
+        this.noPrivate = clipanion_1.Option.Boolean(`--no-private`, {
+            description: `Exclude workspaces that have the private field set to true`,
+        });
         this.verbose = clipanion_1.Option.Boolean(`-v,--verbose`, false, {
             description: `Also return the cross-dependencies between workspaces`,
         });
@@ -40,6 +43,8 @@ class WorkspacesListCommand extends cli_1.BaseCommand {
                         workspaces.add(dependent);
             for (const workspace of workspaces) {
                 const { manifest } = workspace;
+                if (manifest.private && this.noPrivate)
+                    continue;
                 let extra;
                 if (this.verbose) {
                     const workspaceDependencies = new Set();
@@ -93,6 +98,8 @@ WorkspacesListCommand.usage = clipanion_1.Command.Usage({
 
       - If \`-R,--recursive\` is set, Yarn will find workspaces to run the command on by recursively evaluating \`dependencies\` and \`devDependencies\` fields, instead of looking at the \`workspaces\` fields.
 
+      - If \`--no-private\` is set, Yarn will not list any workspaces that have the \`private\` field set to \`true\`.
+
       - If both the \`-v,--verbose\` and \`--json\` options are set, Yarn will also return the cross-dependencies between each workspaces (useful when you wish to automatically generate Buck / Bazel rules).
     `,
 });

package/lib/dedupeUtils.d.ts

@@ -1,6 +1,6 @@
 import { Project, ResolveOptions, Resolver, Descriptor, Package, Report, Cache } from '@yarnpkg/core';
 import { Fetcher, FetchOptions } from '@yarnpkg/core';
-export declare type Algorithm = (project: Project, patterns: Array<string>, opts: {
+export type Algorithm = (project: Project, patterns: Array<string>, opts: {
     resolver: Resolver;
     resolveOptions: ResolveOptions;
     fetcher: Fetcher;
@@ -21,7 +21,7 @@ export declare enum Strategy {
     HIGHEST = "highest"
 }
 export declare const acceptedStrategies: Set<Strategy.HIGHEST>;
-export declare type DedupeOptions = {
+export type DedupeOptions = {
     strategy: Strategy;
     patterns: Array<string>;
     cache: Cache;

package/lib/dedupeUtils.js

@@ -93,7 +93,7 @@ async function dedupe(project, { strategy, patterns, cache, report }) {
         const algorithm = DEDUPE_ALGORITHMS[strategy];
         const dedupePromises = await algorithm(project, patterns, { resolver, resolveOptions, fetcher, fetchOptions });
         const progress = core_1.Report.progressViaCounter(dedupePromises.length);
-        report.reportProgress(progress);
+        await report.reportProgress(progress);
         let dedupedPackageCount = 0;
         await Promise.all(dedupePromises.map(dedupePromise => dedupePromise
             .then(dedupe => {

package/lib/suggestUtils.d.ts

@@ -1,16 +1,16 @@
 import { Cache, DescriptorHash, Descriptor, Ident, Locator, Project, Workspace } from '@yarnpkg/core';
 import { PortablePath } from '@yarnpkg/fslib';
-export declare type Suggestion = {
+export type Suggestion = {
     descriptor: Descriptor;
     name: string;
     reason: string;
 };
-export declare type NullableSuggestion = {
+export type NullableSuggestion = {
     descriptor: Descriptor | null;
     name: string;
     reason: string;
 };
-export declare type Results = {
+export type Results = {
     suggestions: Array<NullableSuggestion>;
     rejections: Array<Error>;
 };

package/lib/suggestUtils.js

@@ -109,7 +109,7 @@ async function findProjectDescriptors(ident, { project, target }) {
         if (target === Target.PEER) {
             const peerDescriptor = workspace.manifest.peerDependencies.get(ident.identHash);
             if (peerDescriptor !== undefined) {
-                getDescriptorEntry(peerDescriptor).locators.push(workspace.locator);
+                getDescriptorEntry(peerDescriptor).locators.push(workspace.anchoredLocator);
             }
         }
         else {
@@ -117,18 +117,18 @@ async function findProjectDescriptors(ident, { project, target }) {
             const developmentDescriptor = workspace.manifest.devDependencies.get(ident.identHash);
             if (target === Target.DEVELOPMENT) {
                 if (developmentDescriptor !== undefined) {
-                    getDescriptorEntry(developmentDescriptor).locators.push(workspace.locator);
+                    getDescriptorEntry(developmentDescriptor).locators.push(workspace.anchoredLocator);
                 }
                 else if (regularDescriptor !== undefined) {
-                    getDescriptorEntry(regularDescriptor).locators.push(workspace.locator);
+                    getDescriptorEntry(regularDescriptor).locators.push(workspace.anchoredLocator);
                 }
             }
             else {
                 if (regularDescriptor !== undefined) {
-                    getDescriptorEntry(regularDescriptor).locators.push(workspace.locator);
+                    getDescriptorEntry(regularDescriptor).locators.push(workspace.anchoredLocator);
                 }
                 else if (developmentDescriptor !== undefined) {
-                    getDescriptorEntry(developmentDescriptor).locators.push(workspace.locator);
+                    getDescriptorEntry(developmentDescriptor).locators.push(workspace.anchoredLocator);
                 }
             }
         }

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@yarnpkg/plugin-essentials",
-  "version": "3.2.2",
+  "version": "3.3.0",
   "license": "BSD-2-Clause",
   "main": "./lib/index.js",
   "dependencies": {
-    "@yarnpkg/fslib": "^2.7.1",
+    "@yarnpkg/fslib": "^2.9.0",
     "@yarnpkg/json-proxy": "^2.1.1",
     "@yarnpkg/parsers": "^2.5.1",
     "ci-info": "^3.2.0",
@@ -17,18 +17,18 @@
     "typanion": "^3.3.0"
   },
   "peerDependencies": {
-    "@yarnpkg/cli": "^3.2.3",
-    "@yarnpkg/core": "^3.2.4",
-    "@yarnpkg/plugin-git": "^2.6.2"
+    "@yarnpkg/cli": "^3.3.0",
+    "@yarnpkg/core": "^3.3.0",
+    "@yarnpkg/plugin-git": "^2.6.3"
   },
   "devDependencies": {
     "@types/lodash": "^4.14.136",
     "@types/micromatch": "^4.0.1",
     "@types/semver": "^7.1.0",
     "@types/treeify": "^1.0.0",
-    "@yarnpkg/cli": "^3.2.3",
-    "@yarnpkg/core": "^3.2.4",
-    "@yarnpkg/plugin-git": "^2.6.2"
+    "@yarnpkg/cli": "^3.3.0",
+    "@yarnpkg/core": "^3.3.0",
+    "@yarnpkg/plugin-git": "^2.6.3"
   },
   "repository": {
     "type": "git",