Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
slorber merged 6 commits into from
May 31, 2023
Merged

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

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2a0e83e
fix(core): Correct yarn version detection
wannysim May 24, 2023
1914bed
Merge branch 'facebook:main' into correct-yarn-version-detection
wannysim May 31, 2023
cd951d9
Change to use `shelljs` instead of `js-yaml`
wannysim May 31, 2023
027584f
Change echo mode to silent
wannysim May 31, 2023
c14a611
Check `yarn.lock` exist, before version checking
wannysim May 31, 2023
c4db321
Remove unnecessary optional chaining
wannysim May 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 25 additions & 9 deletions packages/docusaurus/bin/beforeCli.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down Expand Up @@ -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} */
Expand Down