@yarnpkg/plugin-essentials 3.0.0-rc.9 → 3.1.0-rc.10

package/lib/commands/up.d.ts

@@ -1,4 +1,5 @@
 import { BaseCommand } from '@yarnpkg/cli';
+import { InstallMode } from '@yarnpkg/core';
 import { Usage } from 'clipanion';
 import * as t from 'typanion';
 export default class UpCommand extends BaseCommand {
@@ -9,13 +10,14 @@ export default class UpCommand extends BaseCommand {
     tilde: boolean;
     caret: boolean;
     recursive: boolean;
+    mode: InstallMode | undefined;
     patterns: string[];
     static schema: t.LooseValidator<{
         [key: string]: unknown;
     }, {
         [key: string]: unknown;
     }>[];
-    execute(): Promise<0 | 1>;
-    executeUpRecursive(): Promise<0 | 1>;
-    executeUpClassic(): Promise<0 | 1>;
+    execute(): Promise<1 | 0>;
+    executeUpRecursive(): Promise<1 | 0>;
+    executeUpClassic(): Promise<1 | 0>;
 }

package/lib/commands/up.js

@@ -7,9 +7,9 @@ const core_2 = require("@yarnpkg/core");
 const core_3 = require("@yarnpkg/core");
 const clipanion_1 = require("clipanion");
 const enquirer_1 = require("enquirer");
-const micromatch_1 = tslib_1.__importDefault(require("micromatch"));
-const t = tslib_1.__importStar(require("typanion"));
-const suggestUtils = tslib_1.__importStar(require("../suggestUtils"));
+const micromatch_1 = (0, tslib_1.__importDefault)(require("micromatch"));
+const t = (0, tslib_1.__importStar)(require("typanion"));
+const suggestUtils = (0, tslib_1.__importStar)(require("../suggestUtils"));
 // eslint-disable-next-line arca/no-default-export
 class UpCommand extends cli_1.BaseCommand {
     constructor() {
@@ -29,6 +29,10 @@ class UpCommand extends cli_1.BaseCommand {
         this.recursive = clipanion_1.Option.Boolean(`-R,--recursive`, false, {
             description: `Resolve again ALL resolutions for those packages`,
         });
+        this.mode = clipanion_1.Option.String(`--mode`, {
+            description: `Change what artifacts installs generate`,
+            validator: t.isEnum(core_2.InstallMode),
+        });
         this.patterns = clipanion_1.Option.Rest();
     }
     async execute() {
@@ -56,7 +60,7 @@ class UpCommand extends cli_1.BaseCommand {
         for (const pattern of this.patterns) {
             if (core_1.structUtils.parseDescriptor(pattern).range !== `unknown`)
                 throw new clipanion_1.UsageError(`Ranges aren't allowed when using --recursive`);
-            for (const stringifiedIdent of micromatch_1.default(stringifiedIdents, pattern)) {
+            for (const stringifiedIdent of (0, micromatch_1.default)(stringifiedIdents, pattern)) {
                 const ident = core_1.structUtils.parseIdent(stringifiedIdent);
                 relevantIdents.add(ident.identHash);
             }
@@ -109,7 +113,7 @@ class UpCommand extends cli_1.BaseCommand {
                     const stringifiedIdents = [...descriptors.values()].map(descriptor => {
                         return core_1.structUtils.stringifyIdent(descriptor);
                     });
-                    for (const stringifiedIdent of micromatch_1.default(stringifiedIdents, core_1.structUtils.stringifyIdent(pseudoDescriptor))) {
+                    for (const stringifiedIdent of (0, micromatch_1.default)(stringifiedIdents, core_1.structUtils.stringifyIdent(pseudoDescriptor))) {
                         const ident = core_1.structUtils.parseIdent(stringifiedIdent);
                         const existingDescriptor = workspace.manifest[target].get(ident.identHash);
                         if (typeof existingDescriptor === `undefined`)
@@ -178,7 +182,7 @@ class UpCommand extends cli_1.BaseCommand {
             }
             else {
                 askedQuestions = true;
-                ({ answer: selected } = await enquirer_1.prompt({
+                ({ answer: selected } = await (0, enquirer_1.prompt)({
                     type: `select`,
                     name: `answer`,
                     message: `Which range to you want to use in ${core_1.structUtils.prettyWorkspace(configuration, workspace)} ❯ ${target}?`,
@@ -226,7 +230,7 @@ class UpCommand extends cli_1.BaseCommand {
             configuration,
             stdout: this.context.stdout,
         }, async (report) => {
-            await project.install({ cache, report });
+            await project.install({ cache, report, mode: this.mode });
         });
         return installReport.exitCode();
     }
@@ -246,6 +250,12 @@ UpCommand.usage = clipanion_1.Command.Usage({
 
       The, \`-C,--caret\`, \`-E,--exact\` and  \`-T,--tilde\` options have the same meaning as in the \`add\` command (they change the modifier used when the range is missing or a tag, and are ignored when the range is explicitly set).
 
+      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.
+
+      - \`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.
+
       Generally you can see \`yarn up\` as a counterpart to what was \`yarn upgrade --latest\` in Yarn 1 (ie it ignores the ranges previously listed in your manifests), but unlike \`yarn upgrade\` which only upgraded dependencies in the current workspace, \`yarn up\` will upgrade all workspaces at the same time.
 
       This command accepts glob patterns as arguments (if valid Descriptors and supported by [micromatch](https://github.com/micromatch/micromatch)). Make sure to escape the patterns, to prevent your own shell from trying to expand them.

package/lib/commands/workspace.d.ts

@@ -1,6 +1,6 @@
-import { CommandContext } from "@yarnpkg/core";
-import { Command, Usage } from "clipanion";
-export default class WorkspaceCommand extends Command<CommandContext> {
+import { BaseCommand } from '@yarnpkg/cli';
+import { Usage } from 'clipanion';
+export default class WorkspaceCommand extends BaseCommand {
     static paths: string[][];
     static usage: Usage;
     workspaceName: string;

package/lib/commands/workspace.js

@@ -5,7 +5,7 @@ const core_1 = require("@yarnpkg/core");
 const core_2 = require("@yarnpkg/core");
 const clipanion_1 = require("clipanion");
 // eslint-disable-next-line arca/no-default-export
-class WorkspaceCommand extends clipanion_1.Command {
+class WorkspaceCommand extends cli_1.BaseCommand {
     constructor() {
         super(...arguments);
         this.workspaceName = clipanion_1.Option.String();

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

@@ -5,5 +5,5 @@ export default class WorkspacesListCommand extends BaseCommand {
     static usage: Usage;
     verbose: boolean;
     json: boolean;
-    execute(): Promise<0 | 1>;
+    execute(): Promise<1 | 0>;
 }

package/lib/dedupeUtils.js

@@ -4,7 +4,7 @@ exports.dedupe = exports.acceptedStrategies = exports.Strategy = void 0;
 const tslib_1 = require("tslib");
 const core_1 = require("@yarnpkg/core");
 const core_2 = require("@yarnpkg/core");
-const micromatch_1 = tslib_1.__importDefault(require("micromatch"));
+const micromatch_1 = (0, tslib_1.__importDefault)(require("micromatch"));
 var Strategy;
 (function (Strategy) {
     /**

package/lib/index.js

@@ -4,44 +4,44 @@ exports.suggestUtils = exports.dedupeUtils = void 0;
 const tslib_1 = require("tslib");
 const core_1 = require("@yarnpkg/core");
 const ci_info_1 = require("ci-info");
-const add_1 = tslib_1.__importDefault(require("./commands/add"));
-const bin_1 = tslib_1.__importDefault(require("./commands/bin"));
-const clean_1 = tslib_1.__importDefault(require("./commands/cache/clean"));
-const get_1 = tslib_1.__importDefault(require("./commands/config/get"));
-const set_1 = tslib_1.__importDefault(require("./commands/config/set"));
-const unset_1 = tslib_1.__importDefault(require("./commands/config/unset"));
-const config_1 = tslib_1.__importDefault(require("./commands/config"));
-const dedupe_1 = tslib_1.__importDefault(require("./commands/dedupe"));
-const clipanion_1 = tslib_1.__importDefault(require("./commands/entries/clipanion"));
-const help_1 = tslib_1.__importDefault(require("./commands/entries/help"));
-const run_1 = tslib_1.__importDefault(require("./commands/entries/run"));
-const version_1 = tslib_1.__importDefault(require("./commands/entries/version"));
-const exec_1 = tslib_1.__importDefault(require("./commands/exec"));
-const peerRequirements_1 = tslib_1.__importDefault(require("./commands/explain/peerRequirements"));
-const info_1 = tslib_1.__importDefault(require("./commands/info"));
-const install_1 = tslib_1.__importDefault(require("./commands/install"));
-const link_1 = tslib_1.__importDefault(require("./commands/link"));
-const node_1 = tslib_1.__importDefault(require("./commands/node"));
-const sources_1 = tslib_1.__importDefault(require("./commands/plugin/import/sources"));
-const import_1 = tslib_1.__importDefault(require("./commands/plugin/import"));
-const list_1 = tslib_1.__importDefault(require("./commands/plugin/list"));
-const remove_1 = tslib_1.__importDefault(require("./commands/plugin/remove"));
-const runtime_1 = tslib_1.__importDefault(require("./commands/plugin/runtime"));
-const rebuild_1 = tslib_1.__importDefault(require("./commands/rebuild"));
-const remove_2 = tslib_1.__importDefault(require("./commands/remove"));
-const runIndex_1 = tslib_1.__importDefault(require("./commands/runIndex"));
-const run_2 = tslib_1.__importDefault(require("./commands/run"));
-const resolution_1 = tslib_1.__importDefault(require("./commands/set/resolution"));
-const sources_2 = tslib_1.__importDefault(require("./commands/set/version/sources"));
-const version_2 = tslib_1.__importDefault(require("./commands/set/version"));
-const unlink_1 = tslib_1.__importDefault(require("./commands/unlink"));
-const up_1 = tslib_1.__importDefault(require("./commands/up"));
-const why_1 = tslib_1.__importDefault(require("./commands/why"));
-const list_2 = tslib_1.__importDefault(require("./commands/workspaces/list"));
-const workspace_1 = tslib_1.__importDefault(require("./commands/workspace"));
-const dedupeUtils = tslib_1.__importStar(require("./dedupeUtils"));
+const add_1 = (0, tslib_1.__importDefault)(require("./commands/add"));
+const bin_1 = (0, tslib_1.__importDefault)(require("./commands/bin"));
+const clean_1 = (0, tslib_1.__importDefault)(require("./commands/cache/clean"));
+const get_1 = (0, tslib_1.__importDefault)(require("./commands/config/get"));
+const set_1 = (0, tslib_1.__importDefault)(require("./commands/config/set"));
+const unset_1 = (0, tslib_1.__importDefault)(require("./commands/config/unset"));
+const config_1 = (0, tslib_1.__importDefault)(require("./commands/config"));
+const dedupe_1 = (0, tslib_1.__importDefault)(require("./commands/dedupe"));
+const clipanion_1 = (0, tslib_1.__importDefault)(require("./commands/entries/clipanion"));
+const help_1 = (0, tslib_1.__importDefault)(require("./commands/entries/help"));
+const run_1 = (0, tslib_1.__importDefault)(require("./commands/entries/run"));
+const version_1 = (0, tslib_1.__importDefault)(require("./commands/entries/version"));
+const exec_1 = (0, tslib_1.__importDefault)(require("./commands/exec"));
+const peerRequirements_1 = (0, tslib_1.__importDefault)(require("./commands/explain/peerRequirements"));
+const info_1 = (0, tslib_1.__importDefault)(require("./commands/info"));
+const install_1 = (0, tslib_1.__importDefault)(require("./commands/install"));
+const link_1 = (0, tslib_1.__importDefault)(require("./commands/link"));
+const node_1 = (0, tslib_1.__importDefault)(require("./commands/node"));
+const sources_1 = (0, tslib_1.__importDefault)(require("./commands/plugin/import/sources"));
+const import_1 = (0, tslib_1.__importDefault)(require("./commands/plugin/import"));
+const list_1 = (0, tslib_1.__importDefault)(require("./commands/plugin/list"));
+const remove_1 = (0, tslib_1.__importDefault)(require("./commands/plugin/remove"));
+const runtime_1 = (0, tslib_1.__importDefault)(require("./commands/plugin/runtime"));
+const rebuild_1 = (0, tslib_1.__importDefault)(require("./commands/rebuild"));
+const remove_2 = (0, tslib_1.__importDefault)(require("./commands/remove"));
+const runIndex_1 = (0, tslib_1.__importDefault)(require("./commands/runIndex"));
+const run_2 = (0, tslib_1.__importDefault)(require("./commands/run"));
+const resolution_1 = (0, tslib_1.__importDefault)(require("./commands/set/resolution"));
+const sources_2 = (0, tslib_1.__importDefault)(require("./commands/set/version/sources"));
+const version_2 = (0, tslib_1.__importDefault)(require("./commands/set/version"));
+const unlink_1 = (0, tslib_1.__importDefault)(require("./commands/unlink"));
+const up_1 = (0, tslib_1.__importDefault)(require("./commands/up"));
+const why_1 = (0, tslib_1.__importDefault)(require("./commands/why"));
+const list_2 = (0, tslib_1.__importDefault)(require("./commands/workspaces/list"));
+const workspace_1 = (0, tslib_1.__importDefault)(require("./commands/workspace"));
+const dedupeUtils = (0, tslib_1.__importStar)(require("./dedupeUtils"));
 exports.dedupeUtils = dedupeUtils;
-const suggestUtils = tslib_1.__importStar(require("./suggestUtils"));
+const suggestUtils = (0, tslib_1.__importStar)(require("./suggestUtils"));
 exports.suggestUtils = suggestUtils;
 const plugin = {
     configuration: {

package/lib/suggestUtils.d.ts

@@ -24,6 +24,11 @@ export declare enum Modifier {
     TILDE = "~",
     EXACT = ""
 }
+export declare enum WorkspaceModifier {
+    CARET = "^",
+    TILDE = "~",
+    EXACT = "*"
+}
 export declare enum Strategy {
     /**
      * If set, the suggest engine will offer to keep the current version if the
@@ -60,6 +65,8 @@ export declare function extractRangeModifier(range: string, { project }: {
     project: Project;
 }): string;
 export declare function applyModifier(descriptor: Descriptor, modifier: Modifier): Descriptor;
+export declare function toWorkspaceModifier(modifier: Modifier): WorkspaceModifier;
+export declare function makeWorkspaceDescriptor(workspace: Workspace, modifier: Modifier): Descriptor;
 export declare function findProjectDescriptors(ident: Ident, { project, target }: {
     project: Project;
     target: Target;

package/lib/suggestUtils.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchDescriptorFrom = exports.getSuggestedDescriptors = exports.extractDescriptorFromPath = exports.findProjectDescriptors = exports.applyModifier = exports.extractRangeModifier = exports.getModifier = exports.Strategy = exports.Modifier = exports.Target = void 0;
+exports.fetchDescriptorFrom = exports.getSuggestedDescriptors = exports.extractDescriptorFromPath = exports.findProjectDescriptors = exports.makeWorkspaceDescriptor = exports.toWorkspaceModifier = exports.applyModifier = exports.extractRangeModifier = exports.getModifier = exports.Strategy = exports.WorkspaceModifier = exports.Modifier = exports.Target = void 0;
 const tslib_1 = require("tslib");
 const core_1 = require("@yarnpkg/core");
 const core_2 = require("@yarnpkg/core");
 const fslib_1 = require("@yarnpkg/fslib");
-const semver_1 = tslib_1.__importDefault(require("semver"));
+const semver_1 = (0, tslib_1.__importDefault)(require("semver"));
+const WORKSPACE_PROTOCOL = `workspace:`;
 var Target;
 (function (Target) {
     Target["REGULAR"] = "dependencies";
@@ -18,6 +19,12 @@ var Modifier;
     Modifier["TILDE"] = "~";
     Modifier["EXACT"] = "";
 })(Modifier = exports.Modifier || (exports.Modifier = {}));
+var WorkspaceModifier;
+(function (WorkspaceModifier) {
+    WorkspaceModifier["CARET"] = "^";
+    WorkspaceModifier["TILDE"] = "~";
+    WorkspaceModifier["EXACT"] = "*";
+})(WorkspaceModifier = exports.WorkspaceModifier || (exports.WorkspaceModifier = {}));
 var Strategy;
 (function (Strategy) {
     /**
@@ -69,6 +76,23 @@ function applyModifier(descriptor, modifier) {
     return core_2.structUtils.makeDescriptor(descriptor, core_2.structUtils.makeRange({ protocol, source, params, selector }));
 }
 exports.applyModifier = applyModifier;
+function toWorkspaceModifier(modifier) {
+    switch (modifier) {
+        case Modifier.CARET:
+            return WorkspaceModifier.CARET;
+        case Modifier.TILDE:
+            return WorkspaceModifier.TILDE;
+        case Modifier.EXACT:
+            return WorkspaceModifier.EXACT;
+        default:
+            throw new Error(`Assertion failed: Unknown modifier: "${modifier}"`);
+    }
+}
+exports.toWorkspaceModifier = toWorkspaceModifier;
+function makeWorkspaceDescriptor(workspace, modifier) {
+    return core_2.structUtils.makeDescriptor(workspace.anchoredDescriptor, `${WORKSPACE_PROTOCOL}${toWorkspaceModifier(modifier)}`);
+}
+exports.makeWorkspaceDescriptor = makeWorkspaceDescriptor;
 async function findProjectDescriptors(ident, { project, target }) {
     const matches = new Map();
     const getDescriptorEntry = (descriptor) => {
@@ -229,10 +253,11 @@ async function getSuggestedDescriptors(request, { project, workspace, cache, tar
                         const candidateWorkspace = project.tryWorkspaceByIdent(request);
                         if (candidateWorkspace === null)
                             return;
+                        const workspaceDescriptor = makeWorkspaceDescriptor(candidateWorkspace, modifier);
                         suggested.push({
-                            descriptor: candidateWorkspace.anchoredDescriptor,
-                            name: `Attach ${core_2.structUtils.prettyWorkspace(project.configuration, candidateWorkspace)}`,
-                            reason: `(local workspace at ${candidateWorkspace.cwd})`,
+                            descriptor: workspaceDescriptor,
+                            name: `Attach ${core_2.structUtils.prettyDescriptor(project.configuration, workspaceDescriptor)}`,
+                            reason: `(local workspace at ${core_2.formatUtils.pretty(project.configuration, candidateWorkspace.relativeCwd, core_2.formatUtils.Type.PATH)})`,
                         });
                     });
                 }

package/package.json

@@ -1,15 +1,14 @@
 {
   "name": "@yarnpkg/plugin-essentials",
-  "version": "3.0.0-rc.9",
+  "version": "3.1.0-rc.10",
   "license": "BSD-2-Clause",
   "main": "./lib/index.js",
   "dependencies": {
-    "@yarnpkg/fslib": "^2.5.0-rc.9",
-    "@yarnpkg/json-proxy": "^2.1.1-rc.7",
-    "@yarnpkg/parsers": "^2.4.0-rc.7",
-    "@yarnpkg/shell": "^3.0.0-rc.9",
-    "ci-info": "^2.0.0",
-    "clipanion": "^3.0.0-rc.10",
+    "@yarnpkg/fslib": "^2.6.0-rc.10",
+    "@yarnpkg/json-proxy": "^2.1.1",
+    "@yarnpkg/parsers": "^2.4.1-rc.10",
+    "ci-info": "^3.2.0",
+    "clipanion": "^3.0.1",
     "enquirer": "^2.3.6",
     "lodash": "^4.17.15",
     "micromatch": "^4.0.2",
@@ -18,17 +17,16 @@
     "typanion": "^3.3.0"
   },
   "peerDependencies": {
-    "@yarnpkg/cli": "^3.0.0-rc.9",
-    "@yarnpkg/core": "^3.0.0-rc.9"
+    "@yarnpkg/cli": "^3.1.0-rc.10",
+    "@yarnpkg/core": "^3.1.0-rc.11"
   },
   "devDependencies": {
-    "@types/ci-info": "^2",
     "@types/lodash": "^4.14.136",
     "@types/micromatch": "^4.0.1",
     "@types/semver": "^7.1.0",
     "@types/treeify": "^1.0.0",
-    "@yarnpkg/cli": "3.0.0-rc.9",
-    "@yarnpkg/core": "3.0.0-rc.9"
+    "@yarnpkg/cli": "^3.1.0-rc.10",
+    "@yarnpkg/core": "^3.1.0-rc.11"
   },
   "repository": {
     "type": "git",
@@ -49,6 +47,6 @@
   "engines": {
     "node": ">=12 <14 || 14.2 - 14.9 || >14.10.0"
   },
-  "stableVersion": "2.4.0",
+  "stableVersion": "3.0.0",
   "typings": "./lib/index.d.ts"
 }