@docusaurus/core 2.0.0-beta.16 → 2.0.0-beta.19

package/lib/{choosePort.js → server/getHostPort.js}

@@ -6,53 +6,27 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getHostPort = void 0;
 const tslib_1 = require("tslib");
-/**
- * This feature was heavily inspired by create-react-app and
- * uses many of the same utility functions to implement it.
- */
 const child_process_1 = require("child_process");
-const detect_port_1 = (0, tslib_1.__importDefault)(require("detect-port"));
-const is_root_1 = (0, tslib_1.__importDefault)(require("is-root"));
-const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
-const prompts_1 = (0, tslib_1.__importDefault)(require("prompts"));
-const isInteractive = process.stdout.isTTY;
+const detect_port_1 = tslib_1.__importDefault(require("detect-port"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+const utils_1 = require("@docusaurus/utils");
+const prompts_1 = tslib_1.__importDefault(require("prompts"));
 const execOptions = {
     encoding: 'utf8',
-    stdio: [
-        'pipe',
-        'pipe',
-        'ignore', // stderr
-    ],
+    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)
-        .toString()
-        .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.toString().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)
-        .toString()
-        .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 {
@@ -60,8 +34,9 @@ function getProcessForPort(port) {
     }
 }
 /**
- * Detects if program is running on port and prompts user
- * to choose another if port is already being used
+ * Detects if program is running on port, and prompts user to choose another if
+ * port is already being used. This feature was heavily inspired by
+ * create-react-app and uses many of the same utility functions to implement it.
  */
 async function choosePort(host, defaultPort) {
     try {
@@ -69,7 +44,9 @@ async function choosePort(host, defaultPort) {
         if (port === defaultPort) {
             return port;
         }
-        const message = process.platform !== 'win32' && defaultPort < 1024 && !(0, is_root_1.default)()
+        const isRoot = process.getuid?.() === 0;
+        const isInteractive = process.stdout.isTTY;
+        const message = process.platform !== 'win32' && defaultPort < 1024 && !isRoot
             ? `Admin permissions are required to run a server on a port below 1024.`
             : `Something is already running on port ${defaultPort}.`;
         if (!isInteractive) {
@@ -93,4 +70,10 @@ Would you like to run the app on another port instead?`),
         throw err;
     }
 }
-exports.default = choosePort;
+async function getHostPort(options) {
+    const host = options.host ?? 'localhost';
+    const basePort = options.port ? parseInt(options.port, 10) : utils_1.DEFAULT_PORT;
+    const port = await choosePort(host, basePort);
+    return { host, port };
+}
+exports.getHostPort = getHostPort;

package/lib/server/htmlTags.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 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.
+ */
+import type { Props, LoadedPlugin } from '@docusaurus/types';
+/**
+ * Runs the `injectHtmlTags` lifecycle, and aggregates all plugins' tags into
+ * directly render-able HTML markup.
+ */
+export declare function loadHtmlTags(plugins: LoadedPlugin[]): Pick<Props, 'headTags' | 'preBodyTags' | 'postBodyTags'>;

package/lib/server/htmlTags.js

@@ -0,0 +1,62 @@
+"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 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"));
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+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.`);
+    }
+    if (!html_tags_1.default.includes(val.tagName)) {
+        throw new Error(`Error loading ${JSON.stringify(val)}, "${val.tagName}" is not a valid HTML tag.`);
+    }
+}
+function htmlTagObjectToString(tag) {
+    assertIsHtmlTagObject(tag);
+    const isVoidTag = void_1.default.includes(tag.tagName);
+    const tagAttributes = tag.attributes ?? {};
+    const attributes = Object.keys(tagAttributes)
+        .map((attr) => {
+        const value = tagAttributes[attr];
+        if (typeof value === 'boolean') {
+            return value ? attr : undefined;
+        }
+        return `${attr}="${(0, escape_html_1.default)(value)}"`;
+    })
+        .filter((str) => Boolean(str));
+    const openingTag = `<${[tag.tagName].concat(attributes).join(' ')}>`;
+    const innerHTML = (!isVoidTag && tag.innerHTML) || '';
+    const closingTag = isVoidTag ? '' : `</${tag.tagName}>`;
+    return openingTag + innerHTML + closingTag;
+}
+function createHtmlTagsString(tags) {
+    return (Array.isArray(tags) ? tags : [tags])
+        .filter(Boolean)
+        .map((val) => (typeof val === 'string' ? val : htmlTagObjectToString(val)))
+        .join('\n');
+}
+/**
+ * Runs the `injectHtmlTags` lifecycle, and aggregates all plugins' tags into
+ * directly render-able HTML markup.
+ */
+function loadHtmlTags(plugins) {
+    const pluginHtmlTags = plugins.map((plugin) => plugin.injectHtmlTags?.({ content: plugin.content }) ?? {});
+    const tagTypes = ['headTags', 'preBodyTags', 'postBodyTags'];
+    return Object.fromEntries(lodash_1.default.zip(tagTypes, tagTypes.map((type) => pluginHtmlTags
+        .map((tags) => createHtmlTagsString(tags[type]))
+        .join('\n')
+        .trim())));
+}
+exports.loadHtmlTags = loadHtmlTags;

package/lib/server/i18n.d.ts

@@ -5,15 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { I18n, DocusaurusConfig, I18nLocaleConfig } from '@docusaurus/types';
+import type { LoadContextOptions } from './index';
 export declare function getDefaultLocaleConfig(locale: string): I18nLocaleConfig;
-export declare function loadI18n(config: DocusaurusConfig, options?: {
-    locale?: string;
-}): Promise<I18n>;
-export declare function localizePath({ pathType, path: originalPath, i18n, options, }: {
-    pathType: 'fs' | 'url';
-    path: string;
-    i18n: I18n;
-    options?: {
-        localizePath?: boolean;
-    };
-}): string;
+export declare function loadI18n(config: DocusaurusConfig, options: Pick<LoadContextOptions, 'locale'>): Promise<I18n>;

package/lib/server/i18n.js

@@ -6,12 +6,10 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.localizePath = exports.loadI18n = exports.getDefaultLocaleConfig = void 0;
+exports.loadI18n = exports.getDefaultLocaleConfig = void 0;
 const tslib_1 = require("tslib");
-const path_1 = (0, tslib_1.__importDefault)(require("path"));
-const utils_1 = require("@docusaurus/utils");
 const rtl_detect_1 = require("rtl-detect");
-const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 function getDefaultLocaleLabel(locale) {
     const languageName = new Intl.DisplayNames(locale, { type: 'language' }).of(locale);
     return (languageName.charAt(0).toLocaleUpperCase(locale) + languageName.substring(1));
@@ -21,13 +19,14 @@ function getDefaultLocaleConfig(locale) {
         label: getDefaultLocaleLabel(locale),
         direction: (0, rtl_detect_1.getLangDir)(locale),
         htmlLang: locale,
+        // If the locale name includes -u-ca-xxx the calendar will be defined
+        calendar: new Intl.Locale(locale).calendar ?? 'gregory',
     };
 }
 exports.getDefaultLocaleConfig = getDefaultLocaleConfig;
-async function loadI18n(config, options = {}) {
-    var _a;
+async function loadI18n(config, options) {
     const { i18n: i18nConfig } = config;
-    const currentLocale = (_a = options.locale) !== null && _a !== void 0 ? _a : i18nConfig.defaultLocale;
+    const currentLocale = options.locale ?? i18nConfig.defaultLocale;
     if (!i18nConfig.locales.includes(currentLocale)) {
         logger_1.default.warn `The locale name=${currentLocale} was not found in your site configuration: Available locales are: ${i18nConfig.locales}
 Note: Docusaurus only support running one locale at a time.`;
@@ -41,7 +40,7 @@ Note: Docusaurus only support running one locale at a time.`;
             ...i18nConfig.localeConfigs[locale],
         };
     }
-    const localeConfigs = locales.reduce((acc, locale) => ({ ...acc, [locale]: getLocaleConfig(locale) }), {});
+    const localeConfigs = Object.fromEntries(locales.map((locale) => [locale, getLocaleConfig(locale)]));
     return {
         defaultLocale: i18nConfig.defaultLocale,
         locales,
@@ -50,23 +49,3 @@ Note: Docusaurus only support running one locale at a time.`;
     };
 }
 exports.loadI18n = loadI18n;
-function localizePath({ pathType, path: originalPath, i18n, options = {}, }) {
-    var _a;
-    const shouldLocalizePath = 
-    // By default, we don't localize the path of defaultLocale
-    (_a = options.localizePath) !== null && _a !== void 0 ? _a : i18n.currentLocale !== i18n.defaultLocale;
-    if (!shouldLocalizePath) {
-        return originalPath;
-    }
-    // FS paths need special care, for Windows support
-    if (pathType === 'fs') {
-        return path_1.default.join(originalPath, i18n.currentLocale);
-    }
-    // Url paths; add a trailing slash so it's a valid base URL
-    if (pathType === 'url') {
-        return (0, utils_1.normalizeUrl)([originalPath, i18n.currentLocale, '/']);
-    }
-    // should never happen
-    throw new Error(`Unhandled path type "${pathType}".`);
-}
-exports.localizePath = localizePath;

package/lib/server/index.d.ts

@@ -4,20 +4,35 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { DocusaurusConfig, LoadContext, PluginConfig, Props } from '@docusaurus/types';
+import type { LoadContext, Props } from '@docusaurus/types';
 export declare type LoadContextOptions = {
-    customOutDir?: string;
-    customConfigFilePath?: string;
+    /** Usually the CWD; can be overridden with command argument. */
+    siteDir: string;
+    /** Custom output directory. Can be customized with `--out-dir` option */
+    outDir?: string;
+    /** Custom config path. Can be customized with `--config` option */
+    config?: string;
+    /** Default is `i18n.defaultLocale` */
     locale?: string;
+    /**
+     * `true` means the paths will have the locale prepended; `false` means they
+     * won't (useful for `yarn build -l zh-Hans` where the output should be
+     * emitted into `build/` instead of `build/zh-Hans/`); `undefined` is like the
+     * "smart" option where only non-default locale paths are localized
+     */
     localizePath?: boolean;
 };
-export declare function loadSiteConfig({ siteDir, customConfigFilePath, }: {
-    siteDir: string;
-    customConfigFilePath?: string;
-}): Promise<{
-    siteConfig: DocusaurusConfig;
-    siteConfigPath: string;
-}>;
-export declare function loadContext(siteDir: string, options?: LoadContextOptions): Promise<LoadContext>;
-export declare function loadPluginConfigs(context: LoadContext): Promise<PluginConfig[]>;
-export declare function load(siteDir: string, options?: LoadContextOptions): Promise<Props>;
+/**
+ * Loading context is the very first step in site building. Its options are
+ * directly acquired from CLI options. It mainly loads `siteConfig` and the i18n
+ * context (which includes code translations). The `LoadContext` will be passed
+ * to plugin constructors.
+ */
+export declare function loadContext(options: LoadContextOptions): Promise<LoadContext>;
+/**
+ * This is the crux of the Docusaurus server-side. It reads everything it needs—
+ * code translations, config file, plugin modules... Plugins then use their
+ * lifecycles to generate content and other data. It is side-effect-ful because
+ * it generates temp files in the `.docusaurus` folder for the bundler.
+ */
+export declare function load(options: LoadContextOptions): Promise<Props>;