@docusaurus/core 0.0.0-4511 → 0.0.0-4518

package/bin/beforeCli.js

@@ -20,105 +20,114 @@ const {
   engines: {node: requiredVersion},
 } = require('../package.json');
 
-// Notify user if @docusaurus packages is outdated
-//
-// Note: this is a 2-step process to avoid delaying cli usage by awaiting a response:
-// - 1st run: trigger background job to check releases + store result
-// - 2nd run: display potential update to users
-//
-// Note: even if the
-//
-// cache data is stored in ~/.config/configstore/update-notifier-@docusaurus
-//
-const notifier = updateNotifier({
-  pkg: {
-    name,
-    version,
-  },
-  // Check is in background so it's fine to use a small value like 1h
-  // Use 0 for debugging
-  updateCheckInterval: 1000 * 60 * 60,
-  // updateCheckInterval: 0
-});
-
-// 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
-try {
+// eslint-disable-next-line import/no-dynamic-require
+const sitePkg = require(path.resolve(process.cwd(), 'package.json'));
+
+/**
+ * Notify user if `@docusaurus` packages are outdated
+ *
+ * Note: this is a 2-step process to avoid delaying cli usage by awaiting a
+ * response:
+ * - 1st run: trigger background job to check releases + store result
+ * - 2nd run: display potential update to users
+ *
+ * cache data is stored in `~/.config/configstore/update-notifier-@docusaurus`
+ */
+function beforeCli() {
+  const notifier = updateNotifier({
+    pkg: {
+      name,
+      version,
+    },
+    // Check is in background so it's fine to use a small value like 1h
+    // Use 0 for debugging
+    updateCheckInterval: 1000 * 60 * 60,
+    // updateCheckInterval: 0
+  });
+
+  // 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
+  try {
+    if (
+      notifier.config &&
+      // @ts-expect-error: this is an internal API
+      !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
+    logger.error(e);
+  }
+
+  /**
+   * We don't want to display update message for canary releases.
+   * See https://github.com/facebook/docusaurus/issues/5378
+   * @param {import('update-notifier').UpdateInfo} update
+   */
+  function ignoreUpdate(update) {
+    const isCanaryRelease =
+      update && update.current && update.current.startsWith('0.0.0');
+    return isCanaryRelease;
+  }
+
   if (
     notifier.config &&
-    !notifier.disabled &&
-    Date.now() - notifier.config.get('lastUpdateCheck') < 50
+    notifier.update &&
+    semver.lt(notifier.update.current, notifier.update.latest)
   ) {
-    notifier.config.set('lastUpdateCheck', 0);
-    notifier.check();
-  }
-} catch (e) {
-  // Do not stop cli if this fails, see https://github.com/facebook/docusaurus/issues/5400
-  logger.error(e);
-}
+    // 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);
 
-// 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 (ignoreUpdate(notifier.update)) {
+      return;
+    }
 
-if (
-  notifier.config &&
-  notifier.update &&
-  semver.lt(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);
+    const siteDocusaurusPackagesForUpdate = Object.keys({
+      ...sitePkg.dependencies,
+      ...sitePkg.devDependencies,
+    })
+      .filter((p) => p.startsWith('@docusaurus'))
+      .map((p) => p.concat('@latest'))
+      .join(' ');
+    const isYarnUsed = fs.existsSync(path.resolve(process.cwd(), 'yarn.lock'));
+    const upgradeCommand = isYarnUsed
+      ? `yarn upgrade ${siteDocusaurusPackagesForUpdate}`
+      : `npm i ${siteDocusaurusPackagesForUpdate}`;
 
-  if (ignoreUpdate(notifier.update)) {
-    // @ts-expect-error: it works
-    return;
+    /** @type {import('boxen').Options} */
+    const boxenOptions = {
+      padding: 1,
+      margin: 1,
+      align: 'center',
+      borderColor: 'yellow',
+      borderStyle: 'round',
+    };
+
+    const docusaurusUpdateMessage = boxen(
+      `Update available ${logger.dim(
+        `${notifier.update.current}`,
+      )} → ${logger.green(`${notifier.update.latest}`)}
+
+  To upgrade Docusaurus packages with the latest version, run the following command:
+  ${logger.code(upgradeCommand)}`,
+      boxenOptions,
+    );
+
+    console.log(docusaurusUpdateMessage);
   }
 
-  // eslint-disable-next-line import/no-dynamic-require, global-require
-  const sitePkg = require(path.resolve(process.cwd(), 'package.json'));
-  const siteDocusaurusPackagesForUpdate = Object.keys({
-    ...sitePkg.dependencies,
-    ...sitePkg.devDependencies,
-  })
-    .filter((p) => p.startsWith('@docusaurus'))
-    .map((p) => p.concat('@latest'))
-    .join(' ');
-  const isYarnUsed = fs.existsSync(path.resolve(process.cwd(), 'yarn.lock'));
-  const upgradeCommand = isYarnUsed
-    ? `yarn upgrade ${siteDocusaurusPackagesForUpdate}`
-    : `npm i ${siteDocusaurusPackagesForUpdate}`;
-
-  /** @type {import('boxen').Options} */
-  const boxenOptions = {
-    padding: 1,
-    margin: 1,
-    align: 'center',
-    borderColor: 'yellow',
-    borderStyle: 'round',
-  };
-
-  const docusaurusUpdateMessage = boxen(
-    `Update available ${logger.dim(
-      `${notifier.update.current}`,
-    )} → ${logger.green(`${notifier.update.latest}`)}
-
-To upgrade Docusaurus packages with the latest version, run the following command:
-${logger.code(upgradeCommand)}`,
-    boxenOptions,
-  );
-
-  console.log(docusaurusUpdateMessage);
+  // notify user if node version needs to be updated
+  if (!semver.satisfies(process.version, requiredVersion)) {
+    logger.error('Minimum Node.js version not met :(');
+    logger.info`You are using Node.js number=${process.version}, Requirement: Node.js number=${requiredVersion}.`;
+    process.exit(1);
+  }
 }
 
-// notify user if node version needs to be updated
-if (!semver.satisfies(process.version, requiredVersion)) {
-  logger.error('Minimum Node.js version not met :(');
-  logger.info`You are using Node.js number=${process.version}, Requirement: Node.js number=${requiredVersion}.`;
-  process.exit(1);
-}
+module.exports = beforeCli;

package/bin/docusaurus.js

@@ -23,7 +23,9 @@ const {
   writeHeadingIds,
 } = require('../lib');
 
-require('./beforeCli');
+const beforeCli = require('./beforeCli');
+
+beforeCli();
 
 const resolveDir = (dir = '.') => fs.realpathSync(dir);
 
@@ -208,7 +210,7 @@ cli
   );
 
 cli
