@yarnpkg/plugin-pnp 4.0.1 → 4.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yarnpkg/plugin-pnp",
-  "version": "4.0.1",
+  "version": "4.0.3",
   "license": "BSD-2-Clause",
   "main": "./lib/index.js",
   "exports": {
@@ -8,21 +8,21 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@yarnpkg/fslib": "^3.0.1",
+    "@yarnpkg/fslib": "^3.0.2",
     "@yarnpkg/plugin-stage": "^4.0.0",
-    "@yarnpkg/pnp": "^4.0.0",
+    "@yarnpkg/pnp": "^4.0.3",
     "clipanion": "^4.0.0-rc.2",
     "micromatch": "^4.0.2",
     "tslib": "^2.4.0"
   },
   "peerDependencies": {
-    "@yarnpkg/cli": "^4.0.1",
-    "@yarnpkg/core": "^4.0.1"
+    "@yarnpkg/cli": "^4.2.0",
+    "@yarnpkg/core": "^4.0.4"
   },
   "devDependencies": {
     "@types/micromatch": "^4.0.1",
-    "@yarnpkg/cli": "^4.0.1",
-    "@yarnpkg/core": "^4.0.1"
+    "@yarnpkg/cli": "^4.2.0",
+    "@yarnpkg/core": "^4.0.4"
   },
   "repository": {
     "type": "git",

package/lib/PnpLinker.d.ts

@@ -1,57 +0,0 @@
-import { Descriptor, LocatorHash, InstallPackageExtraApi } from '@yarnpkg/core';
-import { FetchResult, Locator, Package } from '@yarnpkg/core';
-import { Linker, LinkOptions, MinimalLinkOptions, Installer } from '@yarnpkg/core';
-import { PortablePath } from '@yarnpkg/fslib';
-import { PnpSettings } from '@yarnpkg/pnp';
-export declare class PnpLinker implements Linker {
-    protected mode: string;
-    private pnpCache;
-    getCustomDataKey(): string;
-    supportsPackage(pkg: Package, opts: MinimalLinkOptions): boolean;
-    findPackageLocation(locator: Locator, opts: LinkOptions): Promise<PortablePath>;
-    findPackageLocator(location: PortablePath, opts: LinkOptions): Promise<Locator | null>;
-    makeInstaller(opts: LinkOptions): PnpInstaller;
-    private isEnabled;
-}
-export declare class PnpInstaller implements Installer {
-    protected opts: LinkOptions;
-    protected mode: string;
-    private readonly asyncActions;
-    private readonly packageRegistry;
-    private readonly virtualTemplates;
-    private isESMLoaderRequired;
-    constructor(opts: LinkOptions);
-    private customData;
-    attachCustomData(customData: any): void;
-    installPackage(pkg: Package, fetchResult: FetchResult, api: InstallPackageExtraApi): Promise<{
-        packageLocation: PortablePath;
-        buildRequest: import("@yarnpkg/core").BuildRequest | null;
-    }>;
-    attachInternalDependencies(locator: Locator, dependencies: Array<[Descriptor, Locator]>): Promise<void>;
-    attachExternalDependents(locator: Locator, dependentPaths: Array<PortablePath>): Promise<void>;
-    finalizeInstall(): Promise<{
-        customData: {
-            store: Map<LocatorHash, {
-                manifest: {
-                    scripts: Map<string, string>;
-                    preferUnplugged: boolean | null;
-                    type: string | null;
-                };
-                misc: {
-                    extractHint: boolean;
-                    hasBindingGyp: boolean;
-                };
-            }>;
-        };
-    } | undefined>;
-    transformPnpSettings(pnpSettings: PnpSettings): Promise<void>;
-    private isEsmEnabled;
-    finalizeInstallWithPnp(pnpSettings: PnpSettings): Promise<void>;
-    private locateNodeModules;
-    private readonly unpluggedPaths;
-    private unplugPackageIfNeeded;
-    private shouldBeUnplugged;
-    private unplugPackage;
-    private getPackageInformation;
-    private getDiskInformation;
-}

package/lib/PnpLinker.js

@@ -1,408 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PnpInstaller = exports.PnpLinker = 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 pnp_1 = require("@yarnpkg/pnp");
-const clipanion_1 = require("clipanion");
-const index_1 = require("./index");
-const jsInstallUtils = tslib_1.__importStar(require("./jsInstallUtils"));
-const pnpUtils = tslib_1.__importStar(require("./pnpUtils"));
-const FORCED_UNPLUG_PACKAGES = new Set([
-    // Contains native binaries
-    core_1.structUtils.makeIdent(null, `open`).identHash,
-    core_1.structUtils.makeIdent(null, `opn`).identHash,
-]);
-class PnpLinker {
-    constructor() {
-        this.mode = `strict`;
-        this.pnpCache = new Map();
-    }
-    getCustomDataKey() {
-        return JSON.stringify({
-            name: `PnpLinker`,
-            version: 2,
-        });
-    }
-    supportsPackage(pkg, opts) {
-        return this.isEnabled(opts);
-    }
-    async findPackageLocation(locator, opts) {
-        if (!this.isEnabled(opts))
-            throw new Error(`Assertion failed: Expected the PnP linker to be enabled`);
-        const pnpPath = (0, index_1.getPnpPath)(opts.project).cjs;
-        if (!fslib_1.xfs.existsSync(pnpPath))
-            throw new clipanion_1.UsageError(`The project in ${core_1.formatUtils.pretty(opts.project.configuration, `${opts.project.cwd}/package.json`, core_1.formatUtils.Type.PATH)} doesn't seem to have been installed - running an install there might help`);
-        const pnpFile = core_1.miscUtils.getFactoryWithDefault(this.pnpCache, pnpPath, () => {
-            return core_1.miscUtils.dynamicRequire(pnpPath, { cachingStrategy: core_1.miscUtils.CachingStrategy.FsTime });
-        });
-        const packageLocator = { name: core_1.structUtils.stringifyIdent(locator), reference: locator.reference };
-        const packageInformation = pnpFile.getPackageInformation(packageLocator);
-        if (!packageInformation)
-            throw new clipanion_1.UsageError(`Couldn't find ${core_1.structUtils.prettyLocator(opts.project.configuration, locator)} in the currently installed PnP map - running an install might help`);
-        return fslib_1.npath.toPortablePath(packageInformation.packageLocation);
-    }
-    async findPackageLocator(location, opts) {
-        if (!this.isEnabled(opts))
-            return null;
-        const pnpPath = (0, index_1.getPnpPath)(opts.project).cjs;
-        if (!fslib_1.xfs.existsSync(pnpPath))
-            return null;
-        const pnpFile = core_1.miscUtils.getFactoryWithDefault(this.pnpCache, pnpPath, () => {
-            return core_1.miscUtils.dynamicRequire(pnpPath, { cachingStrategy: core_1.miscUtils.CachingStrategy.FsTime });
-        });
-        const locator = pnpFile.findPackageLocator(fslib_1.npath.fromPortablePath(location));
-        if (!locator)
-            return null;
-        return core_1.structUtils.makeLocator(core_1.structUtils.parseIdent(locator.name), locator.reference);
-    }
-    makeInstaller(opts) {
-        return new PnpInstaller(opts);
-    }
-    isEnabled(opts) {
-        if (opts.project.configuration.get(`nodeLinker`) !== `pnp`)
-            return false;
-        if (opts.project.configuration.get(`pnpMode`) !== this.mode)
-            return false;
-        return true;
-    }
-}
-exports.PnpLinker = PnpLinker;
-class PnpInstaller {
-    constructor(opts) {
-        this.opts = opts;
-        this.mode = `strict`;
-        this.asyncActions = new core_1.miscUtils.AsyncActions(10);
-        this.packageRegistry = new Map();
-        this.virtualTemplates = new Map();
-        this.isESMLoaderRequired = false;
-        this.customData = {
-            store: new Map(),
-        };
-        this.unpluggedPaths = new Set();
-        this.opts = opts;
-    }
-    attachCustomData(customData) {
-        this.customData = customData;
-    }
-    async installPackage(pkg, fetchResult, api) {
-        const key1 = core_1.structUtils.stringifyIdent(pkg);
-        const key2 = pkg.reference;
-        const isWorkspace = !!this.opts.project.tryWorkspaceByLocator(pkg);
-        const isVirtual = core_1.structUtils.isVirtualLocator(pkg);
-        const hasVirtualInstances = 
-        // Only packages with peer dependencies have virtual instances
-        pkg.peerDependencies.size > 0 &&
-            // Only packages with peer dependencies have virtual instances
-            !isVirtual;
-        const mayNeedToBeBuilt = 
-        // Virtual instance templates don't need to be built, since they don't truly exist
-        !hasVirtualInstances &&
-            // Workspaces aren't built by the linkers; they are managed by the core itself
-            !isWorkspace;
-        const mayNeedToBeUnplugged = 
-        // Virtual instance templates don't need to be unplugged, since they don't truly exist
-        !hasVirtualInstances &&
-            // We never need to unplug soft links, since we don't control them
-            pkg.linkType !== core_2.LinkType.SOFT;
-        let customPackageData;
-        let dependencyMeta;
-        if (mayNeedToBeBuilt || mayNeedToBeUnplugged) {
-            const devirtualizedLocator = isVirtual ? core_1.structUtils.devirtualizeLocator(pkg) : pkg;
-            customPackageData = this.customData.store.get(devirtualizedLocator.locatorHash);
-            if (typeof customPackageData === `undefined`) {
-                customPackageData = await extractCustomPackageData(fetchResult);
-                if (pkg.linkType === core_2.LinkType.HARD) {
-                    this.customData.store.set(devirtualizedLocator.locatorHash, customPackageData);
-                }
-            }
-            if (customPackageData.manifest.type === `module`)
-                this.isESMLoaderRequired = true;
-            dependencyMeta = this.opts.project.getDependencyMeta(devirtualizedLocator, pkg.version);
-        }
-        const buildRequest = mayNeedToBeBuilt
-            ? jsInstallUtils.extractBuildRequest(pkg, customPackageData, dependencyMeta, { configuration: this.opts.project.configuration })
-            : null;
-        const packageFs = mayNeedToBeUnplugged
-            ? await this.unplugPackageIfNeeded(pkg, customPackageData, fetchResult, dependencyMeta, api)
-            : fetchResult.packageFs;
-        if (fslib_1.ppath.isAbsolute(fetchResult.prefixPath))
-            throw new Error(`Assertion failed: Expected the prefix path (${fetchResult.prefixPath}) to be relative to the parent`);
-        const packageRawLocation = fslib_1.ppath.resolve(packageFs.getRealPath(), fetchResult.prefixPath);
-        const packageLocation = normalizeDirectoryPath(this.opts.project.cwd, packageRawLocation);
-        const packageDependencies = new Map();
-        const packagePeers = new Set();
-        // Only virtual packages should have effective peer dependencies, but the
-        // workspaces are a special case because the original packages are kept in
-        // the dependency tree even after being virtualized; so in their case we
-        // just ignore their declared peer dependencies.
-        if (isVirtual) {
-            for (const descriptor of pkg.peerDependencies.values()) {
-                packageDependencies.set(core_1.structUtils.stringifyIdent(descriptor), null);
-                packagePeers.add(core_1.structUtils.stringifyIdent(descriptor));
-            }
-            if (!isWorkspace) {
-                const devirtualized = core_1.structUtils.devirtualizeLocator(pkg);
-                this.virtualTemplates.set(devirtualized.locatorHash, {
-                    location: normalizeDirectoryPath(this.opts.project.cwd, fslib_1.VirtualFS.resolveVirtual(packageRawLocation)),
-                    locator: devirtualized,
-                });
-            }
-        }
-        core_1.miscUtils.getMapWithDefault(this.packageRegistry, key1).set(key2, {
-            packageLocation,
-            packageDependencies,
-            packagePeers,
-            linkType: pkg.linkType,
-            discardFromLookup: fetchResult.discardFromLookup || false,
-        });
-        return {
-            packageLocation: packageRawLocation,
-            buildRequest,
-        };
-    }
-    async attachInternalDependencies(locator, dependencies) {
-        const packageInformation = this.getPackageInformation(locator);
-        for (const [descriptor, locator] of dependencies) {
-            const target = !core_1.structUtils.areIdentsEqual(descriptor, locator)
-                ? [core_1.structUtils.stringifyIdent(locator), locator.reference]
-                : locator.reference;
-            packageInformation.packageDependencies.set(core_1.structUtils.stringifyIdent(descriptor), target);
-        }
-    }
-    async attachExternalDependents(locator, dependentPaths) {
-        for (const dependentPath of dependentPaths) {
-            const packageInformation = this.getDiskInformation(dependentPath);
-            packageInformation.packageDependencies.set(core_1.structUtils.stringifyIdent(locator), locator.reference);
-        }
-    }
-    async finalizeInstall() {
-        if (this.opts.project.configuration.get(`pnpMode`) !== this.mode)
-            return undefined;
-        const pnpPath = (0, index_1.getPnpPath)(this.opts.project);
-        if (!this.isEsmEnabled())
-            await fslib_1.xfs.removePromise(pnpPath.esmLoader);
-        if (this.opts.project.configuration.get(`nodeLinker`) !== `pnp`) {
-            await fslib_1.xfs.removePromise(pnpPath.cjs);
-            await fslib_1.xfs.removePromise(pnpPath.data);
-            await fslib_1.xfs.removePromise(pnpPath.esmLoader);
-            await fslib_1.xfs.removePromise(this.opts.project.configuration.get(`pnpUnpluggedFolder`));
-            return undefined;
-        }
-        for (const { locator, location } of this.virtualTemplates.values()) {
-            core_1.miscUtils.getMapWithDefault(this.packageRegistry, core_1.structUtils.stringifyIdent(locator)).set(locator.reference, {
-                packageLocation: location,
-                packageDependencies: new Map(),
-                packagePeers: new Set(),
-                linkType: core_2.LinkType.SOFT,
-                discardFromLookup: false,
-            });
-        }
-        this.packageRegistry.set(null, new Map([
-            [null, this.getPackageInformation(this.opts.project.topLevelWorkspace.anchoredLocator)],
-        ]));
-        const pnpFallbackMode = this.opts.project.configuration.get(`pnpFallbackMode`);
-        const dependencyTreeRoots = this.opts.project.workspaces.map(({ anchoredLocator }) => ({ name: core_1.structUtils.stringifyIdent(anchoredLocator), reference: anchoredLocator.reference }));
-        const enableTopLevelFallback = pnpFallbackMode !== `none`;
-        const fallbackExclusionList = [];
-        const fallbackPool = new Map();
-        const ignorePattern = core_1.miscUtils.buildIgnorePattern([`.yarn/sdks/**`, ...this.opts.project.configuration.get(`pnpIgnorePatterns`)]);
-        const packageRegistry = this.packageRegistry;
-        const shebang = this.opts.project.configuration.get(`pnpShebang`);
-        if (pnpFallbackMode === `dependencies-only`)
-            for (const pkg of this.opts.project.storedPackages.values())
-                if (this.opts.project.tryWorkspaceByLocator(pkg))
-                    fallbackExclusionList.push({ name: core_1.structUtils.stringifyIdent(pkg), reference: pkg.reference });
-        await this.asyncActions.wait();
-        await this.finalizeInstallWithPnp({
-            dependencyTreeRoots,
-            enableTopLevelFallback,
-            fallbackExclusionList,
-            fallbackPool,
-            ignorePattern,
-            packageRegistry,
-            shebang,
-        });
-        return {
-            customData: this.customData,
-        };
-    }
-    async transformPnpSettings(pnpSettings) {
-        // Nothing to transform
-    }
-    isEsmEnabled() {
-        if (this.opts.project.configuration.sources.has(`pnpEnableEsmLoader`))
-            return this.opts.project.configuration.get(`pnpEnableEsmLoader`);
-        if (this.isESMLoaderRequired)
-            return true;
-        for (const workspace of this.opts.project.workspaces) {
-            if (workspace.manifest.type === `module`) {
-                return true;
-            }
-        }
-        return false;
-    }
-    async finalizeInstallWithPnp(pnpSettings) {
-        const pnpPath = (0, index_1.getPnpPath)(this.opts.project);
-        const nodeModules = await this.locateNodeModules(pnpSettings.ignorePattern);
-        if (nodeModules.length > 0) {
-            this.opts.report.reportWarning(core_2.MessageName.DANGEROUS_NODE_MODULES, `One or more node_modules have been detected and will be removed. This operation may take some time.`);
-            for (const nodeModulesPath of nodeModules) {
-                await fslib_1.xfs.removePromise(nodeModulesPath);
-            }
-        }
-        await this.transformPnpSettings(pnpSettings);
-        if (this.opts.project.configuration.get(`pnpEnableInlining`)) {
-            const loaderFile = (0, pnp_1.generateInlinedScript)(pnpSettings);
-            await fslib_1.xfs.changeFilePromise(pnpPath.cjs, loaderFile, {
-                automaticNewlines: true,
-                mode: 0o755,
-            });
-            await fslib_1.xfs.removePromise(pnpPath.data);
-        }
-        else {
-            const { dataFile, loaderFile } = (0, pnp_1.generateSplitScript)(pnpSettings);
-            await fslib_1.xfs.changeFilePromise(pnpPath.cjs, loaderFile, {
-                automaticNewlines: true,
-                mode: 0o755,
-            });
-            await fslib_1.xfs.changeFilePromise(pnpPath.data, dataFile, {
-                automaticNewlines: true,
-                mode: 0o644,
-            });
-        }
-        if (this.isEsmEnabled()) {
-            this.opts.report.reportWarning(core_2.MessageName.UNNAMED, `ESM support for PnP uses the experimental loader API and is therefore experimental`);
-            await fslib_1.xfs.changeFilePromise(pnpPath.esmLoader, (0, pnp_1.getESMLoaderTemplate)(), {
-                automaticNewlines: true,
-                mode: 0o644,
-            });
-        }
-        const pnpUnpluggedFolder = this.opts.project.configuration.get(`pnpUnpluggedFolder`);
-        if (this.unpluggedPaths.size === 0) {
-            await fslib_1.xfs.removePromise(pnpUnpluggedFolder);
-        }
-        else {
-            for (const entry of await fslib_1.xfs.readdirPromise(pnpUnpluggedFolder)) {
-                const unpluggedPath = fslib_1.ppath.resolve(pnpUnpluggedFolder, entry);
-                if (!this.unpluggedPaths.has(unpluggedPath)) {
-                    await fslib_1.xfs.removePromise(unpluggedPath);
-                }
-            }
-        }
-    }
-    async locateNodeModules(ignorePattern) {
-        const nodeModules = [];
-        const ignoreRegExp = ignorePattern ? new RegExp(ignorePattern) : null;
-        for (const workspace of this.opts.project.workspaces) {
-            const nodeModulesPath = fslib_1.ppath.join(workspace.cwd, `node_modules`);
-            if (ignoreRegExp && ignoreRegExp.test(fslib_1.ppath.relative(this.opts.project.cwd, workspace.cwd)) || !fslib_1.xfs.existsSync(nodeModulesPath))
-                continue;
-            const directoryListing = await fslib_1.xfs.readdirPromise(nodeModulesPath, {
-                withFileTypes: true,
-            });
-            const nonCacheEntries = directoryListing.filter(entry => {
-                return !entry.isDirectory() || entry.name === `.bin` || !entry.name.startsWith(`.`);
-            });
-            if (nonCacheEntries.length === directoryListing.length) {
-                nodeModules.push(nodeModulesPath);
-            }
-            else {
-                for (const entry of nonCacheEntries) {
-                    nodeModules.push(fslib_1.ppath.join(nodeModulesPath, entry.name));
-                }
-            }
-        }
-        return nodeModules;
-    }
-    async unplugPackageIfNeeded(pkg, customPackageData, fetchResult, dependencyMeta, api) {
-        if (this.shouldBeUnplugged(pkg, customPackageData, dependencyMeta)) {
-            return this.unplugPackage(pkg, fetchResult, api);
-        }
-        else {
-            return fetchResult.packageFs;
-        }
-    }
-    shouldBeUnplugged(pkg, customPackageData, dependencyMeta) {
-        if (typeof dependencyMeta.unplugged !== `undefined`)
-            return dependencyMeta.unplugged;
-        if (FORCED_UNPLUG_PACKAGES.has(pkg.identHash))
-            return true;
-        if (pkg.conditions != null)
-            return true;
-        if (customPackageData.manifest.preferUnplugged !== null)
-            return customPackageData.manifest.preferUnplugged;
-        const buildRequest = jsInstallUtils.extractBuildRequest(pkg, customPackageData, dependencyMeta, { configuration: this.opts.project.configuration });
-        if (buildRequest?.skipped === false || customPackageData.misc.extractHint)
-            return true;
-        return false;
-    }
-    async unplugPackage(locator, fetchResult, api) {
-        const unplugPath = pnpUtils.getUnpluggedPath(locator, { configuration: this.opts.project.configuration });
-        if (this.opts.project.disabledLocators.has(locator.locatorHash))
-            return new fslib_1.AliasFS(unplugPath, { baseFs: fetchResult.packageFs, pathUtils: fslib_1.ppath });
-        this.unpluggedPaths.add(unplugPath);
-        api.holdFetchResult(this.asyncActions.set(locator.locatorHash, async () => {
-            const readyFile = fslib_1.ppath.join(unplugPath, fetchResult.prefixPath, `.ready`);
-            if (await fslib_1.xfs.existsPromise(readyFile))
-                return;
-            // Delete any build state for the locator so it can run anew, this allows users
-            // to remove `.yarn/unplugged` and have the builds run again
-            this.opts.project.storedBuildState.delete(locator.locatorHash);
-            await fslib_1.xfs.mkdirPromise(unplugPath, { recursive: true });
-            await fslib_1.xfs.copyPromise(unplugPath, fslib_1.PortablePath.dot, { baseFs: fetchResult.packageFs, overwrite: false });
-            await fslib_1.xfs.writeFilePromise(readyFile, ``);
-        }));
-        return new fslib_1.CwdFS(unplugPath);
-    }
-    getPackageInformation(locator) {
-        const key1 = core_1.structUtils.stringifyIdent(locator);
-        const key2 = locator.reference;
-        const packageInformationStore = this.packageRegistry.get(key1);
-        if (!packageInformationStore)
-            throw new Error(`Assertion failed: The package information store should have been available (for ${core_1.structUtils.prettyIdent(this.opts.project.configuration, locator)})`);
-        const packageInformation = packageInformationStore.get(key2);
-        if (!packageInformation)
-            throw new Error(`Assertion failed: The package information should have been available (for ${core_1.structUtils.prettyLocator(this.opts.project.configuration, locator)})`);
-        return packageInformation;
-    }
-    getDiskInformation(path) {
-        const packageStore = core_1.miscUtils.getMapWithDefault(this.packageRegistry, `@@disk`);
-        const normalizedPath = normalizeDirectoryPath(this.opts.project.cwd, path);
-        return core_1.miscUtils.getFactoryWithDefault(packageStore, normalizedPath, () => ({
-            packageLocation: normalizedPath,
-            packageDependencies: new Map(),
-            packagePeers: new Set(),
-            linkType: core_2.LinkType.SOFT,
-            discardFromLookup: false,
-        }));
-    }
-}
-exports.PnpInstaller = PnpInstaller;
-function normalizeDirectoryPath(root, folder) {
-    let relativeFolder = fslib_1.ppath.relative(root, folder);
-    if (!relativeFolder.match(/^\.{0,2}\//))
-        // Don't use ppath.join here, it ignores the `.`
-        relativeFolder = `./${relativeFolder}`;
-    return relativeFolder.replace(/\/?$/, `/`);
-}
-async function extractCustomPackageData(fetchResult) {
-    const manifest = await core_2.Manifest.tryFind(fetchResult.prefixPath, { baseFs: fetchResult.packageFs }) ?? new core_2.Manifest();
-    const preservedScripts = new Set([`preinstall`, `install`, `postinstall`]);
-    for (const scriptName of manifest.scripts.keys())
-        if (!preservedScripts.has(scriptName))
-            manifest.scripts.delete(scriptName);
-    return {
-        manifest: {
-            scripts: manifest.scripts,
-            preferUnplugged: manifest.preferUnplugged,
-            type: manifest.type,
-        },
-        misc: {
-            extractHint: jsInstallUtils.getExtractHint(fetchResult),
-            hasBindingGyp: jsInstallUtils.hasBindingGyp(fetchResult),
-        },
-    };
-}

package/lib/commands/unplug.d.ts

@@ -1,11 +0,0 @@
-import { BaseCommand } from '@yarnpkg/cli';
-import { Usage } from 'clipanion';
-export default class UnplugCommand extends BaseCommand {
-    static paths: string[][];
-    static usage: Usage;
-    all: boolean;
-    recursive: boolean;
-    json: boolean;
-    patterns: string[];
-    execute(): Promise<0 | 1>;
-}

package/lib/commands/unplug.js

@@ -1,184 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const cli_1 = require("@yarnpkg/cli");
-const core_1 = require("@yarnpkg/core");
-const core_2 = require("@yarnpkg/core");
-const clipanion_1 = require("clipanion");
-const micromatch_1 = tslib_1.__importDefault(require("micromatch"));
-const pnpUtils = tslib_1.__importStar(require("../pnpUtils"));
-// eslint-disable-next-line arca/no-default-export
-class UnplugCommand extends cli_1.BaseCommand {
-    constructor() {
-        super(...arguments);
-        this.all = clipanion_1.Option.Boolean(`-A,--all`, false, {
-            description: `Unplug direct dependencies from the entire project`,
-        });
-        this.recursive = clipanion_1.Option.Boolean(`-R,--recursive`, false, {
-            description: `Unplug both direct and transitive dependencies`,
-        });
-        this.json = clipanion_1.Option.Boolean(`--json`, false, {
-            description: `Format the output as an NDJSON stream`,
-        });
-        this.patterns = clipanion_1.Option.Rest();
-    }
-    async execute() {
-        const configuration = await core_1.Configuration.find(this.context.cwd, this.context.plugins);
-        const { project, workspace } = await core_1.Project.find(configuration, this.context.cwd);
-        const cache = await core_1.Cache.find(configuration);
-        if (!workspace)
-            throw new cli_1.WorkspaceRequiredError(project.cwd, this.context.cwd);
-        if (configuration.get(`nodeLinker`) !== `pnp`)
-            throw new clipanion_1.UsageError(`This command can only be used if the \`nodeLinker\` option is set to \`pnp\``);
-        await project.restoreInstallState();
-        const unreferencedPatterns = new Set(this.patterns);
-        const matchers = this.patterns.map(pattern => {
-            const patternDescriptor = core_2.structUtils.parseDescriptor(pattern);
-            const pseudoDescriptor = patternDescriptor.range !== `unknown`
-                ? patternDescriptor
-                : core_2.structUtils.makeDescriptor(patternDescriptor, `*`);
-            if (!core_2.semverUtils.validRange(pseudoDescriptor.range))
-                throw new clipanion_1.UsageError(`The range of the descriptor patterns must be a valid semver range (${core_2.structUtils.prettyDescriptor(configuration, pseudoDescriptor)})`);
-            return (pkg) => {
-                const stringifiedIdent = core_2.structUtils.stringifyIdent(pkg);
-                if (!micromatch_1.default.isMatch(stringifiedIdent, core_2.structUtils.stringifyIdent(pseudoDescriptor)))
-                    return false;
-                if (pkg.version && !core_2.semverUtils.satisfiesWithPrereleases(pkg.version, pseudoDescriptor.range))
-                    return false;
-                unreferencedPatterns.delete(pattern);
-                return true;
-            };
-        });
-        const getAllMatchingPackages = () => {
-            const selection = [];
-            for (const pkg of project.storedPackages.values())
-                // Note: We can safely skip virtual packages here, as the
-                // devirtualized copy will always exist inside storedPackages.
-                if (!project.tryWorkspaceByLocator(pkg) && !core_2.structUtils.isVirtualLocator(pkg) && matchers.some(matcher => matcher(pkg)))
-                    selection.push(pkg);
-            return selection;
-        };
-        const getSelectedPackages = (roots) => {
-            const seen = new Set();
-            const selection = [];
-            const traverse = (pkg, depth) => {
-                if (seen.has(pkg.locatorHash))
-                    return;
-                const isWorkspace = !!project.tryWorkspaceByLocator(pkg);
-                if (depth > 0 && !this.recursive && isWorkspace)
-                    return;
-                seen.add(pkg.locatorHash);
-                // Note: We shouldn't skip virtual packages, as
-                // we don't iterate over the devirtualized copies.
-                if (!project.tryWorkspaceByLocator(pkg) && matchers.some(matcher => matcher(pkg)))
-                    selection.push(pkg);
-                // Don't recurse unless requested
-                if (depth > 0 && !this.recursive)
-                    return;
-                for (const dependency of pkg.dependencies.values()) {
-                    const resolution = project.storedResolutions.get(dependency.descriptorHash);
-                    if (!resolution)
-                        throw new Error(`Assertion failed: The resolution should have been registered`);
-                    const nextPkg = project.storedPackages.get(resolution);
-                    if (!nextPkg)
-                        throw new Error(`Assertion failed: The package should have been registered`);
-                    traverse(nextPkg, depth + 1);
-                }
-            };
-            for (const workspace of roots)
-                traverse(workspace.anchoredPackage, 0);
-            return selection;
-        };
-        let selection;
-        let projectOrWorkspaces;
-        // We can shortcut the execution if we want all the dependencies and
-        // transitive dependencies of all the branches: it means we want everything!
-        if (this.all && this.recursive) {
-            selection = getAllMatchingPackages();
-            projectOrWorkspaces = `the project`;
-        }
-        else if (this.all) {
-            selection = getSelectedPackages(project.workspaces);
-            projectOrWorkspaces = `any workspace`;
-        }
-        else {
-            selection = getSelectedPackages([workspace]);
-            projectOrWorkspaces = `this workspace`;
-        }
-        if (unreferencedPatterns.size > 1)
-            throw new clipanion_1.UsageError(`Patterns ${core_1.formatUtils.prettyList(configuration, unreferencedPatterns, core_1.formatUtils.Type.CODE)} don't match any packages referenced by ${projectOrWorkspaces}`);
-        if (unreferencedPatterns.size > 0)
-            throw new clipanion_1.UsageError(`Pattern ${core_1.formatUtils.prettyList(configuration, unreferencedPatterns, core_1.formatUtils.Type.CODE)} doesn't match any packages referenced by ${projectOrWorkspaces}`);
-        selection = core_1.miscUtils.sortMap(selection, pkg => {
-            return core_2.structUtils.stringifyLocator(pkg);
-        });
-        const unplugReport = await core_1.StreamReport.start({
-            configuration,
-            stdout: this.context.stdout,
-            json: this.json,
-        }, async (report) => {
-            for (const pkg of selection) {
-                const version = pkg.version ?? `unknown`;
-                const dependencyMeta = project.topLevelWorkspace.manifest.ensureDependencyMeta(core_2.structUtils.makeDescriptor(pkg, version));
-                dependencyMeta.unplugged = true;
-                report.reportInfo(core_1.MessageName.UNNAMED, `Will unpack ${core_2.structUtils.prettyLocator(configuration, pkg)} to ${core_1.formatUtils.pretty(configuration, pnpUtils.getUnpluggedPath(pkg, { configuration }), core_1.formatUtils.Type.PATH)}`);
-                report.reportJson({
-                    locator: core_2.structUtils.stringifyLocator(pkg),
-                    version,
-                });
-            }
-            await project.topLevelWorkspace.persistManifest();
-            if (!this.json) {
-                report.reportSeparator();
-            }
-        });
-        if (unplugReport.hasErrors())
-            return unplugReport.exitCode();
-        return await project.installWithNewReport({
-            json: this.json,
-            stdout: this.context.stdout,
-        }, {
-            cache,
-        });
-    }
-}
-UnplugCommand.paths = [
-    [`unplug`],
-];
-UnplugCommand.usage = clipanion_1.Command.Usage({
-    description: `force the unpacking of a list of packages`,
-    details: `
-      This command will add the selectors matching the specified patterns to the list of packages that must be unplugged when installed.
-
-      A package being unplugged means that instead of being referenced directly through its archive, it will be unpacked at install time in the directory configured via \`pnpUnpluggedFolder\`. Note that unpacking packages this way is generally not recommended because it'll make it harder to store your packages within the repository. However, it's a good approach to quickly and safely debug some packages, and can even sometimes be required depending on the context (for example when the package contains shellscripts).
-
-      Running the command will set a persistent flag inside your top-level \`package.json\`, in the \`dependenciesMeta\` field. As such, to undo its effects, you'll need to revert the changes made to the manifest and run \`yarn install\` to apply the modification.
-
-      By default, only direct dependencies from the current workspace are affected. If \`-A,--all\` is set, direct dependencies from the entire project are affected. Using the \`-R,--recursive\` flag will affect transitive dependencies as well as direct ones.
-
-      This command accepts glob patterns inside the scope and name components (not the range). Make sure to escape the patterns to prevent your own shell from trying to expand them.
-    `,
-    examples: [[
-            `Unplug the lodash dependency from the active workspace`,
-            `yarn unplug lodash`,
-        ], [
-            `Unplug all instances of lodash referenced by any workspace`,
-            `yarn unplug lodash -A`,
-        ], [
-            `Unplug all instances of lodash referenced by the active workspace and its dependencies`,
-            `yarn unplug lodash -R`,
-        ], [
-            `Unplug all instances of lodash, anywhere`,
-            `yarn unplug lodash -AR`,
-        ], [
-            `Unplug one specific version of lodash`,
-            `yarn unplug lodash@1.2.3`,
-        ], [
-            `Unplug all packages with the \`@babel\` scope`,
-            `yarn unplug '@babel/*'`,
-        ], [
-            `Unplug all packages (only for testing, not recommended)`,
-            `yarn unplug -R '*'`,
-        ]],
-});
-exports.default = UnplugCommand;

package/lib/index.d.ts

@@ -1,31 +0,0 @@
-import { Hooks as CoreHooks, Plugin, Project } from '@yarnpkg/core';
-import { PortablePath } from '@yarnpkg/fslib';
-import { Hooks as StageHooks } from '@yarnpkg/plugin-stage';
-import UnplugCommand from './commands/unplug';
-import * as jsInstallUtils from './jsInstallUtils';
-import * as pnpUtils from './pnpUtils';
-export { UnplugCommand };
-export { jsInstallUtils };
-export { pnpUtils };
-export declare const getPnpPath: (project: Project) => {
-    cjs: PortablePath;
-    data: PortablePath;
-    esmLoader: PortablePath;
-};
-export declare const quotePathIfNeeded: (path: string) => string;
-declare module '@yarnpkg/core' {
-    interface ConfigurationValueMap {
-        nodeLinker: string;
-        winLinkType: string;
-        pnpMode: string;
-        pnpShebang: string;
-        pnpIgnorePatterns: Array<string>;
-        pnpEnableEsmLoader: boolean;
-        pnpEnableInlining: boolean;
-        pnpFallbackMode: string;
-        pnpUnpluggedFolder: PortablePath;
-    }
-}
-declare const plugin: Plugin<CoreHooks & StageHooks>;
-export { PnpInstaller, PnpLinker } from './PnpLinker';
-export default plugin;

package/lib/index.js

@@ -1,126 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PnpLinker = exports.PnpInstaller = exports.quotePathIfNeeded = exports.getPnpPath = exports.pnpUtils = exports.jsInstallUtils = exports.UnplugCommand = void 0;
-const tslib_1 = require("tslib");
-const core_1 = require("@yarnpkg/core");
-const fslib_1 = require("@yarnpkg/fslib");
-const url_1 = require("url");
-const PnpLinker_1 = require("./PnpLinker");
-const unplug_1 = tslib_1.__importDefault(require("./commands/unplug"));
-exports.UnplugCommand = unplug_1.default;
-const jsInstallUtils = tslib_1.__importStar(require("./jsInstallUtils"));
-exports.jsInstallUtils = jsInstallUtils;
-const pnpUtils = tslib_1.__importStar(require("./pnpUtils"));
-exports.pnpUtils = pnpUtils;
-const getPnpPath = (project) => {
-    return {
-        cjs: fslib_1.ppath.join(project.cwd, fslib_1.Filename.pnpCjs),
-        data: fslib_1.ppath.join(project.cwd, fslib_1.Filename.pnpData),
-        esmLoader: fslib_1.ppath.join(project.cwd, fslib_1.Filename.pnpEsmLoader),
-    };
-};
-exports.getPnpPath = getPnpPath;
-const quotePathIfNeeded = (path) => {
-    return /\s/.test(path) ? JSON.stringify(path) : path;
-};
-exports.quotePathIfNeeded = quotePathIfNeeded;
-async function setupScriptEnvironment(project, env, makePathWrapper) {
-    // We still support .pnp.js files to improve multi-project compatibility.
-    // TODO: Drop the question mark in the RegExp after .pnp.js files stop being used.
-    // TODO: Support `-r` as an alias for `--require` (in all packages)
-    const pnpRegularExpression = /\s*--require\s+\S*\.pnp\.c?js\s*/g;
-    const esmLoaderExpression = /\s*--experimental-loader\s+\S*\.pnp\.loader\.mjs\s*/;
-    const nodeOptions = (env.NODE_OPTIONS ?? ``)
-        .replace(pnpRegularExpression, ` `)
-        .replace(esmLoaderExpression, ` `)
-        .trim();
-    // We remove the PnP hook from NODE_OPTIONS because the process can have
-    // NODE_OPTIONS set while changing linkers, which affects build scripts.
-    if (project.configuration.get(`nodeLinker`) !== `pnp`) {
-        env.NODE_OPTIONS = nodeOptions;
-        return;
-    }
-    const pnpPath = (0, exports.getPnpPath)(project);
-    let pnpRequire = `--require ${(0, exports.quotePathIfNeeded)(fslib_1.npath.fromPortablePath(pnpPath.cjs))}`;
-    if (fslib_1.xfs.existsSync(pnpPath.esmLoader))
-        pnpRequire = `${pnpRequire} --experimental-loader ${(0, url_1.pathToFileURL)(fslib_1.npath.fromPortablePath(pnpPath.esmLoader)).href}`;
-    if (fslib_1.xfs.existsSync(pnpPath.cjs)) {
-        env.NODE_OPTIONS = nodeOptions ? `${pnpRequire} ${nodeOptions}` : pnpRequire;
-    }
-}
-async function populateYarnPaths(project, definePath) {
-    const pnpPath = (0, exports.getPnpPath)(project);
-    definePath(pnpPath.cjs);
-    definePath(pnpPath.data);
-    definePath(pnpPath.esmLoader);
-    definePath(project.configuration.get(`pnpUnpluggedFolder`));
-}
-const plugin = {
-    hooks: {
-        populateYarnPaths,
-        setupScriptEnvironment,
-    },
-    configuration: {
-        nodeLinker: {
-            description: `The linker used for installing Node packages, one of: "pnp", "pnpm", or "node-modules"`,
-            type: core_1.SettingsType.STRING,
-            default: `pnp`,
-        },
-        winLinkType: {
-            description: `Whether Yarn should use Windows Junctions or symlinks when creating links on Windows.`,
-            type: core_1.SettingsType.STRING,
-            values: [
-                core_1.WindowsLinkType.JUNCTIONS,
-                core_1.WindowsLinkType.SYMLINKS,
-            ],
-            default: core_1.WindowsLinkType.JUNCTIONS,
-        },
-        pnpMode: {
-            description: `If 'strict', generates standard PnP maps. If 'loose', merges them with the n_m resolution.`,
-            type: core_1.SettingsType.STRING,
-            default: `strict`,
-        },
-        pnpShebang: {
-            description: `String to prepend to the generated PnP script`,
-            type: core_1.SettingsType.STRING,
-            default: `#!/usr/bin/env node`,
-        },
-        pnpIgnorePatterns: {
-            description: `Array of glob patterns; files matching them will use the classic resolution`,
-            type: core_1.SettingsType.STRING,
-            default: [],
-            isArray: true,
-        },
-        pnpEnableEsmLoader: {
-            description: `If true, Yarn will generate an ESM loader (\`.pnp.loader.mjs\`). If this is not explicitly set Yarn tries to automatically detect whether ESM support is required.`,
-            type: core_1.SettingsType.BOOLEAN,
-            default: false,
-        },
-        pnpEnableInlining: {
-            description: `If true, the PnP data will be inlined along with the generated loader`,
-            type: core_1.SettingsType.BOOLEAN,
-            default: true,
-        },
-        pnpFallbackMode: {
-            description: `If true, the generated PnP loader will follow the top-level fallback rule`,
-            type: core_1.SettingsType.STRING,
-            default: `dependencies-only`,
-        },
-        pnpUnpluggedFolder: {
-            description: `Folder where the unplugged packages must be stored`,
-            type: core_1.SettingsType.ABSOLUTE_PATH,
-            default: `./.yarn/unplugged`,
-        },
-    },
-    linkers: [
-        PnpLinker_1.PnpLinker,
-    ],
-    commands: [
-        unplug_1.default,
-    ],
-};
-var PnpLinker_2 = require("./PnpLinker");
-Object.defineProperty(exports, "PnpInstaller", { enumerable: true, get: function () { return PnpLinker_2.PnpInstaller; } });
-Object.defineProperty(exports, "PnpLinker", { enumerable: true, get: function () { return PnpLinker_2.PnpLinker; } });
-// eslint-disable-next-line arca/no-default-export
-exports.default = plugin;

package/lib/jsInstallUtils.d.ts

@@ -1,13 +0,0 @@
-import { Configuration, DependencyMeta, FetchResult, Manifest, Package, BuildRequest } from '@yarnpkg/core';
-export declare function checkManifestCompatibility(pkg: Package): boolean;
-export type ExtractBuildScriptDataRequirements = {
-    manifest: Pick<Manifest, 'scripts'>;
-    misc: {
-        hasBindingGyp: boolean;
-    };
-};
-export declare function extractBuildRequest(pkg: Package, requirements: ExtractBuildScriptDataRequirements, dependencyMeta: DependencyMeta, { configuration }: {
-    configuration: Configuration;
-}): BuildRequest | null;
-export declare function getExtractHint(fetchResult: FetchResult): boolean;
-export declare function hasBindingGyp(fetchResult: FetchResult): boolean;

package/lib/jsInstallUtils.js

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasBindingGyp = exports.getExtractHint = exports.extractBuildRequest = exports.checkManifestCompatibility = void 0;
-const core_1 = require("@yarnpkg/core");
-const fslib_1 = require("@yarnpkg/fslib");
-function checkManifestCompatibility(pkg) {
-    return core_1.structUtils.isPackageCompatible(pkg, core_1.nodeUtils.getArchitectureSet());
-}
-exports.checkManifestCompatibility = checkManifestCompatibility;
-function extractBuildRequest(pkg, requirements, dependencyMeta, { configuration }) {
-    const directives = [];
-    for (const scriptName of [`preinstall`, `install`, `postinstall`])
-        if (requirements.manifest.scripts.has(scriptName))
-            directives.push({ type: core_1.BuildDirectiveType.SCRIPT, script: scriptName });
-    // Detect cases where a package has a binding.gyp but no install script
-    if (!requirements.manifest.scripts.has(`install`) && requirements.misc.hasBindingGyp)
-        directives.push({ type: core_1.BuildDirectiveType.SHELLCODE, script: `node-gyp rebuild` });
-    if (directives.length === 0)
-        return null;
-    if (pkg.linkType !== core_1.LinkType.HARD)
-        return { skipped: true, explain: report => report.reportWarningOnce(core_1.MessageName.SOFT_LINK_BUILD, `${core_1.structUtils.prettyLocator(configuration, pkg)} lists build scripts, but is referenced through a soft link. Soft links don't support build scripts, so they'll be ignored.`) };
-    if (dependencyMeta && dependencyMeta.built === false)
-        return { skipped: true, explain: report => report.reportInfoOnce(core_1.MessageName.BUILD_DISABLED, `${core_1.structUtils.prettyLocator(configuration, pkg)} lists build scripts, but its build has been explicitly disabled through configuration.`) };
-    if (!configuration.get(`enableScripts`) && !dependencyMeta.built)
-        return { skipped: true, explain: report => report.reportWarningOnce(core_1.MessageName.DISABLED_BUILD_SCRIPTS, `${core_1.structUtils.prettyLocator(configuration, pkg)} lists build scripts, but all build scripts have been disabled.`) };
-    if (!checkManifestCompatibility(pkg))
-        return { skipped: true, explain: report => report.reportWarningOnce(core_1.MessageName.INCOMPATIBLE_ARCHITECTURE, `${core_1.structUtils.prettyLocator(configuration, pkg)} The ${core_1.nodeUtils.getArchitectureName()} architecture is incompatible with this package, build skipped.`) };
-    return { skipped: false, directives };
-}
-exports.extractBuildRequest = extractBuildRequest;
-const FORCED_EXTRACT_FILETYPES = new Set([
-    // Windows can't execute exe files inside zip archives
-    `.exe`,
-    // May be used for some binaries on Linux; https://askubuntu.com/a/174356
-    `.bin`,
-    // The c/c++ compiler can't read files from zip archives
-    `.h`, `.hh`, `.hpp`, `.c`, `.cc`, `.cpp`,
-    // The java runtime can't read files from zip archives
-    `.java`, `.jar`,
-    // Node opens these through dlopen
-    `.node`,
-]);
-function getExtractHint(fetchResult) {
-    return fetchResult.packageFs.getExtractHint({ relevantExtensions: FORCED_EXTRACT_FILETYPES });
-}
-exports.getExtractHint = getExtractHint;
-function hasBindingGyp(fetchResult) {
-    const bindingFilePath = fslib_1.ppath.join(fetchResult.prefixPath, `binding.gyp`);
-    return fetchResult.packageFs.existsSync(bindingFilePath);
-}
-exports.hasBindingGyp = hasBindingGyp;

package/lib/pnpUtils.d.ts

@@ -1,4 +0,0 @@
-import { Locator, Configuration } from '@yarnpkg/core';
-export declare function getUnpluggedPath(locator: Locator, { configuration }: {
-    configuration: Configuration;
-}): import("@yarnpkg/fslib").PortablePath;

package/lib/pnpUtils.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getUnpluggedPath = void 0;
-const core_1 = require("@yarnpkg/core");
-const fslib_1 = require("@yarnpkg/fslib");
-function getUnpluggedPath(locator, { configuration }) {
-    return fslib_1.ppath.resolve(configuration.get(`pnpUnpluggedFolder`), core_1.structUtils.slugifyLocator(locator));
-}
-exports.getUnpluggedPath = getUnpluggedPath;