@docusaurus/core 0.0.0-4798 → 0.0.0-4799

package/lib/server/plugins/synthetic.js

@@ -0,0 +1,112 @@
+"use strict";
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMDXFallbackPlugin = exports.createBootstrapPlugin = void 0;
+const tslib_1 = require("tslib");
+const path_1 = tslib_1.__importDefault(require("path"));
+const remark_admonitions_1 = tslib_1.__importDefault(require("remark-admonitions"));
+/**
+ * Make a synthetic plugin to:
+ * - Inject site client modules
+ * - Inject scripts/stylesheets
+ */
+function createBootstrapPlugin({ siteDir, siteConfig, }) {
+    const { stylesheets, scripts, clientModules: siteConfigClientModules, } = siteConfig;
+    return {
+        name: 'docusaurus-bootstrap-plugin',
+        content: null,
+        options: {
+            id: 'default',
+        },
+        version: { type: 'synthetic' },
+        path: siteDir,
+        getClientModules() {
+            return siteConfigClientModules;
+        },
+        injectHtmlTags: () => {
+            const stylesheetsTags = stylesheets.map((source) => typeof source === 'string'
+                ? `<link rel="stylesheet" href="${source}">`
+                : {
+                    tagName: 'link',
+                    attributes: {
+                        rel: 'stylesheet',
+                        ...source,
+                    },
+                });
+            const scriptsTags = scripts.map((source) => typeof source === 'string'
+                ? `<script src="${source}"></script>`
+                : {
+                    tagName: 'script',
+                    attributes: {
+                        ...source,
+                    },
+                });
+            return {
+                headTags: [...stylesheetsTags, ...scriptsTags],
+            };
+        },
+    };
+}
+exports.createBootstrapPlugin = createBootstrapPlugin;
+/**
+ * Configure Webpack fallback mdx loader for md/mdx files out of content-plugin
+ * folders. Adds a "fallback" mdx loader for mdx files that are not processed by
+ * content plugins. This allows to do things such as importing repo/README.md as
+ * a partial from another doc. Not ideal solution, but good enough for now
+ */
+function createMDXFallbackPlugin({ siteDir, siteConfig, }) {
+    return {
+        name: 'docusaurus-mdx-fallback-plugin',
+        content: null,
+        options: {
+            id: 'default',
+        },
+        version: { type: 'synthetic' },
+        // Synthetic, the path doesn't matter much
+        path: '.',
+        configureWebpack(config, isServer, { getJSLoader }) {
+            // We need the mdx fallback loader to exclude files that were already
+            // processed by content plugins mdx loaders. This works, but a bit
+            // hacky... Not sure there's a way to handle that differently in webpack
+            function getMDXFallbackExcludedPaths() {
+                const rules = config?.module?.rules;
+                return rules.flatMap((rule) => {
+                    const isMDXRule = rule.test instanceof RegExp && rule.test.test('x.mdx');
+                    return isMDXRule ? rule.include : [];
+                });
+            }
+            const mdxLoaderOptions = {
+                staticDirs: siteConfig.staticDirectories.map((dir) => path_1.default.resolve(siteDir, dir)),
+                siteDir,
+                // External MDX files are always meant to be imported as partials
+                isMDXPartial: () => true,
+                // External MDX files might have front matter, just disable the warning
+                isMDXPartialFrontMatterWarningDisabled: true,
+                remarkPlugins: [remark_admonitions_1.default],
+            };
+            return {
+                module: {
+                    rules: [
+                        {
+                            test: /\.mdx?$/i,
+                            exclude: getMDXFallbackExcludedPaths(),
+                            use: [
+                                getJSLoader({ isServer }),
+                                {
+                                    loader: require.resolve('@docusaurus/mdx-loader'),
+                                    options: mdxLoaderOptions,
+                                },
+                            ],
+                        },
+                    ],
+                },
+            };
+        },
+    };
+}
+exports.createMDXFallbackPlugin = createMDXFallbackPlugin;

