@yarnpkg/plugin-pnp 3.1.0-rc.4 → 3.1.1

package/lib/PnpLinker.d.ts

@@ -16,6 +16,7 @@ export declare class PnpInstaller implements Installer {
     protected mode: string;
     private readonly packageRegistry;
     private readonly virtualTemplates;
+    private isESMLoaderRequired;
     constructor(opts: LinkOptions);
     getCustomDataKey(): string;
     private customData;
@@ -32,6 +33,7 @@ export declare class PnpInstaller implements Installer {
                 manifest: {
                     scripts: Map<string, string>;
                     preferUnplugged: boolean | null;
+                    type: string | null;
                 };
                 misc: {
                     extractHint: boolean;
@@ -41,6 +43,7 @@ export declare class PnpInstaller implements Installer {
         };
     } | undefined>;
     transformPnpSettings(pnpSettings: PnpSettings): Promise<void>;
+    private isEsmEnabled;
     finalizeInstallWithPnp(pnpSettings: PnpSettings): Promise<void>;
     private locateNodeModules;
     private readonly unpluggedPaths;

package/lib/PnpLinker.js

@@ -67,6 +67,7 @@ class PnpInstaller {
         this.mode = `strict`;
         this.packageRegistry = new Map();
         this.virtualTemplates = new Map();
+        this.isESMLoaderRequired = false;
         this.customData = {
             store: new Map(),
         };
@@ -76,7 +77,7 @@ class PnpInstaller {
     getCustomDataKey() {
         return JSON.stringify({
             name: `PnpInstaller`,
-            version: 1,
+            version: 2,
         });
     }
     attachCustomData(customData) {
@@ -113,6 +114,8 @@ class PnpInstaller {
                     this.customData.store.set(devirtualizedLocator.locatorHash, customPackageData);
                 }
             }
+            if (customPackageData.manifest.type === `module`)
+                this.isESMLoaderRequired = true;
             dependencyMeta = this.opts.project.getDependencyMeta(devirtualizedLocator, pkg.version);
         }
         const buildScripts = mayNeedToBeBuilt
@@ -179,9 +182,12 @@ class PnpInstaller {
             this.opts.report.reportWarning(core_2.MessageName.UNNAMED, `Removing the old ${core_1.formatUtils.pretty(this.opts.project.configuration, fslib_1.Filename.pnpJs, core_1.formatUtils.Type.PATH)} file. You might need to manually update existing references to reference the new ${core_1.formatUtils.pretty(this.opts.project.configuration, fslib_1.Filename.pnpCjs, core_1.formatUtils.Type.PATH)} file. If you use Editor SDKs, you'll have to rerun ${core_1.formatUtils.pretty(this.opts.project.configuration, `yarn sdks`, core_1.formatUtils.Type.CODE)}.`);
             await fslib_1.xfs.removePromise(pnpPath.cjsLegacy);
         }
+        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(this.opts.project.configuration.get(`pnpDataPath`));
+            await fslib_1.xfs.removePromise(pnpPath.esmLoader);
             return undefined;
         }
         for (const { locator, location } of this.virtualTemplates.values()) {
@@ -224,6 +230,18 @@ class PnpInstaller {
     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 pnpDataPath = this.opts.project.configuration.get(`pnpDataPath`);
@@ -255,6 +273,13 @@ class PnpInstaller {
                 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);
@@ -305,7 +330,7 @@ class PnpInstaller {
             return dependencyMeta.unplugged;
         if (FORCED_UNPLUG_PACKAGES.has(pkg.identHash))
             return true;
-        if (pkg.conditions !== null)
+        if (pkg.conditions != null)
             return true;
         if (customPackageData.manifest.preferUnplugged !== null)
             return customPackageData.manifest.preferUnplugged;
@@ -371,6 +396,7 @@ async function extractCustomPackageData(fetchResult) {
         manifest: {
             scripts: manifest.scripts,
             preferUnplugged: manifest.preferUnplugged,
+            type: manifest.type,
         },
         misc: {
             extractHint: jsInstallUtils.getExtractHint(fetchResult),

package/lib/index.d.ts

@@ -8,6 +8,7 @@ export { pnpUtils };
 export declare const getPnpPath: (project: Project) => {
     cjs: PortablePath;
     cjsLegacy: PortablePath;
+    esmLoader: PortablePath;
 };
 export declare const quotePathIfNeeded: (path: string) => string;
 declare module '@yarnpkg/core' {
@@ -16,6 +17,7 @@ declare module '@yarnpkg/core' {
         pnpMode: string;
         pnpShebang: string;
         pnpIgnorePatterns: Array<string>;
+        pnpEnableEsmLoader: boolean;
         pnpEnableInlining: boolean;
         pnpFallbackMode: string;
         pnpUnpluggedFolder: PortablePath;

package/lib/index.js

@@ -5,6 +5,7 @@ const tslib_1 = require("tslib");
 const core_1 = require("@yarnpkg/core");
 const fslib_1 = require("@yarnpkg/fslib");
 const semver_1 = (0, tslib_1.__importDefault)(require("semver"));
+const url_1 = require("url");
 const PnpLinker_1 = require("./PnpLinker");
 const unplug_1 = (0, tslib_1.__importDefault)(require("./commands/unplug"));
 const jsInstallUtils = (0, tslib_1.__importStar)(require("./jsInstallUtils"));
@@ -15,6 +16,7 @@ const getPnpPath = (project) => {
     return {
         cjs: fslib_1.ppath.join(project.cwd, fslib_1.Filename.pnpCjs),
         cjsLegacy: fslib_1.ppath.join(project.cwd, fslib_1.Filename.pnpJs),
+        esmLoader: fslib_1.ppath.join(project.cwd, `.pnp.loader.mjs`),
     };
 };
 exports.getPnpPath = getPnpPath;
@@ -23,22 +25,27 @@ const quotePathIfNeeded = (path) => {
 };
 exports.quotePathIfNeeded = quotePathIfNeeded;
 async function setupScriptEnvironment(project, env, makePathWrapper) {
-    const pnpPath = (0, exports.getPnpPath)(project).cjs;
-    const pnpRequire = `--require ${(0, exports.quotePathIfNeeded)(fslib_1.npath.fromPortablePath(pnpPath))}`;
-    if (pnpPath.includes(` `) && semver_1.default.lt(process.versions.node, `12.0.0`))
+    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 (pnpPath.cjs.includes(` `) && semver_1.default.lt(process.versions.node, `12.0.0`))
         throw new Error(`Expected the build location to not include spaces when using Node < 12.0.0 (${process.versions.node})`);
-    if (fslib_1.xfs.existsSync(pnpPath)) {
+    if (fslib_1.xfs.existsSync(pnpPath.cjs)) {
         let nodeOptions = env.NODE_OPTIONS || ``;
         // 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.
         const pnpRegularExpression = /\s*--require\s+\S*\.pnp\.c?js\s*/g;
-        nodeOptions = nodeOptions.replace(pnpRegularExpression, ` `).trim();
+        const esmLoaderExpression = /\s*--experimental-loader\s+\S*\.pnp\.loader\.mjs\s*/;
+        nodeOptions = nodeOptions.replace(pnpRegularExpression, ` `).replace(esmLoaderExpression, ` `).trim();
         nodeOptions = nodeOptions ? `${pnpRequire} ${nodeOptions}` : pnpRequire;
         env.NODE_OPTIONS = nodeOptions;
     }
 }
 async function populateYarnPaths(project, definePath) {
-    definePath((0, exports.getPnpPath)(project).cjs);
+    const pnpPath = (0, exports.getPnpPath)(project);
+    definePath(pnpPath.cjs);
+    definePath(pnpPath.esmLoader);
     definePath(project.configuration.get(`pnpDataPath`));
     definePath(project.configuration.get(`pnpUnpluggedFolder`));
 }
@@ -69,6 +76,11 @@ const plugin = {
             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,

package/package.json

@@ -1,26 +1,26 @@
 {
   "name": "@yarnpkg/plugin-pnp",
-  "version": "3.1.0-rc.4",
+  "version": "3.1.1",
   "license": "BSD-2-Clause",
   "main": "./lib/index.js",
   "dependencies": {
     "@types/semver": "^7.1.0",
-    "@yarnpkg/fslib": "^2.6.0-rc.11",
-    "@yarnpkg/plugin-stage": "^3.1.0-rc.1",
-    "@yarnpkg/pnp": "^3.1.0-rc.8",
+    "@yarnpkg/fslib": "^2.6.0",
+    "@yarnpkg/plugin-stage": "^3.1.1",
+    "@yarnpkg/pnp": "^3.1.0",
     "clipanion": "^3.0.1",
     "micromatch": "^4.0.2",
     "semver": "^7.1.2",
     "tslib": "^1.13.0"
   },
   "peerDependencies": {
-    "@yarnpkg/cli": "^3.1.0-rc.11",
-    "@yarnpkg/core": "^3.1.0-rc.12"
+    "@yarnpkg/cli": "^3.1.0",
+    "@yarnpkg/core": "^3.1.0"
   },
   "devDependencies": {
     "@types/micromatch": "^4.0.1",
-    "@yarnpkg/cli": "^3.1.0-rc.11",
-    "@yarnpkg/core": "^3.1.0-rc.12"
+    "@yarnpkg/cli": "^3.1.0",
+    "@yarnpkg/core": "^3.1.0"
   },
   "repository": {
     "type": "git",
@@ -41,6 +41,5 @@
   "engines": {
     "node": ">=12 <14 || 14.2 - 14.9 || >14.10.0"
   },
-  "stableVersion": "3.0.0",
   "typings": "./lib/index.d.ts"
 }