@docusaurus/core 0.0.0-4205 → 0.0.0-4209

package/lib/commands/start.js

@@ -20,7 +20,6 @@ const webpack_1 = (0, tslib_1.__importDefault)(require("webpack"));
 const webpack_dev_server_1 = (0, tslib_1.__importDefault)(require("webpack-dev-server"));
 const webpack_merge_1 = (0, tslib_1.__importDefault)(require("webpack-merge"));
 const server_1 = require("../server");
-const constants_1 = require("../constants");
 const client_1 = (0, tslib_1.__importDefault)(require("../webpack/client"));
 const utils_2 = require("../webpack/utils");
 const commandUtils_1 = require("./commandUtils");
@@ -144,9 +143,9 @@ async function start(siteDir, cliOptions) {
             // Reduce log verbosity, see https://github.com/facebook/docusaurus/pull/5420#issuecomment-906613105
             stats: 'summary',
         },
-        static: {
+        static: siteConfig.staticDirectories.map((dir) => ({
             publicPath: baseUrl,
-            directory: path_1.default.resolve(siteDir, constants_1.STATIC_DIR_NAME),
+            directory: path_1.default.resolve(siteDir, dir),
             watch: {
                 // Useful options for our own monorepo using symlinks!
                 // See https://github.com/webpack/webpack/issues/11612#issuecomment-879259806
@@ -154,7 +153,7 @@ async function start(siteDir, cliOptions) {
                 ignored: /node_modules\/(?!@docusaurus)/,
                 ...{ pollingOptions },
             },
-        },
+        })),
         historyApiFallback: {
             rewrites: [{ from: /\/*/, to: baseUrl }],
         },

package/lib/server/brokenLinks.js

@@ -50,9 +50,7 @@ function filterIntermediateRoutes(routesInput) {
 }
 function getAllBrokenLinks({ allCollectedLinks, routes, }) {
     const filteredRoutes = filterIntermediateRoutes(routes);
-    const allBrokenLinks = (0, lodash_1.mapValues)(allCollectedLinks, (pageLinks, pagePath) => {
-        return getPageBrokenLinks({ pageLinks, pagePath, routes: filteredRoutes });
-    });
+    const allBrokenLinks = (0, lodash_1.mapValues)(allCollectedLinks, (pageLinks, pagePath) => getPageBrokenLinks({ pageLinks, pagePath, routes: filteredRoutes }));
     // remove pages without any broken link
     return (0, lodash_1.pickBy)(allBrokenLinks, (brokenLinks) => brokenLinks.length > 0);
 }
@@ -117,9 +115,7 @@ async function filterExistingFileLinks({ baseUrl, outDir, allCollectedLinks, })
         }
         return filePathsToTry.some(isExistingFile);
     }
-    return (0, lodash_1.mapValues)(allCollectedLinks, (links) => {
-        return links.filter((link) => !linkFileExists(link));
-    });
+    return (0, lodash_1.mapValues)(allCollectedLinks, (links) => links.filter((link) => !linkFileExists(link)));
 }
 exports.filterExistingFileLinks = filterExistingFileLinks;
 async function handleBrokenLinks({ allCollectedLinks, onBrokenLinks, routes, baseUrl, outDir, }) {

package/lib/server/configValidation.d.ts

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

package/lib/server/configValidation.js

@@ -28,6 +28,7 @@ exports.DEFAULT_CONFIG = {
     titleDelimiter: '|',
     noIndex: false,
     baseUrlIssueBanner: true,
+    staticDirectories: [constants_1.STATIC_DIR_NAME],
 };
 const PluginSchema = utils_validation_1.Joi.alternatives()
     .try(utils_validation_1.Joi.function(), utils_validation_1.Joi.array().ordered(utils_validation_1.Joi.function().required(), utils_validation_1.Joi.object().required()), utils_validation_1.Joi.string(), utils_validation_1.Joi.array()
@@ -68,7 +69,7 @@ const I18N_CONFIG_SCHEMA = utils_validation_1.Joi.object({
 })
     .optional()
     .default(exports.DEFAULT_I18N_CONFIG);
-const SiteUrlSchema = utils_validation_1.URISchema.required().custom(function (value, helpers) {
+const SiteUrlSchema = utils_validation_1.URISchema.required().custom((value, helpers) => {
     try {
         const { pathname } = new URL(value);
         if (pathname !== '/') {
@@ -84,7 +85,7 @@ const SiteUrlSchema = utils_validation_1.URISchema.required().custom(function (v
 exports.ConfigSchema = utils_validation_1.Joi.object({
     baseUrl: utils_validation_1.Joi.string()
         .required()
-        .regex(new RegExp('/$', 'm'))
+        .regex(/\/$/m)
         .message('{{#label}} must be a string with a trailing slash.'),
     baseUrlIssueBanner: utils_validation_1.Joi.boolean().default(exports.DEFAULT_CONFIG.baseUrlIssueBanner),
     favicon: utils_validation_1.Joi.string().optional(),
@@ -102,6 +103,9 @@ exports.ConfigSchema = utils_validation_1.Joi.object({
         .equal('ignore', 'log', 'warn', 'error', 'throw')
         .default(exports.DEFAULT_CONFIG.onDuplicateRoutes),
     organizationName: utils_validation_1.Joi.string().allow(''),
+    staticDirectories: utils_validation_1.Joi.array()
+        .items(utils_validation_1.Joi.string())
+        .default(exports.DEFAULT_CONFIG.staticDirectories),
     projectName: utils_validation_1.Joi.string().allow(''),
     deploymentBranch: utils_validation_1.Joi.string().optional(),
     customFields: utils_validation_1.Joi.object().unknown().default(exports.DEFAULT_CONFIG.customFields),

package/lib/server/i18n.js

@@ -10,9 +10,7 @@ const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
 function getDefaultLocaleLabel(locale) {
     // Intl.DisplayNames is ES2021 - Node14+
     // https://v8.dev/features/intl-displaynames
-    // @ts-expect-error: wait for TS support of ES2021 feature
     if (typeof Intl.DisplayNames !== 'undefined') {
-        // @ts-expect-error: wait for TS support of ES2021 feature
         return new Intl.DisplayNames([locale], { type: 'language' }).of(locale);
     }
     return locale;
@@ -50,9 +48,7 @@ Note: Docusaurus only support running one locale at a time.`));
             ...i18nConfig.localeConfigs[locale],
         };
     }
-    const localeConfigs = locales.reduce((acc, locale) => {
-        return { ...acc, [locale]: getLocaleConfig(locale) };
-    }, {});
+    const localeConfigs = locales.reduce((acc, locale) => ({ ...acc, [locale]: getLocaleConfig(locale) }), {});
     return {
         defaultLocale: i18nConfig.defaultLocale,
         locales,

package/lib/server/index.js

@@ -134,7 +134,7 @@ function createBootstrapPlugin({ siteConfig, }) {
 // 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 though, but good enough for now
-function createMDXFallbackPlugin({ siteDir }) {
+function createMDXFallbackPlugin({ siteDir, siteConfig, }) {
     return {
         name: 'docusaurus-mdx-fallback-plugin',
         content: null,
@@ -163,7 +163,8 @@ function createMDXFallbackPlugin({ siteDir }) {
                                 {
                                     loader: require.resolve('@docusaurus/mdx-loader'),
                                     options: {
-                                        staticDir: path_1.default.join(siteDir, constants_1.STATIC_DIR_NAME),
+                                        staticDirs: siteConfig.staticDirectories.map((dir) => path_1.default.resolve(siteDir, dir)),
+                                        siteDir,
                                         isMDXPartial: (_filename) => true,
                                         isMDXPartialFrontMatterWarningDisabled: true,
                                         remarkPlugins: [remark_admonitions_1.default],
@@ -191,7 +192,7 @@ async function load(siteDir, options = {}) {
     // We want the generated config to have been normalized by the plugins!
     const genSiteConfig = (0, utils_1.generate)(generatedFilesDir, constants_1.DEFAULT_CONFIG_FILE_NAME, `export default ${JSON.stringify(siteConfig, null, 2)};`);
     plugins.push(createBootstrapPlugin({ siteConfig }));
-    plugins.push(createMDXFallbackPlugin({ siteDir }));
+    plugins.push(createMDXFallbackPlugin({ siteDir, siteConfig }));
     // Load client modules.
     const clientModules = (0, client_modules_1.default)(plugins);
     const genClientModules = (0, utils_1.generate)(generatedFilesDir, 'client-modules.js', `export default [\n${clientModules

package/lib/server/plugins/index.js

@@ -83,12 +83,10 @@ async function loadPlugins({ pluginConfigs, context, }) {
     }));
     const allContent = (0, lodash_1.chain)(loadedPlugins)
         .groupBy((item) => item.name)
-        .mapValues((nameItems) => {
-        return (0, lodash_1.chain)(nameItems)
-            .groupBy((item) => { var _a; return (_a = item.options.id) !== null && _a !== void 0 ? _a : constants_1.DEFAULT_PLUGIN_ID; })
-            .mapValues((idItems) => idItems[0].content)
-            .value();
-    })
+        .mapValues((nameItems) => (0, lodash_1.chain)(nameItems)
+        .groupBy((item) => { var _a; return (_a = item.options.id) !== null && _a !== void 0 ? _a : constants_1.DEFAULT_PLUGIN_ID; })
+        .mapValues((idItems) => idItems[0].content)
+        .value())
         .value();
     // 3. Plugin Lifecycle - contentLoaded.
     const pluginsRouteConfigs = [];

package/lib/server/themes/alias.js

@@ -20,9 +20,7 @@ function sortAliases(aliases) {
     // Alphabetical order by default
     const entries = (0, lodash_1.sortBy)(Object.entries(aliases), ([alias]) => alias);
     // @theme/NavbarItem should be after @theme/NavbarItem/LocaleDropdown
-    entries.sort(([alias1], [alias2]) => {
-        return alias1.includes(`${alias2}/`) ? -1 : 0;
-    });
+    entries.sort(([alias1], [alias2]) => alias1.includes(`${alias2}/`) ? -1 : 0);
     return Object.fromEntries(entries);
 }
 exports.sortAliases = sortAliases;

package/lib/server/translations/translations.js

@@ -172,9 +172,7 @@ async function localizePluginTranslationFile({ siteDir, plugin, locale, translat
 exports.localizePluginTranslationFile = localizePluginTranslationFile;
 async function getPluginsDefaultCodeTranslationMessages(plugins) {
     const pluginsMessages = await Promise.all(plugins.map((plugin) => { var _a, _b; return (_b = (_a = plugin.getDefaultCodeTranslationMessages) === null || _a === void 0 ? void 0 : _a.call(plugin)) !== null && _b !== void 0 ? _b : {}; }));
-    return pluginsMessages.reduce((allMessages, pluginMessages) => {
-        return { ...allMessages, ...pluginMessages };
-    }, {});
+    return pluginsMessages.reduce((allMessages, pluginMessages) => ({ ...allMessages, ...pluginMessages }), {});
 }
 exports.getPluginsDefaultCodeTranslationMessages = getPluginsDefaultCodeTranslationMessages;
 function applyDefaultCodeTranslations({ extractedCodeTranslations, defaultCodeMessages, }) {
@@ -187,10 +185,10 @@ Please report this Docusaurus issue.
     }
     return (0, lodash_1.mapValues)(extractedCodeTranslations, (messageTranslation, messageId) => {
         var _a;
-        return {
+        return ({
             ...messageTranslation,
             message: (_a = defaultCodeMessages[messageId]) !== null && _a !== void 0 ? _a : messageTranslation.message,
-        };
+        });
     });
 }
 exports.applyDefaultCodeTranslations = applyDefaultCodeTranslations;

package/lib/server/translations/translationsExtractor.js

@@ -63,9 +63,7 @@ async function getSourceCodeFilePaths(siteDir, plugins) {
 async function extractSiteSourceCodeTranslations(siteDir, plugins, babelOptions, extraSourceCodeFilePaths = []) {
     // Should we warn here if the same translation "key" is found in multiple source code files?
     function toTranslationFileContent(sourceCodeFileTranslations) {
-        return sourceCodeFileTranslations.reduce((acc, item) => {
-            return { ...acc, ...item.translations };
-        }, {});
+        return sourceCodeFileTranslations.reduce((acc, item) => ({ ...acc, ...item.translations }), {});
     }
     const sourceCodeFilePaths = await getSourceCodeFilePaths(siteDir, plugins);
     const allSourceCodeFilePaths = [

package/lib/webpack/plugins/CleanWebpackPlugin.js

@@ -86,17 +86,13 @@ class CleanWebpackPlugin {
             all: false,
             assets: true,
         }).assets || [];
-        const assets = statsAssets.map((asset) => {
-            return asset.name;
-        });
+        const assets = statsAssets.map((asset) => asset.name);
         /**
          * Get all files that were in the previous build but not the current
          *
          * (relies on del's cwd: outputPath option)
          */
-        const staleFiles = this.currentAssets.filter((previousAsset) => {
-            return assets.includes(previousAsset) === false;
-        });
+        const staleFiles = this.currentAssets.filter((previousAsset) => assets.includes(previousAsset) === false);
         /**
          * Save assets for next compilation
          */

package/lib/webpack/utils.js

@@ -112,7 +112,7 @@ const getCustomizableJSLoader = (jsLoader = 'babel') => ({ isServer, babelOption
     : jsLoader(isServer);
 exports.getCustomizableJSLoader = getCustomizableJSLoader;
 // TODO remove this before end of 2021?
-const warnBabelLoaderOnce = (0, lodash_1.memoize)(function () {
+const warnBabelLoaderOnce = (0, lodash_1.memoize)(() => {
     console.warn(chalk_1.default.yellow('Docusaurus plans to support multiple JS loader strategies (Babel, esbuild...): "getBabelLoader(isServer)" is now deprecated in favor of "getJSLoader({isServer})".'));
 });
 const getBabelLoaderDeprecated = function getBabelLoaderDeprecated(isServer, babelOptions) {
@@ -120,7 +120,7 @@ const getBabelLoaderDeprecated = function getBabelLoaderDeprecated(isServer, bab
     return getDefaultBabelLoader({ isServer, babelOptions });
 };
 // TODO remove this before end of 2021 ?
-const warnCacheLoaderOnce = (0, lodash_1.memoize)(function () {
+const warnCacheLoaderOnce = (0, lodash_1.memoize)(() => {
     console.warn(chalk_1.default.yellow('Docusaurus uses Webpack 5 and getCacheLoader() usage is now deprecated.'));
 });
 function getCacheLoaderDeprecated() {
@@ -228,24 +228,20 @@ function getFileLoaderUtils() {
     // defines the path/pattern of the assets handled by webpack
     const fileLoaderFileName = (folder) => `${constants_1.OUTPUT_STATIC_ASSETS_DIR_NAME}/${folder}/[name]-[hash].[ext]`;
     const loaders = {
-        file: (options) => {
-            return {
-                loader: require.resolve(`file-loader`),
-                options: {
-                    name: fileLoaderFileName(options.folder),
-                },
-            };
-        },
-        url: (options) => {
-            return {
-                loader: require.resolve(`url-loader`),
-                options: {
-                    limit: urlLoaderLimit,
-                    name: fileLoaderFileName(options.folder),
-                    fallback: require.resolve(`file-loader`),
-                },
-            };
-        },
+        file: (options) => ({
+            loader: require.resolve(`file-loader`),
+            options: {
+                name: fileLoaderFileName(options.folder),
+            },
+        }),
+        url: (options) => ({
+            loader: require.resolve(`url-loader`),
+            options: {
+                limit: urlLoaderLimit,
+                name: fileLoaderFileName(options.folder),
+                fallback: require.resolve(`file-loader`),
+            },
+        }),
         // TODO find a better solution to avoid conflicts with the ideal-image plugin
         // TODO this may require a little breaking change for ideal-image users?
         // Maybe with the ideal image plugin, all md images should be "ideal"?
@@ -259,65 +255,55 @@ function getFileLoaderUtils() {
          * Loads image assets, inlines images via a data URI if they are below
          * the size threshold
          */
-        images: () => {
-            return {
-                use: [loaders.url({ folder: 'images' })],
-                test: /\.(ico|jpg|jpeg|png|gif|webp)(\?.*)?$/,
-            };
-        },
-        fonts: () => {
-            return {
-                use: [loaders.url({ folder: 'fonts' })],
-                test: /\.(woff|woff2|eot|ttf|otf)$/,
-            };
-        },
+        images: () => ({
+            use: [loaders.url({ folder: 'images' })],
+            test: /\.(ico|jpg|jpeg|png|gif|webp)(\?.*)?$/,
+        }),
+        fonts: () => ({
+            use: [loaders.url({ folder: 'fonts' })],
+            test: /\.(woff|woff2|eot|ttf|otf)$/,
+        }),
         /**
          * Loads audio and video and inlines them via a data URI if they are below
          * the size threshold
          */
-        media: () => {
-            return {
-                use: [loaders.url({ folder: 'medias' })],
-                test: /\.(mp4|webm|ogv|wav|mp3|m4a|aac|oga|flac)$/,
-            };
-        },
-        svg: () => {
-            return {
-                test: /\.svg?$/,
-                oneOf: [
-                    {
-                        use: [
-                            {
-                                loader: '@svgr/webpack',
-                                options: {
-                                    prettier: false,
-                                    svgo: true,
-                                    svgoConfig: {
-                                        plugins: [{ removeViewBox: false }],
-                                    },
-                                    titleProp: true,
-                                    ref: ![path_1.default],
+        media: () => ({
+            use: [loaders.url({ folder: 'medias' })],
+            test: /\.(mp4|webm|ogv|wav|mp3|m4a|aac|oga|flac)$/,
+        }),
+        svg: () => ({
+            test: /\.svg?$/,
+            oneOf: [
+                {
+                    use: [
+                        {
+                            loader: '@svgr/webpack',
+                            options: {
+                                prettier: false,
+                                svgo: true,
+                                svgoConfig: {
+                                    plugins: [{ removeViewBox: false }],
                                 },
+                                titleProp: true,
+                                ref: ![path_1.default],
                             },
-                        ],
-                        // We don't want to use SVGR loader for non-React source code
-                        // ie we don't want to use SVGR for CSS files...
-                        issuer: {
-                            and: [/\.(ts|tsx|js|jsx|md|mdx)$/],
                         },
+                    ],
+                    // We don't want to use SVGR loader for non-React source code
+                    // ie we don't want to use SVGR for CSS files...
+                    issuer: {
+                        and: [/\.(ts|tsx|js|jsx|md|mdx)$/],
                     },
-                    {
-                        use: [loaders.url({ folder: 'images' })],
-                    },
-                ],
-            };
-        },
-        otherAssets: () => {
-            return {
-                use: [loaders.file({ folder: 'files' })],
-                test: /\.(pdf|doc|docx|xls|xlsx|zip|rar)$/,
-            };
-        },
+                },
+                {
+                    use: [loaders.url({ folder: 'images' })],
+                },
+            ],
+        }),
+        otherAssets: () => ({
+            use: [loaders.file({ folder: 'files' })],
+            test: /\.(pdf|doc|docx|xls|xlsx|zip|rar)$/,
+        }),
     };
     return { loaders, rules };
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "0.0.0-4205",
+  "version": "0.0.0-4209",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -31,7 +31,7 @@
     "url": "https://github.com/facebook/docusaurus/issues"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4205",
+    "@docusaurus/module-type-aliases": "0.0.0-4209",
     "@types/copy-webpack-plugin": "^8.0.1",
     "@types/css-minimizer-webpack-plugin": "^3.0.2",
     "@types/detect-port": "^1.3.0",
@@ -54,12 +54,12 @@
     "@babel/runtime": "^7.15.4",
     "@babel/runtime-corejs3": "^7.15.4",
     "@babel/traverse": "^7.12.13",
-    "@docusaurus/cssnano-preset": "0.0.0-4205",
+    "@docusaurus/cssnano-preset": "0.0.0-4209",
     "@docusaurus/react-loadable": "5.5.2",
-    "@docusaurus/types": "0.0.0-4205",
-    "@docusaurus/utils": "0.0.0-4205",
-    "@docusaurus/utils-common": "0.0.0-4205",
-    "@docusaurus/utils-validation": "0.0.0-4205",
+    "@docusaurus/types": "0.0.0-4209",
+    "@docusaurus/utils": "0.0.0-4209",
+    "@docusaurus/utils-common": "0.0.0-4209",
+    "@docusaurus/utils-validation": "0.0.0-4209",
     "@slorber/static-site-generator-webpack-plugin": "^4.0.0",
     "@svgr/webpack": "^5.5.0",
     "autoprefixer": "^10.3.5",
@@ -129,5 +129,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "61f42acbb6bd9bdcedbc4cbf5c368bb706805967"
+  "gitHead": "84fd42287ef7e3dc0f0a83ad9e2709e59c15e11b"
 }