package/lib/server/routes.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { ChunkRegistry, RouteConfig, ChunkNames } from '@docusaurus/types';
-export default function loadRoutes(pluginsRouteConfigs: RouteConfig[], baseUrl: string): Promise<{
+export declare function loadRoutes(pluginsRouteConfigs: RouteConfig[], baseUrl: string): Promise<{
     registry: {
         [chunkName: string]: ChunkRegistry;
     };

package/lib/server/routes.js

@@ -6,6 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadRoutes = void 0;
 const utils_1 = require("@docusaurus/utils");
 const querystring_1 = require("querystring");
 function indent(str) {
@@ -127,7 +128,7 @@ ${indent(NotFoundRouteCode)}
         routesPaths,
     };
 }
-exports.default = loadRoutes;
+exports.loadRoutes = loadRoutes;
 function genRouteChunkNames(
 // TODO instead of passing a mutating the registry, return a registry slice?
 registry, value, prefix, name) {

package/lib/server/{versions/index.d.ts → siteMetadata.d.ts}

@@ -4,6 +4,9 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { PluginVersionInformation } from '@docusaurus/types';
-export declare function getPackageJsonVersion(packageJsonPath: string): Promise<string | undefined>;
+import type { LoadedPlugin, PluginVersionInformation, DocusaurusSiteMetadata } from '@docusaurus/types';
 export declare function getPluginVersion(pluginPath: string, siteDir: string): Promise<PluginVersionInformation>;
+export declare function loadSiteMetadata({ plugins, siteDir, }: {
+    plugins: LoadedPlugin[];
+    siteDir: string;
+}): Promise<DocusaurusSiteMetadata>;

package/lib/server/{versions/index.js → siteMetadata.js}

@@ -6,10 +6,11 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPluginVersion = exports.getPackageJsonVersion = void 0;
+exports.loadSiteMetadata = exports.getPluginVersion = 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"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 async function getPackageJsonVersion(packageJsonPath) {
     if (await fs_extra_1.default.pathExists(packageJsonPath)) {
         // eslint-disable-next-line @typescript-eslint/no-var-requires, import/no-dynamic-require, global-require
@@ -17,7 +18,6 @@ async function getPackageJsonVersion(packageJsonPath) {
     }
     return undefined;
 }
-exports.getPackageJsonVersion = getPackageJsonVersion;
 async function getPackageJsonName(packageJsonPath) {
     // eslint-disable-next-line @typescript-eslint/no-var-requires, import/no-dynamic-require, global-require
     return require(packageJsonPath).name;
@@ -46,3 +46,35 @@ async function getPluginVersion(pluginPath, siteDir) {
     return { type: 'local' };
 }
 exports.getPluginVersion = getPluginVersion;
+/**
+ * We want all `@docusaurus/*` packages to have the exact same version!
+ * @see https://github.com/facebook/docusaurus/issues/3371
+ * @see https://github.com/facebook/docusaurus/pull/3386
+ */
+function checkDocusaurusPackagesVersion(siteMetadata) {
+    const { docusaurusVersion } = siteMetadata;
+    Object.entries(siteMetadata.pluginVersions).forEach(([plugin, versionInfo]) => {
+        if (versionInfo.type === 'package' &&
+            versionInfo.name?.startsWith('@docusaurus/') &&
+            versionInfo.version &&
+            versionInfo.version !== docusaurusVersion) {
+            // should we throw instead?
+            // It still could work with different versions
+            logger_1.default.error `Invalid name=${plugin} version number=${versionInfo.version}.
+All official @docusaurus/* packages should have the exact same version as @docusaurus/core (number=${docusaurusVersion}).
+Maybe you want to check, or regenerate your yarn.lock or package-lock.json file?`;
+        }
+    });
+}
+async function loadSiteMetadata({ plugins, siteDir, }) {
+    const siteMetadata = {
+        docusaurusVersion: (await getPackageJsonVersion(path_1.default.join(__dirname, '../../package.json'))),
+        siteVersion: await getPackageJsonVersion(path_1.default.join(siteDir, 'package.json')),
+        pluginVersions: Object.fromEntries(plugins
+            .filter(({ version: { type } }) => type !== 'synthetic')
+            .map(({ name, version }) => [name, version])),
+    };
+    checkDocusaurusPackagesVersion(siteMetadata);
+    return siteMetadata;
+}
+exports.loadSiteMetadata = loadSiteMetadata;

package/lib/server/themes/alias.d.ts

@@ -6,4 +6,4 @@
  */
 import type { ThemeAliases } from '@docusaurus/types';
 export declare function sortAliases(aliases: ThemeAliases): ThemeAliases;
-export default function themeAlias(themePath: string, addOriginalAlias: boolean): Promise<ThemeAliases>;
+export declare function themeAlias(themePath: string, addOriginalAlias: boolean): Promise<ThemeAliases>;

package/lib/server/themes/alias.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sortAliases = void 0;
+exports.themeAlias = exports.sortAliases = 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"));
@@ -47,4 +47,4 @@ async function themeAlias(themePath, addOriginalAlias) {
     });
     return sortAliases(aliases);
 }
-exports.default = themeAlias;
+exports.themeAlias = themeAlias;

package/lib/server/themes/index.js

@@ -10,12 +10,12 @@ exports.loadPluginsThemeAliases = exports.loadThemeAliases = void 0;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
 const utils_1 = require("@docusaurus/utils");
-const alias_1 = tslib_1.__importStar(require("./alias"));
+const alias_1 = require("./alias");
 const ThemeFallbackDir = path_1.default.join(__dirname, '../../client/theme-fallback');
 async function loadThemeAliases(themePaths, userThemePaths) {
     const aliases = {};
     for (const themePath of themePaths) {
-        const themeAliases = await (0, alias_1.default)(themePath, true);
+        const themeAliases = await (0, alias_1.themeAlias)(themePath, true);
         Object.entries(themeAliases).forEach(([aliasKey, alias]) => {
             // If this alias shadows a previous one, use @theme-init to preserve the
             // initial one. @theme-init is only applied once: to the initial theme
@@ -31,7 +31,7 @@ async function loadThemeAliases(themePaths, userThemePaths) {
         });
     }
     for (const themePath of userThemePaths) {
-        const userThemeAliases = await (0, alias_1.default)(themePath, false);
+        const userThemeAliases = await (0, alias_1.themeAlias)(themePath, false);
         Object.assign(aliases, userThemeAliases);
     }
     return (0, alias_1.sortAliases)(aliases);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "0.0.0-4798",
+  "version": "0.0.0-4799",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -41,13 +41,13 @@
     "@babel/runtime": "^7.17.8",
     "@babel/runtime-corejs3": "^7.17.8",
     "@babel/traverse": "^7.17.3",
-    "@docusaurus/cssnano-preset": "0.0.0-4798",
-    "@docusaurus/logger": "0.0.0-4798",
-    "@docusaurus/mdx-loader": "0.0.0-4798",
+    "@docusaurus/cssnano-preset": "0.0.0-4799",
+    "@docusaurus/logger": "0.0.0-4799",
+    "@docusaurus/mdx-loader": "0.0.0-4799",
     "@docusaurus/react-loadable": "5.5.2",
-    "@docusaurus/utils": "0.0.0-4798",
-    "@docusaurus/utils-common": "0.0.0-4798",
-    "@docusaurus/utils-validation": "0.0.0-4798",
+    "@docusaurus/utils": "0.0.0-4799",
+    "@docusaurus/utils-common": "0.0.0-4799",
+    "@docusaurus/utils-validation": "0.0.0-4799",
     "@slorber/static-site-generator-webpack-plugin": "^4.0.4",
     "@svgr/webpack": "^6.2.1",
     "autoprefixer": "^10.4.4",
@@ -106,8 +106,8 @@
     "webpackbar": "^5.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4798",
-    "@docusaurus/types": "0.0.0-4798",
+    "@docusaurus/module-type-aliases": "0.0.0-4799",
+    "@docusaurus/types": "0.0.0-4799",
     "@types/detect-port": "^1.3.2",
     "@types/nprogress": "^0.2.0",
     "@types/react-dom": "^17.0.14",
@@ -128,5 +128,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "07a0df4850e335427cfa6c233d1726febc0995cc"
+  "gitHead": "f0feed7df346c16329386f13a7f8522660b97a51"
 }

package/lib/server/html-tags/htmlTags.js

@@ -1,38 +0,0 @@
-"use strict";
-/**
- * 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const html_tags_1 = tslib_1.__importDefault(require("html-tags"));
-const void_1 = tslib_1.__importDefault(require("html-tags/void"));
-const escape_html_1 = tslib_1.__importDefault(require("escape-html"));
-function assertIsHtmlTagObject(val) {
-    if (typeof val !== 'object' || !val) {
-        throw new Error(`"${val}" is not a valid HTML tag object.`);
-    }
-    if (typeof val.tagName !== 'string') {
-        throw new Error(`${JSON.stringify(val)} is not a valid HTML tag object. "tagName" must be defined as a string.`);
-    }
-}
-function htmlTagObjectToString(tagDefinition) {
-    assertIsHtmlTagObject(tagDefinition);
-    if (html_tags_1.default.indexOf(tagDefinition.tagName) === -1) {
-        throw new Error(`Error loading ${JSON.stringify(tagDefinition)}, "${tagDefinition.tagName}" is not a valid HTML tags.`);
-    }
-    const isVoidTag = void_1.default.indexOf(tagDefinition.tagName) !== -1;
-    const tagAttributes = tagDefinition.attributes ?? {};
-    const attributes = Object.keys(tagAttributes)
-        .filter((attributeName) => tagAttributes[attributeName] !== false)
-        .map((attributeName) => {
-        if (tagAttributes[attributeName] === true) {
-            return attributeName;
-        }
-        return `${attributeName}="${(0, escape_html_1.default)(tagAttributes[attributeName])}"`;
-    });
-    return `<${[tagDefinition.tagName].concat(attributes).join(' ')}>${(!isVoidTag && tagDefinition.innerHTML) || ''}${isVoidTag ? '' : `</${tagDefinition.tagName}>`}`;
-}
-exports.default = htmlTagObjectToString;

package/lib/server/html-tags/index.js

@@ -1,42 +0,0 @@
-"use strict";
-/**
- * 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadHtmlTags = void 0;
-const tslib_1 = require("tslib");
-const htmlTags_1 = tslib_1.__importDefault(require("./htmlTags"));
-function toString(val) {
-    return typeof val === 'string' ? val : (0, htmlTags_1.default)(val);
-}
-function createHtmlTagsString(tags) {
-    return Array.isArray(tags) ? tags.map(toString).join('\n') : toString(tags);
-}
-function loadHtmlTags(plugins) {
-    const htmlTags = plugins.reduce((acc, plugin) => {
-        if (!plugin.injectHtmlTags) {
-            return acc;
-        }
-        const { headTags, preBodyTags, postBodyTags } = plugin.injectHtmlTags({ content: plugin.content }) ?? {};
-        return {
-            headTags: headTags
-                ? `${acc.headTags}\n${createHtmlTagsString(headTags)}`
-                : acc.headTags,
-            preBodyTags: preBodyTags
-                ? `${acc.preBodyTags}\n${createHtmlTagsString(preBodyTags)}`
-                : acc.preBodyTags,
-            postBodyTags: postBodyTags
-                ? `${acc.postBodyTags}\n${createHtmlTagsString(postBodyTags)}`
-                : acc.postBodyTags,
-        };
-    }, { headTags: '', preBodyTags: '', postBodyTags: '' });
-    return {
-        headTags: htmlTags.headTags.trim(),
-        preBodyTags: htmlTags.preBodyTags.trim(),
-        postBodyTags: htmlTags.postBodyTags.trim(),
-    };
-}
-exports.loadHtmlTags = loadHtmlTags;

package/lib/server/plugins/applyRouteTrailingSlash.js

@@ -1,19 +0,0 @@
-"use strict";
-/**
- * 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-const utils_common_1 = require("@docusaurus/utils-common");
-function applyRouteTrailingSlash(route, params) {
-    return {
-        ...route,
-        path: (0, utils_common_1.applyTrailingSlash)(route.path, params),
-        ...(route.routes && {
-            routes: route.routes.map((subroute) => applyRouteTrailingSlash(subroute, params)),
-        }),
-    };
-}
-exports.default = applyRouteTrailingSlash;