-  .command('write-heading-ids [contentDir] [files]')
+  .command('write-heading-ids [siteDir] [files...]')
   .description('Generate heading ids in Markdown content.')
   .option(
     '--maintain-case',
@@ -239,7 +241,6 @@ function isInternalCommand(command) {
 
 async function run() {
   if (!isInternalCommand(process.argv.slice(2)[0])) {
-    // @ts-expect-error: Hmmm
     await externalCommand(cli, resolveDir('.'));
   }
 

package/lib/client/exports/ComponentCreator.js

@@ -38,11 +38,10 @@ function ComponentCreator(path, hash) {
     Object.keys(flatChunkNames).forEach((key) => {
         const chunkRegistry = registry[flatChunkNames[key]];
         if (chunkRegistry) {
-            /* eslint-disable prefer-destructuring */
+            // eslint-disable-next-line prefer-destructuring
             optsLoader[key] = chunkRegistry[0];
             optsModules.push(chunkRegistry[1]);
             optsWebpack.push(chunkRegistry[2]);
-            /* eslint-enable prefer-destructuring */
         }
     });
     return Loadable.Map({

package/lib/commands/external.d.ts

@@ -4,5 +4,5 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { Command } from 'commander';
-export default function externalCommand(cli: Command, siteDir: string): Promise<void>;
+import type { CommanderStatic } from 'commander';
+export default function externalCommand(cli: CommanderStatic, siteDir: string): Promise<void>;

package/lib/commands/writeHeadingIds.d.ts

@@ -11,5 +11,5 @@ declare type Options = {
 };
 export declare function transformMarkdownHeadingLine(line: string, slugger: Slugger, options?: Options): string;
 export declare function transformMarkdownContent(content: string, options?: Options): string;
-export default function writeHeadingIds(siteDir: string, files?: string, options?: Options): Promise<void>;
+export default function writeHeadingIds(siteDir: string, files?: string[], options?: Options): Promise<void>;
 export {};

package/lib/commands/writeHeadingIds.js

@@ -94,7 +94,7 @@ async function getPathsToWatch(siteDir) {
     return plugins.flatMap((plugin) => { var _a, _b; return (_b = (_a = plugin === null || plugin === void 0 ? void 0 : plugin.getPathsToWatch) === null || _a === void 0 ? void 0 : _a.call(plugin)) !== null && _b !== void 0 ? _b : []; });
 }
 async function writeHeadingIds(siteDir, files, options) {
-    const markdownFiles = await (0, utils_2.safeGlobby)(files ? [files] : await getPathsToWatch(siteDir), {
+    const markdownFiles = await (0, utils_2.safeGlobby)(files !== null && files !== void 0 ? files : (await getPathsToWatch(siteDir)), {
         expandDirectories: ['**/*.{md,mdx}'],
     });
     const result = await Promise.all(markdownFiles.map((p) => transformMarkdownFile(p, options)));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "0.0.0-4511",
+  "version": "0.0.0-4518",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -41,13 +41,13 @@
     "@babel/runtime": "^7.16.3",
     "@babel/runtime-corejs3": "^7.16.3",
     "@babel/traverse": "^7.16.3",
-    "@docusaurus/cssnano-preset": "0.0.0-4511",
-    "@docusaurus/logger": "0.0.0-4511",
-    "@docusaurus/mdx-loader": "0.0.0-4511",
+    "@docusaurus/cssnano-preset": "0.0.0-4518",
+    "@docusaurus/logger": "0.0.0-4518",
+    "@docusaurus/mdx-loader": "0.0.0-4518",
     "@docusaurus/react-loadable": "5.5.2",
-    "@docusaurus/utils": "0.0.0-4511",
-    "@docusaurus/utils-common": "0.0.0-4511",
-    "@docusaurus/utils-validation": "0.0.0-4511",
+    "@docusaurus/utils": "0.0.0-4518",
+    "@docusaurus/utils-common": "0.0.0-4518",
+    "@docusaurus/utils-validation": "0.0.0-4518",
     "@slorber/static-site-generator-webpack-plugin": "^4.0.0",
     "@svgr/webpack": "^6.0.0",
     "autoprefixer": "^10.3.5",
@@ -105,8 +105,8 @@
     "webpackbar": "^5.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4511",
-    "@docusaurus/types": "0.0.0-4511",
+    "@docusaurus/module-type-aliases": "0.0.0-4518",
+    "@docusaurus/types": "0.0.0-4518",
     "@types/copy-webpack-plugin": "^8.0.1",
     "@types/detect-port": "^1.3.0",
     "@types/mini-css-extract-plugin": "^1.4.3",
@@ -116,6 +116,7 @@
     "@types/react-router-config": "^5.0.1",
     "@types/rtl-detect": "^1.0.0",
     "@types/serve-handler": "^6.1.1",
+    "@types/update-notifier": "^5.1.0",
     "@types/wait-on": "^5.2.0",
     "@types/webpack-bundle-analyzer": "^4.4.1",
     "react-test-renderer": "^17.0.2",
@@ -128,5 +129,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "9188df1b5a9380116d19b5dc907f754500686284"
+  "gitHead": "734bca0f3ea8d04fa3b908d56ea0fb159ab47ab3"
 }