@docusaurus/core 0.0.0-4872 → 0.0.0-4876

package/bin/beforeCli.mjs

@@ -45,7 +45,6 @@ export default async function beforeCli() {
     // 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
@@ -124,7 +123,7 @@ export default async function beforeCli() {
     console.log(docusaurusUpdateMessage);
   }
 
-  // notify user if node version needs to be updated
+  // 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}.`;

package/lib/client/.eslintrc.js

@@ -11,12 +11,11 @@ module.exports = {
       'error',
       {
         patterns: [
-          // prevent importing lodash in client bundle
-          // prefer shipping vanilla JS
+          // Prevent importing lodash in client bundle for bundle size
           'lodash',
           'lodash.**',
           'lodash/**',
-          // prevent importing server code in client bundle
+          // Prevent importing server code in client bundle
           '**/../babel/**',
           '**/../server/**',
           '**/../commands/**',

package/lib/client/BaseUrlIssueBanner/index.js

@@ -30,7 +30,7 @@ function createInlineHtmlBanner(baseUrl) {
 </div>
 `;
 }
-// fn needs to work for older browsers!
+// Needs to work for older browsers!
 function createInlineScript(baseUrl) {
     return `
 window['${InsertBannerWindowAttribute}'] = true;
@@ -91,7 +91,6 @@ function BaseUrlIssueBanner() {
 export default function MaybeBaseUrlIssueBanner() {
     const { siteConfig: { baseUrl, baseUrlIssueBanner }, } = useDocusaurusContext();
     const { pathname } = useLocation();
-    // returns true for the homepage during SSR
     const isHomePage = pathname === baseUrl;
     const enabled = baseUrlIssueBanner && isHomePage;
     return enabled ? <BaseUrlIssueBanner /> : null;

package/lib/client/LinksCollector.js

@@ -17,8 +17,7 @@ export const createStatefulLinksCollector = () => {
 };
 const Context = React.createContext({
     collectLink: () => {
-        // noop by default for client
-        // we only use the broken links checker server-side
+        // No-op for client. We only use the broken links checker server-side.
     },
 });
 export const useLinksCollector = () => useContext(Context);

package/lib/client/exports/Link.js

@@ -106,7 +106,7 @@ function Link({ isNavLink, to, href, activeClassName, isActive, 'data-noBrokenLi
     // 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} 
-    // avoid "React does not recognize the `activeClassName` prop on a DOM
+    // Avoid "React does not recognize the `activeClassName` prop on a DOM
     // element"
     {...(isNavLink && { isActive, activeClassName })}/>);
 }

package/lib/client/exports/useBaseUrl.js

@@ -7,15 +7,9 @@
 import useDocusaurusContext from './useDocusaurusContext';
 import { hasProtocol } from './isInternalUrl';
 function addBaseUrl(siteUrl, baseUrl, url, { forcePrependBaseUrl = false, absolute = false } = {}) {
-    if (!url) {
-        return url;
-    }
-    // it never makes sense to add a base url to a local anchor url
-    if (url.startsWith('#')) {
-        return url;
-    }
-    // it never makes sense to add a base url to an url with a protocol
-    if (hasProtocol(url)) {
+    // It never makes sense to add base url to a local anchor url, or one with a
+    // protocol
+    if (!url || url.startsWith('#') || hasProtocol(url)) {
         return url;
     }
     if (forcePrependBaseUrl) {

package/lib/client/routeContext.js

@@ -19,7 +19,7 @@ function mergeContexts({ parent, value, }) {
     // TODO deep merge this
     const data = { ...parent.data, ...value?.data };
     return {
-        // nested routes are not supposed to override plugin attribute
+        // Nested routes are not supposed to override plugin attribute
         plugin: parent.plugin,
         data,
     };

package/lib/client/serverEntry.js

@@ -79,7 +79,7 @@ async function doRender(locals) {
     const metaAttributes = metaStrings.filter(Boolean);
     const { generatedFilesDir } = locals;
     const manifestPath = path.join(generatedFilesDir, 'client-manifest.json');
-    const manifest = JSON.parse(await fs.readFile(manifestPath, 'utf8'));
+    const manifest = await fs.readJSON(manifestPath);
     // Get all required assets for this particular page based on client
     // manifest information.
     const modulesToBeLoaded = [...manifest.entrypoints, ...Array.from(modules)];

package/lib/commands/deploy.js

@@ -89,8 +89,9 @@ This behavior can have SEO impacts and create relative link issues.
         shelljs_1.default.echo('Skipping deploy on a pull request.');
         shelljs_1.default.exit(0);
     }
-    // github.io indicates organization repos that deploy via default branch.
-    // All others use gh-pages. Organization deploys looks like:
+    // github.io indicates organization repos that deploy via default branch. All
+    // others use gh-pages (either case can be configured actually, but we can
+    // make educated guesses). Organization deploys look like:
     // - Git repo: https://github.com/<organization>/<organization>.github.io
     // - Site url: https://<organization>.github.io
     const isGitHubPagesOrganizationDeploy = projectName.includes('.github.io');

package/lib/commands/start.js

@@ -34,7 +34,7 @@ async function start(siteDir, cliOptions) {
             siteDir,
             customConfigFilePath: cliOptions.config,
             locale: cliOptions.locale,
-            localizePath: undefined, // should this be configurable?
+            localizePath: undefined, // Should this be configurable?
         });
     }
     // Process all related files as a prop.

package/lib/commands/swizzle/actions.js

@@ -32,7 +32,7 @@ async function eject({ siteDir, themePath, componentName, }) {
     const fromPath = path_1.default.join(themePath, componentName);
     const isDirectory = await isDir(fromPath);
     const globPattern = isDirectory
-        ? // do we really want to copy all components?
+        ? // Do we really want to copy all components?
             path_1.default.join(fromPath, '*')
         : `${fromPath}.*`;
     const globPatternPosix = (0, utils_1.posixPath)(globPattern);

package/lib/server/brokenLinks.js

@@ -52,7 +52,6 @@ function filterIntermediateRoutes(routesInput) {
 function getAllBrokenLinks({ allCollectedLinks, routes, }) {
     const filteredRoutes = filterIntermediateRoutes(routes);
     const allBrokenLinks = lodash_1.default.mapValues(allCollectedLinks, (pageLinks, pagePath) => getPageBrokenLinks({ pageLinks, pagePath, routes: filteredRoutes }));
-    // remove pages without any broken link
     return lodash_1.default.pickBy(allBrokenLinks, (brokenLinks) => brokenLinks.length > 0);
 }
 function getBrokenLinksErrorMessage(allBrokenLinks) {

package/lib/server/choosePort.js

@@ -14,37 +14,18 @@ const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const prompts_1 = tslib_1.__importDefault(require("prompts"));
 const execOptions = {
     encoding: 'utf8',
-    stdio: [
-        'pipe',
-        'pipe',
-        'ignore',
-    ],
+    stdio: [/* stdin */ 'pipe', /* stdout */ 'pipe', /* stderr */ 'ignore'],
 };
-// Clears console
 function clearConsole() {
     process.stdout.write(process.platform === 'win32' ? '\x1B[2J\x1B[0f' : '\x1B[2J\x1B[3J\x1B[H');
 }
-// Gets process id of what is on port
-function getProcessIdOnPort(port) {
-    return (0, child_process_1.execSync)(`lsof -i:${port} -P -t -sTCP:LISTEN`, execOptions)
-        .split('\n')[0]
-        .trim();
-}
-// Gets process command
-function getProcessCommand(processId) {
-    const command = (0, child_process_1.execSync)(`ps -o command -p ${processId} | sed -n 2p`, execOptions);
-    return command.replace(/\n$/, '');
-}
-// Gets directory of a process from its process id
-function getDirectoryOfProcessById(processId) {
-    return (0, child_process_1.execSync)(`lsof -p ${processId} | awk '$4=="cwd" {for (i=9; i<=NF; i++) printf "%s ", $i}'`, execOptions).trim();
-}
-// Gets process on port
 function getProcessForPort(port) {
     try {
-        const processId = getProcessIdOnPort(port);
-        const directory = getDirectoryOfProcessById(processId);
-        const command = getProcessCommand(processId);
+        const processId = (0, child_process_1.execSync)(`lsof -i:${port} -P -t -sTCP:LISTEN`, execOptions)
+            .split('\n')[0]
+            .trim();
+        const directory = (0, child_process_1.execSync)(`lsof -p ${processId} | awk '$4=="cwd" {for (i=9; i<=NF; i++) printf "%s ", $i}'`, execOptions).trim();
+        const command = (0, child_process_1.execSync)(`ps -o command -p ${processId} | sed -n 2p`, execOptions).replace(/\n$/, '');
         return logger_1.default.interpolate `code=${command} subdue=${`(pid ${processId})`} in path=${directory}`;
     }
     catch {

package/lib/server/index.js

@@ -99,8 +99,8 @@ export default ${JSON.stringify(siteConfig, null, 2)};
 `);
     const genClientModules = (0, utils_1.generate)(generatedFilesDir, 'client-modules.js', `export default [
 ${clientModules
-        // import() is async so we use require() because client modules can have
-        // CSS and the order matters for loading CSS.
+        // Use `require()` because `import()` is async but client modules can have CSS
+        // and the order matters for loading CSS.
         .map((clientModule) => `  require('${(0, utils_1.escapePath)(clientModule)}'),`)
         .join('\n')}
 ];

package/lib/server/plugins/index.js

@@ -67,7 +67,7 @@ async function loadPlugins(context) {
             return;
         }
         const pluginId = plugin.options.id;
-        // plugins data files are namespaced by pluginName/pluginId
+        // Plugins data files are namespaced by pluginName/pluginId
         const dataDir = path_1.default.join(context.generatedFilesDir, plugin.name, pluginId);
         const pluginRouteContextModulePath = path_1.default.join(dataDir, `${(0, utils_1.docuHash)('pluginRouteContextModule')}.json`);
         const pluginRouteContext = {

package/lib/server/plugins/init.js

@@ -17,7 +17,7 @@ const utils_validation_1 = require("@docusaurus/utils-validation");
 const configs_1 = require("./configs");
 function getOptionValidationFunction(normalizedPluginConfig) {
     if (normalizedPluginConfig.pluginModule) {
-        // support both commonjs and ES modules
+        // Support both CommonJS and ES modules
         return (normalizedPluginConfig.pluginModule.module?.default?.validateOptions ??
             normalizedPluginConfig.pluginModule.module?.validateOptions);
     }
@@ -25,7 +25,7 @@ function getOptionValidationFunction(normalizedPluginConfig) {
 }
 function getThemeValidationFunction(normalizedPluginConfig) {
     if (normalizedPluginConfig.pluginModule) {
-        // support both commonjs and ES modules
+        // Support both CommonJS and ES modules
         return (normalizedPluginConfig.pluginModule.module.default?.validateThemeConfig ??
             normalizedPluginConfig.pluginModule.module.validateThemeConfig);
     }
@@ -41,7 +41,6 @@ async function initPlugins(context) {
     const pluginRequire = (0, module_1.createRequire)(context.siteConfigPath);
     const pluginConfigs = await (0, configs_1.loadPluginConfigs)(context);
     async function doGetPluginVersion(normalizedPluginConfig) {
-        // get plugin version
         if (normalizedPluginConfig.pluginModule?.path) {
             const pluginPath = pluginRequire.resolve(normalizedPluginConfig.pluginModule?.path);
             return (0, siteMetadata_1.getPluginVersion)(pluginPath, context.siteDir);

package/lib/server/routes.js

@@ -160,9 +160,8 @@ ${JSON.stringify(routeConfig)}`);
     res.routesChunkNames[`${routePath}-${routeHash}`] = {
         // Avoid clash with a prop called "component"
         ...genChunkNames({ __comp: component }, 'component', component, res),
-        ...(context
-            ? genChunkNames({ __context: context }, 'context', routePath, res)
-            : {}),
+        ...(context &&
+            genChunkNames({ __context: context }, 'context', routePath, res)),
         ...genChunkNames(modules, 'module', routePath, res),
     };
     return serializeRouteConfig({

package/lib/server/translations/translations.js

@@ -30,7 +30,7 @@ function ensureTranslationFileContent(content) {
 async function readTranslationFileContent(filePath) {
     if (await fs_extra_1.default.pathExists(filePath)) {
         try {
-            const content = JSON.parse(await fs_extra_1.default.readFile(filePath, 'utf8'));
+            const content = await fs_extra_1.default.readJSON(filePath);
             ensureTranslationFileContent(content);
             return content;
         }
@@ -55,7 +55,7 @@ function mergeTranslationFileContent({ existingContent = {}, newContent, options
             message: options.override
                 ? message
                 : existingContent[key]?.message ?? message,
-            description, // description
+            description,
         };
     });
     return result;
@@ -79,7 +79,7 @@ Maybe you should remove them? ${unknownKeys}`;
         await fs_extra_1.default.outputFile(filePath, `${JSON.stringify(mergedContent, null, 2)}\n`);
     }
 }
-// should we make this configurable?
+// Should we make this configurable?
 function getTranslationsLocaleDirPath(context) {
     return path_1.default.join(context.siteDir, utils_1.I18N_DIR_NAME, context.locale);
 }
@@ -141,7 +141,7 @@ async function localizePluginTranslationFile({ siteDir, plugin, locale, translat
     });
     const localizedContent = await readTranslationFileContent(filePath);
     if (localizedContent) {
-        // localized messages "override" default unlocalized messages
+        // Localized messages "override" default unlocalized messages
         return {
             path: translationFile.path,
             content: {

package/lib/webpack/base.js

@@ -18,11 +18,11 @@ const CSS_REGEX = /\.css$/i;
 const CSS_MODULE_REGEX = /\.module\.css$/i;
 exports.clientDir = path_1.default.join(__dirname, '..', 'client');
 const LibrariesToTranspile = [
-    'copy-text-to-clipboard', // contains optional catch binding, incompatible with recent versions of Edge
+    'copy-text-to-clipboard', // Contains optional catch binding, incompatible with recent versions of Edge
 ];
 const LibrariesToTranspileRegex = new RegExp(LibrariesToTranspile.map((libName) => `(node_modules/${libName})`).join('|'));
 function excludeJS(modulePath) {
-    // always transpile client dir
+    // Always transpile client dir
     if (modulePath.startsWith(exports.clientDir)) {
         return false;
     }
@@ -135,7 +135,7 @@ async function createBaseConfig(props, isServer, minify = true) {
                     // include [name] in the filenames
                     name: false,
                     cacheGroups: {
-                        // disable the built-in cacheGroups
+                        // Disable the built-in cacheGroups
                         default: false,
                         common: {
                             name: 'common',
@@ -206,7 +206,7 @@ async function createBaseConfig(props, isServer, minify = true) {
                 chunkFilename: isProd
                     ? 'assets/css/[name].[contenthash:8].css'
                     : '[name].css',
-                // remove css order warnings if css imports are not sorted
+                // Remove css order warnings if css imports are not sorted
                 // alphabetically. See https://github.com/webpack-contrib/mini-css-extract-plugin/pull/422
                 // for more reasoning
                 ignoreOrder: true,

package/lib/webpack/client.js

@@ -17,7 +17,7 @@ async function createClientConfig(props, minify = true) {
     const isBuilding = process.argv[2] === 'build';
     const config = await (0, base_1.createBaseConfig)(props, false, minify);
     const clientConfig = (0, webpack_merge_1.default)(config, {
-        // useless, disabled on purpose (errors on existing sites with no
+        // Useless, disabled on purpose (errors on existing sites with no
         // browserslist config)
         // target: 'browserslist',
         entry: path_1.default.resolve(__dirname, '../client/clientEntry.js'),

package/lib/webpack/utils.js

@@ -143,7 +143,7 @@ function applyConfigureWebpack(configureWebpack, config, isServer, jsLoader, con
 }
 exports.applyConfigureWebpack = applyConfigureWebpack;
 function applyConfigurePostCss(configurePostCss, config) {
-    // not ideal heuristic but good enough for our use-case?
+    // Not ideal heuristic but good enough for our use-case?
     function isPostCssLoader(loader) {
         return !!loader?.options?.postcssOptions;
     }
@@ -176,7 +176,7 @@ function compile(config) {
                 }
                 reject(err);
             }
-            // let plugins consume all the stats
+            // Let plugins consume all the stats
             const errorsWarnings = stats?.toJson('errors-warnings');
             if (stats?.hasErrors()) {
                 reject(new Error('Failed to compile with errors.'));
@@ -266,7 +266,7 @@ function getMinimizer(useSimpleCssMinifier = false) {
             parallel: getTerserParallel(),
             terserOptions: {
                 parse: {
-                    // we want uglify-js to parse ecma 8 code. However, we don't want it
+                    // We want uglify-js to parse ecma 8 code. However, we don't want it
                     // to apply any minification steps that turns valid ecma 5 code
                     // into invalid ecma 5 code. This is why the 'compress' and 'output'
                     // sections only apply transformations that are ecma 5 safe

package/package.json

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