@yarnpkg/cli 4.1.0 → 4.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yarnpkg/cli",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "license": "BSD-2-Clause",
   "main": "./lib/index.js",
   "exports": {
@@ -8,14 +8,14 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@yarnpkg/core": "^4.0.3",
+    "@yarnpkg/core": "^4.0.4",
     "@yarnpkg/fslib": "^3.0.2",
     "@yarnpkg/libzip": "^3.0.1",
-    "@yarnpkg/parsers": "^3.0.0",
-    "@yarnpkg/plugin-compat": "^4.0.2",
+    "@yarnpkg/parsers": "^3.0.1",
+    "@yarnpkg/plugin-compat": "^4.0.4",
     "@yarnpkg/plugin-constraints": "^4.0.2",
     "@yarnpkg/plugin-dlx": "^4.0.0",
-    "@yarnpkg/plugin-essentials": "^4.1.0",
+    "@yarnpkg/plugin-essentials": "^4.1.1",
     "@yarnpkg/plugin-exec": "^3.0.0",
     "@yarnpkg/plugin-file": "^3.0.0",
     "@yarnpkg/plugin-git": "^3.0.0",
@@ -26,16 +26,16 @@
     "@yarnpkg/plugin-link": "^3.0.0",
     "@yarnpkg/plugin-nm": "^4.0.2",
     "@yarnpkg/plugin-npm": "^3.0.1",
-    "@yarnpkg/plugin-npm-cli": "^4.0.2",
+    "@yarnpkg/plugin-npm-cli": "^4.0.3",
     "@yarnpkg/plugin-pack": "^4.0.0",
     "@yarnpkg/plugin-patch": "^4.0.1",
-    "@yarnpkg/plugin-pnp": "^4.0.2",
+    "@yarnpkg/plugin-pnp": "^4.0.3",
     "@yarnpkg/plugin-pnpm": "^2.0.0",
     "@yarnpkg/plugin-stage": "^4.0.0",
-    "@yarnpkg/plugin-typescript": "^4.0.0",
-    "@yarnpkg/plugin-version": "^4.0.1",
+    "@yarnpkg/plugin-typescript": "^4.1.0",
+    "@yarnpkg/plugin-version": "^4.0.2",
     "@yarnpkg/plugin-workspace-tools": "^4.1.0",
-    "@yarnpkg/shell": "^4.0.0",
+    "@yarnpkg/shell": "^4.0.1",
     "ci-info": "^3.2.0",
     "clipanion": "^4.0.0-rc.2",
     "semver": "^7.1.2",
@@ -44,12 +44,12 @@
   },
   "devDependencies": {
     "@types/semver": "^7.1.0",
-    "@yarnpkg/builder": "^4.0.0",
+    "@yarnpkg/builder": "^4.1.0",
     "@yarnpkg/monorepo": "^0.0.0",
     "@yarnpkg/pnpify": "^4.0.1"
   },
   "peerDependencies": {
-    "@yarnpkg/core": "^4.0.3"
+    "@yarnpkg/core": "^4.0.4"
   },
   "scripts": {
     "postpack": "rm -rf lib",

package/lib/index.d.ts

@@ -1,8 +0,0 @@
-export { type CommandContext } from '@yarnpkg/core';
-export { BaseCommand } from './tools/BaseCommand';
-export { WorkspaceRequiredError } from './tools/WorkspaceRequiredError';
-export { getDynamicLibs } from './tools/getDynamicLibs';
-export { getPluginConfiguration } from './tools/getPluginConfiguration';
-export { openWorkspace } from './tools/openWorkspace';
-export { type YarnCli, getCli, runExit } from './lib';
-export { pluginCommands } from './pluginCommands';

package/lib/index.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.pluginCommands = exports.runExit = exports.getCli = exports.openWorkspace = exports.getPluginConfiguration = exports.getDynamicLibs = exports.WorkspaceRequiredError = exports.BaseCommand = void 0;
-var BaseCommand_1 = require("./tools/BaseCommand");
-Object.defineProperty(exports, "BaseCommand", { enumerable: true, get: function () { return BaseCommand_1.BaseCommand; } });
-var WorkspaceRequiredError_1 = require("./tools/WorkspaceRequiredError");
-Object.defineProperty(exports, "WorkspaceRequiredError", { enumerable: true, get: function () { return WorkspaceRequiredError_1.WorkspaceRequiredError; } });
-var getDynamicLibs_1 = require("./tools/getDynamicLibs");
-Object.defineProperty(exports, "getDynamicLibs", { enumerable: true, get: function () { return getDynamicLibs_1.getDynamicLibs; } });
-var getPluginConfiguration_1 = require("./tools/getPluginConfiguration");
-Object.defineProperty(exports, "getPluginConfiguration", { enumerable: true, get: function () { return getPluginConfiguration_1.getPluginConfiguration; } });
-var openWorkspace_1 = require("./tools/openWorkspace");
-Object.defineProperty(exports, "openWorkspace", { enumerable: true, get: function () { return openWorkspace_1.openWorkspace; } });
-var lib_1 = require("./lib");
-Object.defineProperty(exports, "getCli", { enumerable: true, get: function () { return lib_1.getCli; } });
-Object.defineProperty(exports, "runExit", { enumerable: true, get: function () { return lib_1.runExit; } });
-var pluginCommands_1 = require("./pluginCommands");
-Object.defineProperty(exports, "pluginCommands", { enumerable: true, get: function () { return pluginCommands_1.pluginCommands; } });

package/lib/lib.d.ts

@@ -1,53 +0,0 @@
-/// <reference types="node" />
-import { CommandContext, PluginConfiguration } from '@yarnpkg/core';
-import { PortablePath } from '@yarnpkg/fslib';
-import { Cli } from 'clipanion';
-export type YarnCli = ReturnType<typeof getBaseCli>;
-declare function getBaseCli({ cwd, pluginConfiguration }: {
-    cwd: PortablePath;
-    pluginConfiguration: PluginConfiguration;
-}): Cli<CommandContext> & {
-    defaultContext: {
-        cwd: PortablePath;
-        plugins: PluginConfiguration;
-        quiet: boolean;
-        stdin: NodeJS.ReadStream & {
-            fd: 0;
-        };
-        stdout: NodeJS.WriteStream & {
-            fd: 1;
-        };
-        stderr: NodeJS.WriteStream & {
-            fd: 2;
-        };
-        env: NodeJS.ProcessEnv;
-        colorDepth: number;
-    };
-};
-export declare function getCli({ cwd, pluginConfiguration }?: {
-    cwd?: PortablePath;
-    pluginConfiguration?: PluginConfiguration;
-}): Promise<Cli<CommandContext> & {
-    defaultContext: {
-        cwd: PortablePath;
-        plugins: PluginConfiguration;
-        quiet: boolean;
-        stdin: NodeJS.ReadStream & {
-            fd: 0;
-        };
-        stdout: NodeJS.WriteStream & {
-            fd: 1;
-        };
-        stderr: NodeJS.WriteStream & {
-            fd: 2;
-        };
-        env: NodeJS.ProcessEnv;
-        colorDepth: number;
-    };
-}>;
-export declare function runExit(argv: Array<string>, { cwd, selfPath, pluginConfiguration }: {
-    cwd: PortablePath;
-    selfPath: PortablePath | null;
-    pluginConfiguration: PluginConfiguration;
-}): Promise<void>;
-export {};

package/lib/lib.js

@@ -1,164 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.runExit = exports.getCli = void 0;
-const core_1 = require("@yarnpkg/core");
-const fslib_1 = require("@yarnpkg/fslib");
-const child_process_1 = require("child_process");
-const ci_info_1 = require("ci-info");
-const clipanion_1 = require("clipanion");
-const pluginCommands_1 = require("./pluginCommands");
-const getPluginConfiguration_1 = require("./tools/getPluginConfiguration");
-function getBaseCli({ cwd, pluginConfiguration }) {
-    const cli = new clipanion_1.Cli({
-        binaryLabel: `Yarn Package Manager`,
-        binaryName: `yarn`,
-        binaryVersion: core_1.YarnVersion ?? `<unknown>`,
-    });
-    return Object.assign(cli, {
-        defaultContext: {
-            ...clipanion_1.Cli.defaultContext,
-            cwd,
-            plugins: pluginConfiguration,
-            quiet: false,
-            stdin: process.stdin,
-            stdout: process.stdout,
-            stderr: process.stderr,
-        },
-    });
-}
-function validateNodejsVersion(cli) {
-    // YARN_IGNORE_NODE is special because this code needs to execute as early as possible.
-    // It's not a regular core setting because Configuration.find may use functions not available
-    // on older Node versions.
-    const ignoreNode = core_1.miscUtils.parseOptionalBoolean(process.env.YARN_IGNORE_NODE);
-    if (ignoreNode)
-        return true;
-    const version = process.versions.node;
-    // Non-exhaustive known requirements:
-    // - 18.12 is the first LTS release
-    const range = `>=18.12.0`;
-    if (core_1.semverUtils.satisfiesWithPrereleases(version, range))
-        return true;
-    const error = new clipanion_1.UsageError(`This tool requires a Node version compatible with ${range} (got ${version}). Upgrade Node, or set \`YARN_IGNORE_NODE=1\` in your environment.`);
-    clipanion_1.Cli.defaultContext.stdout.write(cli.error(error));
-    return false;
-}
-async function getCoreConfiguration({ selfPath, pluginConfiguration }) {
-    // Since we only care about a few very specific settings we tolerate extra configuration key.
-    // If we didn't, we wouldn't even be able to run `yarn config` (which is recommended in the invalid config error message)
-    return await core_1.Configuration.find(fslib_1.npath.toPortablePath(process.cwd()), pluginConfiguration, {
-        strict: false,
-        usePathCheck: selfPath,
-    });
-}
-function runYarnPath(cli, argv, { yarnPath }) {
-    if (!fslib_1.xfs.existsSync(yarnPath)) {
-        (cli.error(new Error(`The "yarn-path" option has been set, but the specified location doesn't exist (${yarnPath}).`)));
-        return 1;
-    }
-    process.on(`SIGINT`, () => {
-        // We don't want SIGINT to kill our process; we want it to kill the
-        // innermost process, whose end will cause our own to exit.
-    });
-    const yarnPathExecOptions = {
-        stdio: `inherit`,
-        env: {
-            ...process.env,
-            YARN_IGNORE_PATH: `1`,
-        },
-    };
-    try {
-        (0, child_process_1.execFileSync)(process.execPath, [fslib_1.npath.fromPortablePath(yarnPath), ...argv], yarnPathExecOptions);
-    }
-    catch (err) {
-        return err.status ?? 1;
-    }
-    return 0;
-}
-function checkCwd(cli, argv) {
-    let cwd = null;
-    let postCwdArgv = argv;
-    if (argv.length >= 2 && argv[0] === `--cwd`) {
-        cwd = fslib_1.npath.toPortablePath(argv[1]);
-        postCwdArgv = argv.slice(2);
-    }
-    else if (argv.length >= 1 && argv[0].startsWith(`--cwd=`)) {
-        cwd = fslib_1.npath.toPortablePath(argv[0].slice(6));
-        postCwdArgv = argv.slice(1);
-    }
-    else if (argv[0] === `add` && argv[argv.length - 2] === `--cwd`) {
-        // CRA adds `--cwd` at the end of the command; it's not ideal, but since
-        // it's unlikely to receive more releases we can just special-case it
-        // TODO v5: remove this special case
-        cwd = fslib_1.npath.toPortablePath(argv[argv.length - 1]);
-        postCwdArgv = argv.slice(0, argv.length - 2);
-    }
-    cli.defaultContext.cwd = cwd !== null
-        ? fslib_1.ppath.resolve(cwd)
-        : fslib_1.ppath.cwd();
-    return postCwdArgv;
-}
-function initTelemetry(cli, { configuration }) {
-    const isTelemetryEnabled = configuration.get(`enableTelemetry`);
-    if (!isTelemetryEnabled || ci_info_1.isCI || !process.stdout.isTTY)
-        return;
-    core_1.Configuration.telemetry = new core_1.TelemetryManager(configuration, `puba9cdc10ec5790a2cf4969dd413a47270`);
-    const PLUGIN_REGEX = /^@yarnpkg\/plugin-(.*)$/;
-    for (const name of configuration.plugins.keys())
-        if (pluginCommands_1.pluginCommands.has(name.match(PLUGIN_REGEX)?.[1] ?? ``))
-            core_1.Configuration.telemetry?.reportPluginName(name);
-    if (cli.binaryVersion) {
-        core_1.Configuration.telemetry.reportVersion(cli.binaryVersion);
-    }
-}
-function initCommands(cli, { configuration }) {
-    for (const plugin of configuration.plugins.values()) {
-        for (const command of plugin.commands || []) {
-            cli.register(command);
-        }
-    }
-}
-async function run(cli, argv, { selfPath, pluginConfiguration }) {
-    if (!validateNodejsVersion(cli))
-        return 1;
-    const configuration = await getCoreConfiguration({
-        selfPath,
-        pluginConfiguration,
-    });
-    const yarnPath = configuration.get(`yarnPath`);
-    const ignorePath = configuration.get(`ignorePath`);
-    if (yarnPath && !ignorePath)
-        return runYarnPath(cli, argv, { yarnPath });
-    delete process.env.YARN_IGNORE_PATH;
-    const postCwdArgv = checkCwd(cli, argv);
-    initTelemetry(cli, { configuration });
-    initCommands(cli, { configuration });
-    const command = cli.process(postCwdArgv, cli.defaultContext);
-    if (!command.help)
-        core_1.Configuration.telemetry?.reportCommandName(command.path.join(` `));
-    return await cli.run(command, cli.defaultContext);
-}
-async function getCli({ cwd = fslib_1.ppath.cwd(), pluginConfiguration = (0, getPluginConfiguration_1.getPluginConfiguration)() } = {}) {
-    const cli = getBaseCli({ cwd, pluginConfiguration });
-    const configuration = await getCoreConfiguration({
-        pluginConfiguration,
-        selfPath: null,
-    });
-    initCommands(cli, { configuration });
-    return cli;
-}
-exports.getCli = getCli;
-async function runExit(argv, { cwd = fslib_1.ppath.cwd(), selfPath, pluginConfiguration }) {
-    const cli = getBaseCli({ cwd, pluginConfiguration });
-    try {
-        process.exitCode = await run(cli, argv, { selfPath, pluginConfiguration });
-    }
-    catch (error) {
-        clipanion_1.Cli.defaultContext.stdout.write(cli.error(error));
-        process.exitCode = 1;
-    }
-    finally {
-        await fslib_1.xfs.rmtempPromise();
-    }
-}
-exports.runExit = runExit;

package/lib/pluginCommands.d.ts

@@ -1 +0,0 @@
-export declare const pluginCommands: Map<string, string[]>;

package/lib/pluginCommands.js

@@ -1,6 +0,0 @@
-"use strict";
-// Don't modify this script directly! Instead, run:
-// yarn build:plugin-commands
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.pluginCommands = void 0;
-exports.pluginCommands = new Map([]);

package/lib/tools/BaseCommand.d.ts

@@ -1,7 +0,0 @@
-import { CommandContext } from '@yarnpkg/core';
-import { Command } from 'clipanion';
-export declare abstract class BaseCommand extends Command<CommandContext> {
-    cwd: string | undefined;
-    abstract execute(): Promise<number | void>;
-    validateAndExecute(): Promise<number>;
-}

package/lib/tools/BaseCommand.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseCommand = void 0;
-const clipanion_1 = require("clipanion");
-class BaseCommand extends clipanion_1.Command {
-    constructor() {
-        super(...arguments);
-        this.cwd = clipanion_1.Option.String(`--cwd`, { hidden: true });
-    }
-    validateAndExecute() {
-        if (typeof this.cwd !== `undefined`)
-            throw new clipanion_1.UsageError(`The --cwd option is ambiguous when used anywhere else than the very first parameter provided in the command line, before even the command path`);
-        return super.validateAndExecute();
-    }
-}
-exports.BaseCommand = BaseCommand;

package/lib/tools/WorkspaceRequiredError.d.ts

@@ -1,5 +0,0 @@
-import { PortablePath } from '@yarnpkg/fslib';
-import { UsageError } from 'clipanion';
-export declare class WorkspaceRequiredError extends UsageError {
-    constructor(projectCwd: PortablePath, cwd: PortablePath);
-}

package/lib/tools/WorkspaceRequiredError.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WorkspaceRequiredError = void 0;
-const core_1 = require("@yarnpkg/core");
-const fslib_1 = require("@yarnpkg/fslib");
-const clipanion_1 = require("clipanion");
-class WorkspaceRequiredError extends clipanion_1.UsageError {
-    constructor(projectCwd, cwd) {
-        const relativePath = fslib_1.ppath.relative(projectCwd, cwd);
-        const manifestPath = fslib_1.ppath.join(projectCwd, core_1.Manifest.fileName);
-        super(`This command can only be run from within a workspace of your project (${relativePath} isn't a workspace of ${manifestPath}).`);
-    }
-}
-exports.WorkspaceRequiredError = WorkspaceRequiredError;

package/lib/tools/getDynamicLibs.d.ts

@@ -1 +0,0 @@
-export declare const getDynamicLibs: () => Map<string, any>;

package/lib/tools/getDynamicLibs.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDynamicLibs = void 0;
-const tslib_1 = require("tslib");
-const cli = tslib_1.__importStar(require("@yarnpkg/cli"));
-const core = tslib_1.__importStar(require("@yarnpkg/core"));
-const fslib = tslib_1.__importStar(require("@yarnpkg/fslib"));
-const libzip = tslib_1.__importStar(require("@yarnpkg/libzip"));
-const parsers = tslib_1.__importStar(require("@yarnpkg/parsers"));
-const shell = tslib_1.__importStar(require("@yarnpkg/shell"));
-const clipanion = tslib_1.__importStar(require("clipanion"));
-const semver = tslib_1.__importStar(require("semver"));
-const typanion = tslib_1.__importStar(require("typanion"));
-const getDynamicLibs = () => new Map([
-    [`@yarnpkg/cli`, cli],
-    [`@yarnpkg/core`, core],
-    [`@yarnpkg/fslib`, fslib],
-    [`@yarnpkg/libzip`, libzip],
-    [`@yarnpkg/parsers`, parsers],
-    [`@yarnpkg/shell`, shell],
-    // Those ones are always useful
-    [`clipanion`, clipanion],
-    [`semver`, semver],
-    [`typanion`, typanion],
-]);
-exports.getDynamicLibs = getDynamicLibs;

package/lib/tools/getPluginConfiguration.d.ts

@@ -1,2 +0,0 @@
-import { PluginConfiguration } from '@yarnpkg/core';
-export declare function getPluginConfiguration(): PluginConfiguration;

package/lib/tools/getPluginConfiguration.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPluginConfiguration = void 0;
-const tslib_1 = require("tslib");
-const package_json_1 = tslib_1.__importDefault(require("@yarnpkg/cli/package.json"));
-const getDynamicLibs_1 = require("./getDynamicLibs");
-function getPluginConfiguration() {
-    const plugins = new Set();
-    for (const dependencyName of package_json_1.default[`@yarnpkg/builder`].bundles.standard)
-        plugins.add(dependencyName);
-    const modules = (0, getDynamicLibs_1.getDynamicLibs)();
-    for (const plugin of plugins)
-        modules.set(plugin, require(plugin).default);
-    return { plugins, modules };
-}
-exports.getPluginConfiguration = getPluginConfiguration;

package/lib/tools/openWorkspace.d.ts

@@ -1,3 +0,0 @@
-import { Configuration } from '@yarnpkg/core';
-import { PortablePath } from '@yarnpkg/fslib';
-export declare function openWorkspace(configuration: Configuration, cwd: PortablePath): Promise<import("@yarnpkg/core").Workspace>;

package/lib/tools/openWorkspace.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.openWorkspace = void 0;
-const core_1 = require("@yarnpkg/core");
-const WorkspaceRequiredError_1 = require("./WorkspaceRequiredError");
-async function openWorkspace(configuration, cwd) {
-    const { project, workspace } = await core_1.Project.find(configuration, cwd);
-    if (!workspace)
-        throw new WorkspaceRequiredError_1.WorkspaceRequiredError(project.cwd, cwd);
-    return workspace;
-}
-exports.openWorkspace = openWorkspace;