feat: add yarn v2+ support (#39)

* feat: add yarn v2+ support
resolves #32

* fix: set mode flag correctly and workaround alias resolver bug

* chore: add test for yarn berry env detection method

* fix: improve yarn berry detection

* chore: add dev and optional flag tests for yarn berry

* chore: add dev and optional tests for bun

* refactor: use runInTempDir instead of modifying withTempEnv

* perf: replace latest-version package with alternative solution

* perf: get latest package versions in parallel

* refactor: rename jsr npm registry constant

* refactor: remove extraneous changes to utils

* fix: add corepack enable yarn to test windows job

* chore: run deno fmt

* fix: only parse json if response is ok

* chore: add test for resolve latest package version with yarn berry

* chore: add yarn npm_config_user_agent test

* chore: add comment for parse text over json

* refactor: call res.body.cancel and use res.json instead

* fix: quote command args when calling spawn with shell

Author: redabacha

.github/workflows/ci.yml

@@ -34,6 +34,7 @@ jobs:
         with:
           version: 8
       - uses: oven-sh/setup-bun@v1
+      - run: corepack enable yarn
 
       - run: npm i
       - run: npm run build --if-present
@@ -56,6 +57,7 @@ jobs:
       - uses: pnpm/action-setup@v3
         with:
           version: 8
+      - run: corepack enable yarn
 
       - run: npm i
       - run: npm run build --if-present

src/commands.ts

@@ -3,13 +3,15 @@ import * as path from "node:path";
 import * as fs from "node:fs";
 import * as kl from "kolorist";
 import { exec, fileExists, JsrPackage } from "./utils";
-import { Bun, getPkgManager, PkgManagerName } from "./pkg_manager";
+import { Bun, getPkgManager, PkgManagerName, YarnBerry } from "./pkg_manager";
 import { downloadDeno, getDenoDownloadUrl } from "./download";
 
 const NPMRC_FILE = ".npmrc";
 const BUNFIG_FILE = "bunfig.toml";
-const JSR_NPMRC = `@jsr:registry=https://npm.jsr.io\n`;
-const JSR_BUNFIG = `[install.scopes]\n"@jsr" = "https://npm.jsr.io/"\n`;
+const JSR_NPM_REGISTRY_URL = "https://npm.jsr.io";
+const JSR_NPMRC = `@jsr:registry=${JSR_NPM_REGISTRY_URL}\n`;
+const JSR_BUNFIG = `[install.scopes]\n"@jsr" = "${JSR_NPM_REGISTRY_URL}"\n`;
+const JSR_YARN_BERRY_CONFIG_KEY = "npmScopes.jsr.npmRegistryServer";
 
 async function wrapWithStatus(msg: string, fn: () => Promise<void>) {
   process.stdout.write(msg + "...");
@@ -81,6 +83,13 @@ export async function install(packages: JsrPackage[], options: InstallOptions) {
   if (pkgManager instanceof Bun) {
     // Bun doesn't support reading from .npmrc yet
     await setupBunfigToml(pkgManager.cwd);
+  } else if (pkgManager instanceof YarnBerry) {
+    // Yarn v2+ does not read from .npmrc intentionally
+    // https://yarnpkg.com/migration/guide#update-your-configuration-to-the-new-settings
+    await pkgManager.setConfigValue(
+      JSR_YARN_BERRY_CONFIG_KEY,
+      JSR_NPM_REGISTRY_URL,
+    );
   } else {
     await setupNpmRc(pkgManager.cwd);
   }

src/pkg_manager.ts

@@ -1,8 +1,10 @@
 // Copyright 2024 the JSR authors. MIT license.
 import { InstallOptions } from "./commands";
-import { exec, findProjectDir, JsrPackage } from "./utils";
+import { exec, findProjectDir, JsrPackage, logDebug } from "./utils";
 import * as kl from "kolorist";
 
+const JSR_URL = "https://jsr.io";
+
 async function execWithLog(cmd: string, args: string[], cwd: string) {
   console.log(kl.dim(`$ ${cmd} ${args.join(" ")}`));
   return exec(cmd, args, cwd);
@@ -16,17 +18,53 @@ function modeToFlag(mode: InstallOptions["mode"]): string {
     : "";
 }
 
+function modeToFlagYarn(mode: InstallOptions["mode"]): string {
+  return mode === "dev" ? "--dev" : mode === "optional" ? "--optional" : "";
+}
+
 function toPackageArgs(pkgs: JsrPackage[]): string[] {
   return pkgs.map(
     (pkg) => `@${pkg.scope}/${pkg.name}@npm:${pkg.toNpmPackage()}`,
   );
 }
 
+async function isYarnBerry(cwd: string) {
+  // this command works for both yarn classic and berry
+  const version = await exec("yarn", ["--version"], cwd, undefined, true);
+  if (!version) {
+    logDebug("Unable to detect yarn version, assuming classic");
+    return false;
+  }
+  if (version.startsWith("1.")) {
+    logDebug("Detected yarn classic from version");
+    return false;
+  }
+  logDebug("Detected yarn berry from version");
+  return true;
+}
+
+async function getLatestPackageVersion(pkg: JsrPackage) {
+  const url = `${JSR_URL}/${pkg}/meta.json`;
+  const res = await fetch(url);
+  if (!res.ok) {
+    // cancel the response body here in order to avoid a potential memory leak in node:
+    // https://github.com/nodejs/undici/tree/c47e9e06d19cf61b2fa1fcbfb6be39a6e3133cab/docs#specification-compliance
+    await res.body?.cancel();
+    throw new Error(`Received ${res.status} from ${url}`);
+  }
+  const { latest } = await res.json();
+  if (!latest) {
+    throw new Error(`Unable to find latest version of ${pkg}`);
+  }
+  return latest;
+}
+
 export interface PackageManager {
   cwd: string;
   install(packages: JsrPackage[], options: InstallOptions): Promise<void>;
   remove(packages: JsrPackage[]): Promise<void>;
   runScript(script: string): Promise<void>;
+  setConfigValue?(key: string, value: string): Promise<void>;
 }
 
 class Npm implements PackageManager {
@@ -61,7 +99,7 @@ class Yarn implements PackageManager {
 
   async install(packages: JsrPackage[], options: InstallOptions) {
     const args = ["add"];
-    const mode = modeToFlag(options.mode);
+    const mode = modeToFlagYarn(options.mode);
     if (mode !== "") {
       args.push(mode);
     }
@@ -82,6 +120,33 @@ class Yarn implements PackageManager {
   }
 }
 
+export class YarnBerry extends Yarn {
+  async install(packages: JsrPackage[], options: InstallOptions) {
+    const args = ["add"];
+    const mode = modeToFlagYarn(options.mode);
+    if (mode !== "") {
+      args.push(mode);
+    }
+    args.push(...(await this.toPackageArgs(packages)));
+    await execWithLog("yarn", args, this.cwd);
+  }
+
+  /**
+   * Calls the `yarn config set` command, https://yarnpkg.com/cli/config/set.
+   */
+  async setConfigValue(key: string, value: string) {
+    await execWithLog("yarn", ["config", "set", key, value], this.cwd);
+  }
+
+  private async toPackageArgs(pkgs: JsrPackage[]) {
+    // nasty workaround for https://github.com/yarnpkg/berry/issues/1816
+    await Promise.all(pkgs.map(async (pkg) => {
+      pkg.version ??= `^${await getLatestPackageVersion(pkg)}`;
+    }));
+    return toPackageArgs(pkgs);
+  }
+}
+
 class Pnpm implements PackageManager {
   constructor(public cwd: string) {}
 
@@ -113,7 +178,7 @@ export class Bun implements PackageManager {
 
   async install(packages: JsrPackage[], options: InstallOptions) {
     const args = ["add"];
-    const mode = modeToFlag(options.mode);
+    const mode = modeToFlagYarn(options.mode);
     if (mode !== "") {
       args.push(mode);
     }
@@ -160,7 +225,9 @@ export async function getPkgManager(
   const result = pkgManagerName || fromEnv || fromLockfile || "npm";
 
   if (result === "yarn") {
-    return new Yarn(projectDir);
+    return await isYarnBerry(projectDir)
+      ? new YarnBerry(projectDir)
+      : new Yarn(projectDir);
   } else if (result === "pnpm") {
     return new Pnpm(projectDir);
   } else if (result === "bun") {

src/utils.ts

@@ -158,12 +158,32 @@ export async function exec(
   args: string[],
   cwd: string,
   env?: Record<string, string | undefined>,
+  captureStdout?: boolean,
 ) {
-  const cp = spawn(cmd, args, { stdio: "inherit", cwd, shell: true, env });
+  const cp = spawn(
+    cmd,
+    args.map((arg) => process.platform === "win32" ? `"${arg}"` : `'${arg}'`),
+    {
+      stdio: captureStdout ? "pipe" : "inherit",
+      cwd,
+      shell: true,
+      env,
+    },
+  );
+
+  return new Promise<string | undefined>((resolve) => {
+    let stdoutChunks: string[] | undefined;
+
+    if (captureStdout) {
+      stdoutChunks = [];
+      cp.stdout?.on("data", (data) => {
+        stdoutChunks!.push(data);
+      });
+    }
 
-  return new Promise<void>((resolve) => {
     cp.on("exit", (code) => {
-      if (code === 0) resolve();
+      const stdout = stdoutChunks?.join("");
+      if (code === 0) resolve(stdout);
       else process.exit(code ?? 1);
     });
   });

test/commands.test.ts

@@ -2,6 +2,7 @@ import * as path from "path";
 import * as fs from "fs";
 import {
   DenoJson,
+  enableYarnBerry,
   isDirectory,
   isFile,
   PkgJson,
@@ -37,6 +38,31 @@ describe("install", () => {
         "Missing npmrc registry",
       );
     });
+
+    await runInTempDir(async (dir) => {
+      await enableYarnBerry(dir);
+      await fs.promises.writeFile(path.join(dir, "yarn.lock"), "");
+
+      await runJsr(["i", "@std/encoding"], dir);
+
+      const pkgJson = await readJson<PkgJson>(path.join(dir, "package.json"));
+      assert.ok(
+        pkgJson.dependencies && "@std/encoding" in pkgJson.dependencies,
+        "Missing dependency entry",
+      );
+
+      assert.match(
+        pkgJson.dependencies["@std/encoding"],
+        /^npm:@jsr\/std__encoding@\^\d+\.\d+\.\d+.*$/,
+      );
+
+      const yarnrcPath = path.join(dir, ".yarnrc.yml");
+      const yarnRc = await fs.promises.readFile(yarnrcPath, "utf-8");
+      assert.ok(
+        /jsr:\s*npmRegistryServer: "https:\/\/npm\.jsr\.io"/.test(yarnRc),
+        "Missing yarnrc.yml registry",
+      );
+    });
   });
 
   it("jsr i @std/[email protected] - with version", async () => {
@@ -86,6 +112,38 @@ describe("install", () => {
         });
       },
     );
+
+    await runInTempDir(async (dir) => {
+      await enableYarnBerry(dir);
+      await fs.promises.writeFile(path.join(dir, "yarn.lock"), "");
+
+      await runJsr(["i", "--save-dev", "@std/[email protected]"], dir);
+
+      assert.ok(
+        await isFile(path.join(dir, ".yarnrc.yml")),
+        "yarnrc file not created",
+      );
+      const pkgJson = await readJson<PkgJson>(path.join(dir, "package.json"));
+      assert.deepEqual(pkgJson.devDependencies, {
+        "@std/encoding": "npm:@jsr/[email protected]",
+      });
+    });
+
+    if (process.platform !== "win32") {
+      await withTempEnv(
+        ["i", "--bun", "--save-dev", "@std/[email protected]"],
+        async (getPkgJson, dir) => {
+          assert.ok(
+            await isFile(path.join(dir, "bun.lockb")),
+            "bun lockfile not created",
+          );
+          const pkgJson = await getPkgJson();
+          assert.deepEqual(pkgJson.devDependencies, {
+            "@std/encoding": "npm:@jsr/[email protected]",
+          });
+        },
+      );
+    }
   });
 
   it("jsr add -O @std/[email protected] - dev dependency", async () => {
@@ -108,6 +166,38 @@ describe("install", () => {
         });
       },
     );
+
+    await runInTempDir(async (dir) => {
+      await enableYarnBerry(dir);
+      await fs.promises.writeFile(path.join(dir, "yarn.lock"), "");
+
+      await runJsr(["i", "--save-optional", "@std/[email protected]"], dir);
+
+      assert.ok(
+        await isFile(path.join(dir, ".yarnrc.yml")),
+        "yarnrc file not created",
+      );
+      const pkgJson = await readJson<PkgJson>(path.join(dir, "package.json"));
+      assert.deepEqual(pkgJson.optionalDependencies, {
+        "@std/encoding": "npm:@jsr/[email protected]",
+      });
+    });
+
+    if (process.platform !== "win32") {
+      await withTempEnv(
+        ["i", "--bun", "--save-optional", "@std/[email protected]"],
+        async (getPkgJson, dir) => {
+          assert.ok(
+            await isFile(path.join(dir, "bun.lockb")),
+            "bun lockfile not created",
+          );
+          const pkgJson = await getPkgJson();
+          assert.deepEqual(pkgJson.optionalDependencies, {
+            "@std/encoding": "npm:@jsr/[email protected]",
+          });
+        },
+      );
+    }
   });
 
   it("jsr add --npm @std/[email protected] - forces npm", async () => {
@@ -132,6 +222,21 @@ describe("install", () => {
         );
       },
     );
+
+    await runInTempDir(async (dir) => {
+      await enableYarnBerry(dir);
+
+      await runJsr(["i", "--yarn", "@std/[email protected]"], dir);
+
+      assert.ok(
+        await isFile(path.join(dir, "yarn.lock")),
+        "yarn lockfile not created",
+      );
+      assert.ok(
+        await isFile(path.join(dir, ".yarnrc.yml")),
+        "yarnrc file not created",
+      );
+    });
   });
 
   it("jsr add --pnpm @std/[email protected] - forces pnpm", async () => {
@@ -186,6 +291,43 @@ describe("install", () => {
       );
     });
 
+    it("detect yarn from npm_config_user_agent", async () => {
+      await withTempEnv(
+        ["i", "@std/[email protected]"],
+        async (_, dir) => {
+          assert.ok(
+            await isFile(path.join(dir, "yarn.lock")),
+            "yarn lockfile not created",
+          );
+        },
+        {
+          env: {
+            ...process.env,
+            npm_config_user_agent:
+              `yarn/1.22.19 ${process.env.npm_config_user_agent}`,
+          },
+        },
+      );
+
+      await runInTempDir(async (dir) => {
+        await enableYarnBerry(dir);
+
+        await runJsr(["i", "@std/[email protected]"], dir, {
+          npm_config_user_agent:
+            `yarn/4.1.0 ${process.env.npm_config_user_agent}`,
+        });
+
+        assert.ok(
+          await isFile(path.join(dir, "yarn.lock")),
+          "yarn lockfile not created",
+        );
+        assert.ok(
+          await isFile(path.join(dir, ".yarnrc.yml")),
+          "yarnrc file not created",
+        );
+      });
+    });
+
     if (process.platform !== "win32") {
       it("detect bun from npm_config_user_agent", async () => {
         await withTempEnv(