@docusaurus/core 2.0.0-beta.8e9b829d9 → 2.0.0-beta.9

package/bin/beforeCli.js

@@ -42,19 +42,41 @@ const notifier = updateNotifier({
 // Hacky way to ensure we check for updates on first run
 // Note: the notification will only happen in the 2nd run
 // See https://github.com/yeoman/update-notifier/issues/209
-if (
-  !notifier.disabled &&
-  Date.now() - notifier.config.get('lastUpdateCheck') < 50
-) {
-  notifier.config.set('lastUpdateCheck', 0);
-  notifier.check();
+try {
+  if (
+    notifier.config &&
+    !notifier.disabled &&
+    Date.now() - notifier.config.get('lastUpdateCheck') < 50
+  ) {
+    notifier.config.set('lastUpdateCheck', 0);
+    notifier.check();
+  }
+} catch (e) {
+  // Do not stop cli if this fails, see https://github.com/facebook/docusaurus/issues/5400
+  console.error(e);
+}
+
+// We don't want to display update message for canary releases
+// See https://github.com/facebook/docusaurus/issues/5378
+function ignoreUpdate(update) {
+  const isCanaryRelease =
+    update && update.current && update.current.startsWith('0.0.0');
+  return isCanaryRelease;
 }
 
-if (notifier.update && notifier.update.current !== notifier.update.latest) {
+if (
+  notifier.config &&
+  notifier.update &&
+  notifier.update.current !== notifier.update.latest
+) {
   // Because notifier clears cached data after reading it, leading to notifier not consistently displaying the update
   // See https://github.com/yeoman/update-notifier/issues/209
   notifier.config.set('update', notifier.update);
 
+  if (ignoreUpdate(notifier.update)) {
+    return;
+  }
+
   // eslint-disable-next-line import/no-dynamic-require, global-require
   const sitePkg = require(path.resolve(process.cwd(), 'package.json'));
   const siteDocusaurusPackagesForUpdate = Object.keys({

package/bin/docusaurus.js

@@ -1,7 +1,4 @@
 #!/usr/bin/env node
-
-// TODO remove when fixed: https://github.com/Stuk/eslint-plugin-header/issues/39
-/* eslint-disable header/header */
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
@@ -10,7 +7,7 @@
  */
 
 const chalk = require('chalk');
-const path = require('path');
+const fs = require('fs');
 const cli = require('commander');
 const {
   build,
@@ -26,6 +23,8 @@ const {
 
 require('./beforeCli');
 
+const resolveDir = (dir = '.') => fs.realpathSync(dir);
+
 cli.version(require('../package.json').version).usage('<command> [options]');
 
 cli
@@ -51,8 +50,8 @@ cli
     '--no-minify',
     'build website without minimizing JS bundles (default: false)',
   )
-  .action((siteDir = '.', {bundleAnalyzer, config, outDir, locale, minify}) => {
-    build(path.resolve(siteDir), {
+  .action((siteDir, {bundleAnalyzer, config, outDir, locale, minify}) => {
+    build(resolveDir(siteDir), {
       bundleAnalyzer,
       outDir,
       config,
@@ -69,14 +68,8 @@ cli
     'copy TypeScript theme files when possible (default: false)',
   )
   .option('--danger', 'enable swizzle for internal component of themes')
-  .action((themeName, componentName, siteDir = '.', {typescript, danger}) => {
-    swizzle(
-      path.resolve(siteDir),
-      themeName,
-      componentName,
-      typescript,
-      danger,
-    );
+  .action((themeName, componentName, siteDir, {typescript, danger}) => {
+    swizzle(resolveDir(siteDir), themeName, componentName, typescript, danger);
   });
 
 cli
@@ -98,8 +91,8 @@ cli
     '--skip-build',
     'skip building website before deploy it (default: false)',
   )
-  .action((siteDir = '.', {outDir, skipBuild, config}) => {
-    deploy(path.resolve(siteDir), {
+  .action((siteDir, {outDir, skipBuild, config}) => {
+    deploy(resolveDir(siteDir), {
       outDir,
       config,
       skipBuild,
@@ -125,19 +118,17 @@ cli
     '--poll [interval]',
     'use polling rather than watching for reload (default: false). Can specify a poll interval in milliseconds',
   )
-  .action(
-    (siteDir = '.', {port, host, locale, config, hotOnly, open, poll}) => {
-      start(path.resolve(siteDir), {
-        port,
-        host,
-        locale,
-        config,
-        hotOnly,
-        open,
-        poll,
-      });
-    },
-  );
+  .action((siteDir, {port, host, locale, config, hotOnly, open, poll}) => {
+    start(resolveDir(siteDir), {
+      port,
+      host,
+      locale,
+      config,
+      hotOnly,
+      open,
+      poll,
+    });
+  });
 
 cli
   .command('serve [siteDir]')
@@ -155,7 +146,7 @@ cli
   .option('-h, --host <host>', 'use specified host (default: localhost)')
   .action(
     (
-      siteDir = '.',
+      siteDir,
       {
         dir = 'build',
         port = 3000,
@@ -164,7 +155,7 @@ cli
         config,
       },
     ) => {
-      serve(path.resolve(siteDir), {
+      serve(resolveDir(siteDir), {
         dir,
         port,
         build: buildSite,
@@ -177,8 +168,8 @@ cli
 cli
   .command('clear [siteDir]')
   .description('Remove build artifacts.')
-  .action((siteDir = '.') => {
-    clear(path.resolve(siteDir));
+  .action((siteDir) => {
+    clear(resolveDir(siteDir));
   });
 
 cli
@@ -202,10 +193,10 @@ cli
   )
   .action(
     (
-      siteDir = '.',
+      siteDir,
       {locale = undefined, override = false, messagePrefix = '', config},
     ) => {
-      writeTranslations(path.resolve(siteDir), {
+      writeTranslations(resolveDir(siteDir), {
         locale,
         override,
         config,
@@ -215,11 +206,16 @@ cli
   );
 
 cli
-  .command('write-heading-ids [contentDir]')
+  .command('write-heading-ids [contentDir] [files]')
   .description('Generate heading ids in Markdown content.')
-  .action((siteDir = '.') => {
-    writeHeadingIds(siteDir);
-  });
+  .option(
+    '--maintain-case',
+    "keep the headings' casing, otherwise make all lowercase (default: false)",
+  )
+  .option('--overwrite', 'overwrite existing heading IDs (default: false)')
+  .action((siteDir, files, options) =>
+    writeHeadingIds(resolveDir(siteDir), files, options),
+  );
 
 cli.arguments('<command>').action((cmd) => {
   cli.outputHelp();
@@ -242,7 +238,7 @@ function isInternalCommand(command) {
 
 async function run() {
   if (!isInternalCommand(process.argv.slice(2)[0])) {
-    await externalCommand(cli, path.resolve('.'));
+    await externalCommand(cli, resolveDir('.'));
   }
 
   cli.parse(process.argv);