@docusaurus/core 2.1.0 → 2.3.0

package/bin/docusaurus.mjs

@@ -77,6 +77,10 @@ cli
     'copy TypeScript theme files when possible (default: false)',
   )
   .option('--danger', 'enable swizzle for unsafe component of themes')
+  .option(
+    '--config <config>',
+    'path to Docusaurus config file (default: `[siteDir]/docusaurus.config.js`)',
+  )
   .action(swizzle);
 
 cli
@@ -100,6 +104,23 @@ cli
   )
   .action(deploy);
 
+/**
+ * @param {string | undefined} value
+ * @returns {boolean | number}
+ */
+function normalizePollValue(value) {
+  if (value === undefined || value === '') {
+    return false;
+  }
+
+  const parsedIntValue = Number.parseInt(value, 10);
+  if (!Number.isNaN(parsedIntValue)) {
+    return parsedIntValue;
+  }
+
+  return value === 'true';
+}
+
 cli
   .command('start [siteDir]')
   .description('Start the development server.')
@@ -118,6 +139,7 @@ cli
   .option(
     '--poll [interval]',
     'use polling rather than watching for reload (default: false). Can specify a poll interval in milliseconds',
+    normalizePollValue,
   )
   .option(
     '--no-minify',

package/lib/client/ClientLifecyclesDispatcher.js

@@ -14,7 +14,17 @@ export function dispatchLifecycleAction(lifecycleAction, ...args) {
     });
     return () => callbacks.forEach((cb) => cb?.());
 }
