feat: docusaurus upgrade cli command

Author: Sergio

packages/docusaurus/bin/docusaurus.js

@@ -19,6 +19,7 @@ const {
   externalCommand,
   serve,
   clear,
+  upgrade,
   writeTranslations,
 } = require('../lib');
 const requiredVersion = require('../package.json').engines.node;
@@ -206,6 +207,17 @@ cli
     wrapCommand(clear)(path.resolve(siteDir));
   });
 
+cli
+  .command('upgrade')
+  .description('Upgrades @docusaurus packages')
+  .option(
+    '-t, --tag <tag>',
+    'Tag of npm to look for upgrading. This option accepts any of: <alpha, beta, next, latest>',
+  )
+  .action(({tag = undefined}) => {
+    wrapCommand(upgrade)({tag});
+  });
+
 cli
   .command('write-translations [siteDir]')
   .description('Extract required translations of your site')
@@ -245,6 +257,7 @@ function isInternalCommand(command) {
     'start',
     'build',
     'swizzle',
+    'upgrade',
     'deploy',
     'serve',
     'clear',

packages/docusaurus/src/commands/upgrade.ts

@@ -0,0 +1,60 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import chalk = require('chalk');
+import fs from 'fs-extra';
+import path from 'path';
+import os from 'os';
+import childProcess from 'child_process';
+import clear from './clear';
+
+function hasYarn() {
+  return fs.existsSync(path.resolve(path.dirname(process.cwd()), 'yarn.lock'));
+}
+
+type CommonNpmTags = 'alpha' | 'beta' | 'latest' | 'next';
+export default function upgrade(opts: {tag: CommonNpmTags}): void {
+  const [npmClient, npmCommand] = hasYarn()
+    ? ['yarn', 'upgrade']
+    : ['npm', 'install'];
+
+  const {dependencies = {}, devDependencies = {}} = JSON.parse(
+    fs.readFileSync(path.join(process.cwd(), './package.json'), 'utf8'),
+  );
+
+  let packageNames = Array.from(
+    new Set(
+      [
+        ...Object.keys(dependencies),
+        ...Object.keys(devDependencies),
+      ].filter((pkg) => pkg.startsWith('@docusaurus')),
+    ),
+  ).sort();
+
+  if (!packageNames.length) {
+    console.log(chalk.red(`Found 0 packages with scope @docusaurus`));
+    return;
+  }
+
+  if (opts.tag) {
+    packageNames = packageNames.map((_) => `${_}@${opts.tag}`);
+  }
+
+  console.log(chalk.green(`Found ${packageNames.length} to update:`));
+  console.log(packageNames);
+  console.log(
+    chalk.cyan(
+      `Executing "${npmClient} ${npmCommand} ${packageNames.join(' ')}"`,
+    ),
+  );
+
+  childProcess.spawnSync(npmClient, [npmCommand, ...packageNames], {
+    stdio: 'inherit',
+    shell: os.platform() === 'win32',
+  });
+
+  clear(path.resolve('.'));
+}

packages/docusaurus/src/index.ts

@@ -13,3 +13,4 @@ export {default as externalCommand} from './commands/external';
 export {default as serve} from './commands/serve';
 export {default as clear} from './commands/clear';
 export {default as writeTranslations} from './commands/writeTranslations';
+export {default as upgrade} from './commands/upgrade';

website/package.json

@@ -10,6 +10,7 @@
     "deploy": "docusaurus deploy",
     "clear": "docusaurus clear",
     "serve": "docusaurus serve",
+    "upgrade": "docusaurus upgrade",
     "start:baseUrl": "cross-env BASE_URL='/build/' yarn start",
     "build:baseUrl": "cross-env BASE_URL='/build/' yarn build",
     "start:bootstrap": "cross-env DOCUSAURUS_PRESET=bootstrap yarn start",
@@ -60,4 +61,4 @@
     "cross-env": "^7.0.2",
     "raw-loader": "^4.0.1"
   }
-}
+}