fix(core): docusaurus CLI should detect the correct yarn version when suggesting upgrades (facebook#9006)

0420syj · Josh-Cena · web-flow · commit b4087720cbdd · 2023-05-31T11:54:44.000+02:00
* fix(core): Correct yarn version detection

Correct yarn version detection by checking `yarnPath` value inside `.yarnrc.yml` file
Add js-yaml in package.json

* Change to use `shelljs` instead of `js-yaml`

* Change echo mode to silent

* Check `yarn.lock` exist, before version checking

* Remove unnecessary &#65533;optional chaining

&#65533;Nullish coalescing operator still provides the fallback value

Co-authored-by: Joshua Chen &lt;sidachen2003@gmail.com&gt;

---------

Co-authored-by: Joshua Chen &lt;sidachen2003@gmail.com&gt;
diff --git a/packages/docusaurus/bin/beforeCli.mjs b/packages/docusaurus/bin/beforeCli.mjs
@@ -10,6 +10,7 @@
 import fs from 'fs-extra';
 import path from 'path';
 import {createRequire} from 'module';
+import shell from 'shelljs';
 import logger from '@docusaurus/logger';
 import semver from 'semver';
 import updateNotifier from 'update-notifier';
@@ -105,18 +106,33 @@ export default async function beforeCli() {
       .map((p) => p.concat('@latest'))
       .join(' ');
 
+    const getYarnVersion = async () => {
+      if (!(await fs.pathExists(path.resolve('yarn.lock')))) {
+        return undefined;
+      }
+
+      const yarnVersionResult = shell.exec('yarn --version', {silent: true});
+      if (yarnVersionResult?.code === 0) {
+        const majorVersion = parseInt(
+          yarnVersionResult.stdout?.trim().split('.')[0] ?? '',
+          10,
+        );
+        if (!Number.isNaN(majorVersion)) {
+          return majorVersion;
+        }
+      }
+
+      return undefined;
+    };
+
     const getUpgradeCommand = async () => {
-      const isYarnUsed = await fs.pathExists(path.resolve('yarn.lock'));
-      if (!isYarnUsed) {
+      const yarnVersion = await getYarnVersion();
+      if (!yarnVersion) {
         return `npm i ${siteDocusaurusPackagesForUpdate}`;
       }
-
-      const isYarnClassicUsed = !(await fs.pathExists(
-        path.resolve('.yarnrc.yml'),
-      ));
-      return isYarnClassicUsed
-        ? `yarn upgrade ${siteDocusaurusPackagesForUpdate}`
-        : `yarn up ${siteDocusaurusPackagesForUpdate}`;
+      return yarnVersion >= 2
+        ? `yarn up ${siteDocusaurusPackagesForUpdate}`
+        : `yarn upgrade ${siteDocusaurusPackagesForUpdate}`;
     };
 
     /** @type {import('boxen').Options} */