-function scrollAfterNavigation(location) {
+function scrollAfterNavigation({ location, previousLocation, }) {
+    if (!previousLocation) {
+        return; // no-op: use native browser feature
+    }
+    const samePathname = location.pathname === previousLocation.pathname;
+    const sameHash = location.hash === previousLocation.hash;
+    const sameSearch = location.search === previousLocation.search;
+    // Query-string changes: do not scroll to top/hash
+    if (samePathname && sameHash && !sameSearch) {
+        return;
+    }
     const { hash } = location;
     if (!hash) {
         window.scrollTo(0, 0);
@@ -28,9 +38,7 @@ function scrollAfterNavigation(location) {
 function ClientLifecyclesDispatcher({ children, location, previousLocation, }) {
     useLayoutEffect(() => {
         if (previousLocation !== location) {
-            if (previousLocation) {
-                scrollAfterNavigation(location);
-            }
+            scrollAfterNavigation({ location, previousLocation });
             dispatchLifecycleAction('onRouteDidUpdate', { previousLocation, location });
         }
     }, [previousLocation, location]);

package/lib/client/exports/Link.js

@@ -77,7 +77,7 @@ function Link({ isNavLink, to, href, activeClassName, isActive, 'data-noBrokenLi
             ioRef.current.observe(el);
         }
     };
-    const onMouseEnter = () => {
+    const onInteractionEnter = () => {
         if (!preloaded.current && targetLink != null) {
             window.docusaurus.preload(targetLink);
             preloaded.current = true;
@@ -105,7 +105,7 @@ function Link({ isNavLink, to, href, activeClassName, isActive, 'data-noBrokenLi
     return isRegularHtmlLink ? (
     // eslint-disable-next-line jsx-a11y/anchor-has-content
     <a ref={innerRef} href={targetLink} {...(targetLinkUnprefixed &&
-        !isInternal && { target: '_blank', rel: 'noopener noreferrer' })} {...props}/>) : (<LinkComponent {...props} onMouseEnter={onMouseEnter} innerRef={handleRef} to={targetLink} 
+        !isInternal && { target: '_blank', rel: 'noopener noreferrer' })} {...props}/>) : (<LinkComponent {...props} onMouseEnter={onInteractionEnter} onTouchStart={onInteractionEnter} innerRef={handleRef} to={targetLink} 
     // Avoid "React does not recognize the `activeClassName` prop on a DOM
     // element"
     {...(isNavLink && { isActive, activeClassName })}/>);

package/lib/client/exports/useBaseUrl.js

@@ -4,6 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+import { useCallback } from 'react';
 import useDocusaurusContext from './useDocusaurusContext';
 import { hasProtocol } from './isInternalUrl';
 function addBaseUrl(siteUrl, baseUrl, url, { forcePrependBaseUrl = false, absolute = false } = {}) {
@@ -27,8 +28,9 @@ function addBaseUrl(siteUrl, baseUrl, url, { forcePrependBaseUrl = false, absolu
 }
 export function useBaseUrlUtils() {
     const { siteConfig: { baseUrl, url: siteUrl }, } = useDocusaurusContext();
+    const withBaseUrl = useCallback((url, options) => addBaseUrl(siteUrl, baseUrl, url, options), [siteUrl, baseUrl]);
     return {
-        withBaseUrl: (url, options) => addBaseUrl(siteUrl, baseUrl, url, options),
+        withBaseUrl,
     };
 }
 export default function useBaseUrl(url, options = {}) {

package/lib/commands/build.js

@@ -131,7 +131,11 @@ async function buildLocale({ siteDir, locale, cliOptions, forceTerminate, isLast
         serverConfig = (0, webpack_merge_1.default)(serverConfig, {
             plugins: [
                 new copy_webpack_plugin_1.default({
-                    patterns: staticDirectories.map((dir) => ({ from: dir, to: outDir })),
+                    patterns: staticDirectories.map((dir) => ({
+                        from: dir,
+                        to: outDir,
+                        toType: 'dir',
+                    })),
                 }),
             ],
         });

package/lib/commands/deploy.js

@@ -53,7 +53,7 @@ This behavior can have SEO impacts and create relative link issues.
     }
     // Source repo is the repo from where the command is invoked
     const sourceRepoUrl = shelljs_1.default
-        .exec('git config --get remote.origin.url', { silent: true })
+        .exec('git remote get-url origin', { silent: true })
         .stdout.trim();
     // The source branch; defaults to the currently checked out branch
     const sourceBranch = process.env.CURRENT_BRANCH ??

package/lib/commands/swizzle/actions.js

@@ -33,7 +33,7 @@ async function eject({ siteDir, themePath, componentName, typescript, }) {
     const isDirectory = await isDir(fromPath);
     const globPattern = isDirectory
         ? // Do we really want to copy all components?
-            path_1.default.join(fromPath, '*')
+            path_1.default.join(fromPath, '**/*')
         : `${fromPath}.*`;
     const globPatternPosix = (0, utils_1.posixPath)(globPattern);
     const filesToCopy = await (0, utils_1.Globby)(globPatternPosix, {
@@ -42,6 +42,7 @@ async function eject({ siteDir, themePath, componentName, typescript, }) {
             // When ejecting JS components, we want to avoid emitting TS files
             // In particular the .d.ts files that theme build output contains
             typescript ? null : '**/*.{d.ts,ts,tsx}',
+            '**/{__fixtures__,__tests__}/*',
         ]),
     });
     if (filesToCopy.length === 0) {

package/lib/commands/swizzle/common.d.ts

@@ -27,6 +27,7 @@ export declare type SwizzleCLIOptions = {
     list: boolean;
     wrap: boolean;
     eject: boolean;
+    config?: string;
 };
 export declare function normalizeOptions(options: Partial<SwizzleCLIOptions>): SwizzleCLIOptions;
 export declare function findStringIgnoringCase(str: string, values: string[]): string | undefined;

package/lib/commands/swizzle/common.js

@@ -43,6 +43,7 @@ function normalizeOptions(options) {
         list: options.list ?? false,
         wrap: options.wrap ?? false,
         eject: options.eject ?? false,
+        config: options.config ?? undefined,
     };
 }
 exports.normalizeOptions = normalizeOptions;

package/lib/commands/swizzle/components.d.ts

@@ -15,6 +15,15 @@ export declare type ThemeComponents = {
     hasAnySafeAction: (component: string) => boolean;
     hasAllSafeAction: (component: string) => boolean;
 };
+/**
+ * Expand a list of components to include and return parent folders.
+ * If a folder is not directly a component (no Folder/index.tsx file),
+ * we still want to be able to swizzle --eject that folder.
+ * See https://github.com/facebook/docusaurus/pull/7175#issuecomment-1103757218
+ *
+ * @param componentNames the original list of component names
+ */
+export declare function getMissingIntermediateComponentFolderNames(componentNames: string[]): string[];
 export declare function readComponentNames(themePath: string): Promise<string[]>;
 export declare function listComponentNames(themeComponents: ThemeComponents): string;
 export declare function getThemeComponents({ themeName, themePath, swizzleConfig, }: {

package/lib/commands/swizzle/components.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getComponentName = exports.getThemeComponents = exports.listComponentNames = exports.readComponentNames = void 0;
+exports.getComponentName = exports.getThemeComponents = exports.listComponentNames = exports.readComponentNames = exports.getMissingIntermediateComponentFolderNames = void 0;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
@@ -37,6 +37,7 @@ function getMissingIntermediateComponentFolderNames(componentNames) {
     const expandedComponentNames = lodash_1.default.uniq(componentNames.flatMap((componentName) => getAllIntermediatePaths(componentName)));
     return lodash_1.default.difference(expandedComponentNames, componentNames);
 }
+exports.getMissingIntermediateComponentFolderNames = getMissingIntermediateComponentFolderNames;
 const skipReadDirNames = ['__test__', '__tests__', '__mocks__', '__fixtures__'];
 async function readComponentNames(themePath) {
     if (!(await fs_extra_1.default.pathExists(themePath))) {

package/lib/commands/swizzle/context.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 { SwizzleContext } from './common';
-export declare function initSwizzleContext(siteDir: string): Promise<SwizzleContext>;
+import type { SwizzleCLIOptions, SwizzleContext } from './common';
+export declare function initSwizzleContext(siteDir: string, options: SwizzleCLIOptions): Promise<SwizzleContext>;

package/lib/commands/swizzle/context.js

@@ -10,8 +10,8 @@ exports.initSwizzleContext = void 0;
 const server_1 = require("../../server");
 const init_1 = require("../../server/plugins/init");
 const configs_1 = require("../../server/plugins/configs");
-async function initSwizzleContext(siteDir) {
-    const context = await (0, server_1.loadContext)({ siteDir });
+async function initSwizzleContext(siteDir, options) {
+    const context = await (0, server_1.loadContext)({ siteDir, config: options.config });
     const plugins = await (0, init_1.initPlugins)(context);
     const pluginConfigs = await (0, configs_1.loadPluginConfigs)(context);
     return {

package/lib/commands/swizzle/index.js

@@ -62,7 +62,7 @@ async function swizzle(themeNameParam = undefined, componentNameParam = undefine
     const siteDir = await fs_extra_1.default.realpath(siteDirParam);
     const options = (0, common_1.normalizeOptions)(optionsParam);
     const { list, danger, typescript } = options;
-    const { plugins } = await (0, context_1.initSwizzleContext)(siteDir);
+    const { plugins } = await (0, context_1.initSwizzleContext)(siteDir, options);
     const themeNames = (0, themes_1.getThemeNames)(plugins);
     if (list && !themeNameParam) {
         await listAllThemeComponents({ themeNames, plugins, typescript });

package/lib/server/configValidation.d.ts

@@ -7,6 +7,6 @@
 import { Joi } from '@docusaurus/utils-validation';
 import type { DocusaurusConfig, I18nConfig } from '@docusaurus/types';
 export declare const DEFAULT_I18N_CONFIG: I18nConfig;
-export declare const DEFAULT_CONFIG: Pick<DocusaurusConfig, 'i18n' | 'onBrokenLinks' | 'onBrokenMarkdownLinks' | 'onDuplicateRoutes' | 'plugins' | 'themes' | 'presets' | 'stylesheets' | 'scripts' | 'clientModules' | 'customFields' | 'themeConfig' | 'titleDelimiter' | 'noIndex' | 'tagline' | 'baseUrlIssueBanner' | 'staticDirectories'>;
+export declare const DEFAULT_CONFIG: Pick<DocusaurusConfig, 'i18n' | 'onBrokenLinks' | 'onBrokenMarkdownLinks' | 'onDuplicateRoutes' | 'plugins' | 'themes' | 'presets' | 'headTags' | 'stylesheets' | 'scripts' | 'clientModules' | 'customFields' | 'themeConfig' | 'titleDelimiter' | 'noIndex' | 'tagline' | 'baseUrlIssueBanner' | 'staticDirectories' | 'markdown'>;
 export declare const ConfigSchema: Joi.ObjectSchema<DocusaurusConfig>;
 export declare function validateConfig(config: unknown, siteConfigPath: string): DocusaurusConfig;

package/lib/server/configValidation.js

@@ -24,6 +24,7 @@ exports.DEFAULT_CONFIG = {
     plugins: [],
     themes: [],
     presets: [],
+    headTags: [],
     stylesheets: [],
     scripts: [],
     clientModules: [],
@@ -34,6 +35,9 @@ exports.DEFAULT_CONFIG = {
     tagline: '',
     baseUrlIssueBanner: true,
     staticDirectories: [utils_1.DEFAULT_STATIC_DIR_NAME],
+    markdown: {
+        mermaid: false,
+    },
 };
 function createPluginSchema(theme) {
     return (utils_validation_1.Joi.alternatives()
@@ -101,24 +105,29 @@ const I18N_CONFIG_SCHEMA = utils_validation_1.Joi.object({
 })
     .optional()
     .default(exports.DEFAULT_I18N_CONFIG);
-const SiteUrlSchema = utils_validation_1.URISchema.required().custom((value, helpers) => {
+const SiteUrlSchema = utils_validation_1.Joi.string()
+    .required()
+    .custom((value, helpers) => {
     try {
-        const { pathname } = new URL(String(value));
+        const { pathname } = new URL(value);
         if (pathname !== '/') {
-            helpers.warn('docusaurus.configValidationWarning', {
-                warningMessage: `the url is not supposed to contain a sub-path like '${pathname}', please use the baseUrl field for sub-paths`,
-            });
+            return helpers.error('docusaurus.subPathError', { pathname });
         }
     }
-    catch { }
-    return value;
-}, 'siteUrlCustomValidation');
+    catch {
+        return helpers.error('any.invalid');
+    }
+    return (0, utils_1.removeTrailingSlash)(value);
+})
+    .messages({
+    'any.invalid': '"{#value}" does not look like a valid URL. Make sure it has a protocol; for example, "https://example.com".',
+    'docusaurus.subPathError': 'The url is not supposed to contain a sub-path like "{#pathname}". Please use the baseUrl field for sub-paths.',
+});
 // TODO move to @docusaurus/utils-validation
 exports.ConfigSchema = utils_validation_1.Joi.object({
     baseUrl: utils_validation_1.Joi.string()
         .required()
-        .regex(/\/$/m)
-        .message('{{#label}} must be a string with a trailing slash.'),
+        .custom((value) => (0, utils_1.addLeadingSlash)((0, utils_1.addTrailingSlash)(value))),
     baseUrlIssueBanner: utils_validation_1.Joi.boolean().default(exports.DEFAULT_CONFIG.baseUrlIssueBanner),
     favicon: utils_validation_1.Joi.string().optional(),
     title: utils_validation_1.Joi.string().required(),
@@ -160,6 +169,17 @@ exports.ConfigSchema = utils_validation_1.Joi.object({
     })
         .default(exports.DEFAULT_CONFIG.scripts),
     ssrTemplate: utils_validation_1.Joi.string(),
+    headTags: utils_validation_1.Joi.array()
+        .items(utils_validation_1.Joi.object({
+        tagName: utils_validation_1.Joi.string().required(),
+        attributes: utils_validation_1.Joi.object()
+            .pattern(/[\w-]+/, utils_validation_1.Joi.string())
+            .required(),
+    }).unknown())
+        .messages({
+        'array.includes': '{#label} is invalid. A headTag must be an object with at least a "tagName" and an "attributes" property.',
+    })
+        .default(exports.DEFAULT_CONFIG.headTags),
     stylesheets: utils_validation_1.Joi.array()
         .items(utils_validation_1.Joi.string(), utils_validation_1.Joi.object({
         href: utils_validation_1.Joi.string().required(),
@@ -180,6 +200,9 @@ exports.ConfigSchema = utils_validation_1.Joi.object({
             .try(utils_validation_1.Joi.string().equal('babel'), utils_validation_1.Joi.function())
             .optional(),
     }).optional(),
+    markdown: utils_validation_1.Joi.object({
+        mermaid: utils_validation_1.Joi.boolean().default(exports.DEFAULT_CONFIG.markdown.mermaid),
+    }).default(exports.DEFAULT_CONFIG.markdown),
 }).messages({
     'docusaurus.configValidationWarning': 'Docusaurus config validation warning. Field {#label}: {#warningMessage}',
 });

package/lib/server/plugins/synthetic.js

@@ -15,7 +15,7 @@ const path_1 = tslib_1.__importDefault(require("path"));
  * - Inject scripts/stylesheets
  */
 function createBootstrapPlugin({ siteDir, siteConfig, }) {
-    const { stylesheets, scripts, clientModules: siteConfigClientModules, } = siteConfig;
+    const { stylesheets, scripts, headTags, clientModules: siteConfigClientModules, } = siteConfig;
     return {
         name: 'docusaurus-bootstrap-plugin',
         content: null,
@@ -46,7 +46,7 @@ function createBootstrapPlugin({ siteDir, siteConfig, }) {
                     },
                 });
             return {
-                headTags: [...stylesheetsTags, ...scriptsTags],
+                headTags: [...headTags, ...stylesheetsTags, ...scriptsTags],
             };
         },
     };
@@ -87,6 +87,7 @@ function createMDXFallbackPlugin({ siteDir, siteConfig, }) {
                 isMDXPartial: () => true,
                 // External MDX files might have front matter, just disable the warning
                 isMDXPartialFrontMatterWarningDisabled: true,
+                markdownConfig: siteConfig.markdown,
             };
             return {
                 module: {

package/lib/server/routes.js

@@ -18,6 +18,7 @@ function indent(str) {
     return `  ${str.replace(/\n/g, `\n  `)}`;
 }
 const chunkNameCache = new Map();
+const chunkNameCount = new Map();
 /**
  * Generates a unique chunk name that can be used in the chunk registry.
  *
@@ -41,10 +42,15 @@ function genChunkName(modulePath, prefix, preferredName, shortId = process.env.N
                 const shortHash = (0, utils_1.simpleHash)(modulePath, 3);
                 str = `${preferredName}${shortHash}`;
             }
-            const name = str === '/' ? 'index' : (0, utils_1.docuHash)(str);
+            const name = (0, utils_1.docuHash)(str);
             chunkName = prefix ? `${prefix}---${name}` : name;
         }
+        const seenCount = (chunkNameCount.get(chunkName) ?? 0) + 1;
+        if (seenCount > 1) {
+            chunkName += seenCount.toString(36);
+        }
         chunkNameCache.set(modulePath, chunkName);
+        chunkNameCount.set(chunkName, seenCount);
     }
     return chunkName;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "2.1.0",
+  "version": "2.3.0",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -43,13 +43,13 @@
     "@babel/runtime": "^7.18.6",
     "@babel/runtime-corejs3": "^7.18.6",
     "@babel/traverse": "^7.18.8",
-    "@docusaurus/cssnano-preset": "2.1.0",
-    "@docusaurus/logger": "2.1.0",
-    "@docusaurus/mdx-loader": "2.1.0",
+    "@docusaurus/cssnano-preset": "2.3.0",
+    "@docusaurus/logger": "2.3.0",
+    "@docusaurus/mdx-loader": "2.3.0",
     "@docusaurus/react-loadable": "5.5.2",
-    "@docusaurus/utils": "2.1.0",
-    "@docusaurus/utils-common": "2.1.0",
-    "@docusaurus/utils-validation": "2.1.0",
+    "@docusaurus/utils": "2.3.0",
+    "@docusaurus/utils-common": "2.3.0",
+    "@docusaurus/utils-validation": "2.3.0",
     "@slorber/static-site-generator-webpack-plugin": "^4.0.7",
     "@svgr/webpack": "^6.2.1",
     "autoprefixer": "^10.4.7",
@@ -106,8 +106,8 @@
     "webpackbar": "^5.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.1.0",
-    "@docusaurus/types": "2.1.0",
+    "@docusaurus/module-type-aliases": "2.3.0",
+    "@docusaurus/types": "2.3.0",
     "@types/detect-port": "^1.3.2",
     "@types/react-dom": "^18.0.6",
     "@types/react-router-config": "^5.0.6",
@@ -118,7 +118,7 @@
     "@types/webpack-bundle-analyzer": "^4.4.1",
     "react-test-renderer": "^17.0.2",
     "tmp-promise": "^3.0.3",
-    "tree-node-cli": "^1.5.2"
+    "tree-node-cli": "^1.6.0"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
@@ -127,5 +127,5 @@
   "engines": {
     "node": ">=16.14"
   },
-  "gitHead": "be9b0942641184213485eba7fd75ceb0b328d3f4"
+  "gitHead": "ad477781bdca6a11fa9c6daef5048bdcec0ee37e"
 }