@docusaurus/core 0.0.0-4943 → 0.0.0-4946

package/lib/commands/build.d.ts

@@ -4,5 +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 { BuildCLIOptions } from '@docusaurus/types';
+import { type LoadContextOptions } from '../server';
+export declare type BuildCLIOptions = Pick<LoadContextOptions, 'config' | 'locale' | 'outDir'> & {
+    bundleAnalyzer?: boolean;
+    minify?: boolean;
+};
 export declare function build(siteDir: string, cliOptions: Partial<BuildCLIOptions>, forceTerminate?: boolean): Promise<string>;

package/lib/commands/build.js

@@ -49,8 +49,8 @@ forceTerminate = true) {
     }
     const context = await (0, server_1.loadContext)({
         siteDir,
-        customOutDir: cliOptions.outDir,
-        customConfigFilePath: cliOptions.config,
+        outDir: cliOptions.outDir,
+        config: cliOptions.config,
         locale: cliOptions.locale,
         localizePath: cliOptions.locale ? false : undefined,
     });
@@ -82,8 +82,8 @@ async function buildLocale({ siteDir, locale, cliOptions, forceTerminate, isLast
     logger_1.default.info `name=${`[${locale}]`} Creating an optimized production build...`;
     const props = await (0, server_1.load)({
         siteDir,
-        customOutDir: cliOptions.outDir,
-        customConfigFilePath: cliOptions.config,
+        outDir: cliOptions.outDir,
+        config: cliOptions.config,
         locale,
         localizePath: cliOptions.locale ? false : undefined,
     });

package/lib/commands/deploy.d.ts

@@ -4,5 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { BuildCLIOptions } from '@docusaurus/types';
-export declare function deploy(siteDir: string, cliOptions: Partial<BuildCLIOptions>): Promise<void>;
+import { type LoadContextOptions } from '../server';
+export declare type DeployCLIOptions = Pick<LoadContextOptions, 'config' | 'locale' | 'outDir'> & {
+    skipBuild?: boolean;
+};
+export declare function deploy(siteDir: string, cliOptions: Partial<DeployCLIOptions>): Promise<void>;

package/lib/commands/deploy.js

@@ -37,8 +37,8 @@ function shellExecLog(cmd) {
 async function deploy(siteDir, cliOptions) {
     const { outDir, siteConfig, siteConfigPath } = await (0, server_1.loadContext)({
         siteDir,
-        customConfigFilePath: cliOptions.config,
-        customOutDir: cliOptions.outDir,
+        config: cliOptions.config,
+        outDir: cliOptions.outDir,
     });
     if (typeof siteConfig.trailingSlash === 'undefined') {
         logger_1.default.warn(`When deploying to GitHub Pages, it is better to use an explicit "trailingSlash" site config.

package/lib/commands/serve.d.ts

@@ -4,5 +4,10 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { ServeCLIOptions } from '@docusaurus/types';
+import type { LoadContextOptions } from '../server';
+import { type HostPortOptions } from '../server/getHostPort';
+export declare type ServeCLIOptions = HostPortOptions & Pick<LoadContextOptions, 'config'> & {
+    dir?: string;
+    build?: boolean;
+};
 export declare function serve(siteDir: string, cliOptions: Partial<ServeCLIOptions>): Promise<void>;

package/lib/commands/serve.js

@@ -14,7 +14,7 @@ const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const path_1 = tslib_1.__importDefault(require("path"));
 const config_1 = require("../server/config");
 const build_1 = require("./build");
-const commandUtils_1 = require("./commandUtils");
+const getHostPort_1 = require("../server/getHostPort");
 const utils_1 = require("@docusaurus/utils");
 async function serve(siteDir, cliOptions) {
     const buildDir = cliOptions.dir ?? utils_1.DEFAULT_BUILD_DIR_NAME;
@@ -25,8 +25,7 @@ async function serve(siteDir, cliOptions) {
             outDir: dir,
         }, false);
     }
-    const host = (0, commandUtils_1.getCLIOptionHost)(cliOptions.host);
-    const port = await (0, commandUtils_1.getCLIOptionPort)(cliOptions.port, host);
+    const { host, port } = await (0, getHostPort_1.getHostPort)(cliOptions);
     if (port === null) {
         process.exit();
     }

package/lib/commands/start.d.ts

@@ -4,5 +4,11 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { StartCLIOptions } from '@docusaurus/types';
+import { type LoadContextOptions } from '../server';
+import { type HostPortOptions } from '../server/getHostPort';
+export declare type StartCLIOptions = HostPortOptions & Pick<LoadContextOptions, 'locale' | 'config'> & {
+    hotOnly?: boolean;
+    open?: boolean;
+    poll?: boolean | number;
+};
 export declare function start(siteDir: string, cliOptions: Partial<StartCLIOptions>): Promise<void>;

package/lib/commands/start.js

@@ -23,7 +23,7 @@ const webpack_merge_1 = tslib_1.__importDefault(require("webpack-merge"));
 const server_1 = require("../server");
 const client_1 = tslib_1.__importDefault(require("../webpack/client"));
 const utils_2 = require("../webpack/utils");
-const commandUtils_1 = require("./commandUtils");
+const getHostPort_1 = require("../server/getHostPort");
 const translations_1 = require("../server/translations/translations");
 async function start(siteDir, cliOptions) {
     process.env.NODE_ENV = 'development';
@@ -32,7 +32,7 @@ async function start(siteDir, cliOptions) {
     function loadSite() {
         return (0, server_1.load)({
             siteDir,
-            customConfigFilePath: cliOptions.config,
+            config: cliOptions.config,
             locale: cliOptions.locale,
             localizePath: undefined, // Should this be configurable?
         });
@@ -40,8 +40,7 @@ async function start(siteDir, cliOptions) {
     // Process all related files as a prop.
     const props = await loadSite();
     const protocol = process.env.HTTPS === 'true' ? 'https' : 'http';
-    const host = (0, commandUtils_1.getCLIOptionHost)(cliOptions.host);
-    const port = await (0, commandUtils_1.getCLIOptionPort)(cliOptions.port, host);
+    const { host, port } = await (0, getHostPort_1.getHostPort)(cliOptions);
     if (port === null) {
         process.exit();
     }

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

@@ -5,9 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { SwizzleAction, SwizzleComponentConfig } from '@docusaurus/types';
-import type { SwizzleOptions } from './common';
+import type { SwizzleCLIOptions } from './common';
 export declare const SwizzleActions: SwizzleAction[];
-export declare function getAction(componentConfig: SwizzleComponentConfig, options: Pick<SwizzleOptions, 'wrap' | 'eject'>): Promise<SwizzleAction>;
+export declare function getAction(componentConfig: SwizzleComponentConfig, options: Pick<SwizzleCLIOptions, 'wrap' | 'eject'>): Promise<SwizzleAction>;
 export declare type ActionParams = {
     siteDir: string;
     themePath: string;

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

@@ -4,7 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { InitializedPlugin, SwizzleAction, SwizzleActionStatus, NormalizedPluginConfig } from '@docusaurus/types';
+import type { NormalizedPluginConfig } from '../../server/plugins/configs';
+import type { InitializedPlugin, SwizzleAction, SwizzleActionStatus } from '@docusaurus/types';
 export declare const SwizzleActions: SwizzleAction[];
 export declare const SwizzleActionsStatuses: SwizzleActionStatus[];
 export declare const PartiallySafeHint: string;
@@ -20,13 +21,13 @@ export declare type SwizzlePlugin = {
 export declare type SwizzleContext = {
     plugins: SwizzlePlugin[];
 };
-export declare type SwizzleOptions = {
+export declare type SwizzleCLIOptions = {
     typescript: boolean;
     danger: boolean;
     list: boolean;
     wrap: boolean;
     eject: boolean;
 };
-export declare function normalizeOptions(options: Partial<SwizzleOptions>): SwizzleOptions;
+export declare function normalizeOptions(options: Partial<SwizzleCLIOptions>): SwizzleCLIOptions;
 export declare function findStringIgnoringCase(str: string, values: string[]): string | undefined;
 export declare function findClosestValue(str: string, values: string[], maxLevenshtein?: number): string | undefined;

package/lib/commands/swizzle/index.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 { SwizzleOptions } from './common';
-export declare function swizzle(siteDir: string, themeNameParam: string | undefined, componentNameParam: string | undefined, optionsParam: Partial<SwizzleOptions>): Promise<void>;
+import type { SwizzleCLIOptions } from './common';
+export declare function swizzle(siteDir: string, themeNameParam: string | undefined, componentNameParam: string | undefined, optionsParam: Partial<SwizzleCLIOptions>): Promise<void>;

package/lib/commands/writeTranslations.d.ts

@@ -4,8 +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 type { ConfigOptions } from '@docusaurus/types';
+import { type LoadContextOptions } from '../server';
 import { type WriteTranslationsOptions } from '../server/translations/translations';
-export declare function writeTranslations(siteDir: string, options: Partial<WriteTranslationsOptions & ConfigOptions & {
-    locale?: string;
-}>): Promise<void>;
+export declare type WriteTranslationsCLIOptions = Pick<LoadContextOptions, 'config' | 'locale'> & WriteTranslationsOptions;
+export declare function writeTranslations(siteDir: string, options: Partial<WriteTranslationsCLIOptions>): Promise<void>;

package/lib/commands/writeTranslations.js

@@ -50,7 +50,7 @@ async function writePluginTranslationFiles({ siteDir, plugin, locale, options, }
 async function writeTranslations(siteDir, options) {
     const context = await (0, server_1.loadContext)({
         siteDir,
-        customConfigFilePath: options.config,
+        config: options.config,
         locale: options.locale,
     });
     const plugins = await (0, init_1.initPlugins)(context);

package/lib/server/getHostPort.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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.
+ */
+export declare type HostPortOptions = {
+    host?: string;
+    port?: string;
+};
+export declare function getHostPort(options: HostPortOptions): Promise<{
+    host: string;
+    port: number | null;
+}>;

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

@@ -6,11 +6,12 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.choosePort = void 0;
+exports.getHostPort = void 0;
 const tslib_1 = require("tslib");
 const child_process_1 = require("child_process");
 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',
@@ -69,4 +70,10 @@ Would you like to run the app on another port instead?`),
         throw err;
     }
 }
-exports.choosePort = 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/index.d.ts

@@ -8,10 +8,10 @@ import type { LoadContext, Props } from '@docusaurus/types';
 export declare type LoadContextOptions = {
     /** Usually the CWD; can be overridden with command argument. */
     siteDir: string;
-    /** Can be customized with `--out-dir` option */
-    customOutDir?: string;
-    /** Can be customized with `--config` option */
-    customConfigFilePath?: 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;
     /**

package/lib/server/index.js

@@ -26,7 +26,7 @@ const translations_1 = require("./translations/translations");
  * to plugin constructors.
  */
 async function loadContext(options) {
-    const { siteDir, customOutDir, locale, customConfigFilePath } = options;
+    const { siteDir, outDir: baseOutDir = utils_1.DEFAULT_BUILD_DIR_NAME, locale, config: customConfigFilePath, } = options;
     const generatedFilesDir = path_1.default.resolve(siteDir, utils_1.GENERATED_FILES_DIR_NAME);
     const { siteConfig: initialSiteConfig, siteConfigPath } = await (0, config_1.loadSiteConfig)({
         siteDir,
@@ -40,7 +40,7 @@ async function loadContext(options) {
         pathType: 'url',
     });
     const outDir = (0, utils_1.localizePath)({
-        path: path_1.default.resolve(siteDir, customOutDir ?? utils_1.DEFAULT_BUILD_DIR_NAME),
+        path: path_1.default.resolve(siteDir, baseOutDir),
         i18n,
         options,
         pathType: 'fs',

package/lib/server/plugins/configs.d.ts

@@ -4,7 +4,43 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { LoadContext, NormalizedPluginConfig } from '@docusaurus/types';
+import type { LoadContext, PluginModule, PluginOptions } from '@docusaurus/types';
+declare type ImportedPluginModule = PluginModule & {
+    default?: PluginModule;
+};
+export declare type NormalizedPluginConfig = {
+    /**
+     * The default export of the plugin module, or alternatively, what's provided
+     * in the config file as inline plugins. Note that if a file is like:
+     *
+     * ```ts
+     * export default plugin() {...}
+     * export validateOptions() {...}
+     * ```
+     *
+     * Then the static methods may not exist here. `pluginModule.module` will
+     * always take priority.
+     */
+    plugin: PluginModule;
+    /** Options as they are provided in the config, not validated yet. */
+    options: PluginOptions;
+    /** Only available when a string is provided in config. */
+    pluginModule?: {
+        /**
+         * Raw module name as provided in the config. Shorthands have been resolved,
+         * so at least it's directly `require.resolve`able.
+         */
+        path: string;
+        /** Whatever gets imported with `require`. */
+        module: ImportedPluginModule;
+    };
+    /**
+     * Different from `pluginModule.path`, this one is always an absolute path,
+     * used to resolve relative paths returned from lifecycles. If it's an inline
+     * plugin, it will be path to the config file.
+     */
+    entryPath: string;
+};
 /**
  * Reads the site config's `presets`, `themes`, and `plugins`, imports them, and
  * normalizes the return value. Plugin configs are ordered, mostly for theme
@@ -12,3 +48,4 @@ import type { LoadContext, NormalizedPluginConfig } from '@docusaurus/types';
  * are the lowest.
  */
 export declare function loadPluginConfigs(context: LoadContext): Promise<NormalizedPluginConfig[]>;
+export {};

package/lib/webpack/aliases/index.d.ts

@@ -4,7 +4,13 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { ThemeAliases, LoadedPlugin } from '@docusaurus/types';
+import type { LoadedPlugin } from '@docusaurus/types';
+/**
+ * Aliases used for Webpack resolution (useful for implementing swizzling)
+ */
+declare type ThemeAliases = {
+    [alias: string]: string;
+};
 /**
  * Order of Webpack aliases is important because one alias can shadow another.
  * This ensures `@theme/NavbarItem` alias is after
@@ -25,3 +31,4 @@ export declare function loadThemeAliases({ siteDir, plugins, }: {
  * aliases instead.
  */
 export declare function loadDocusaurusAliases(): Promise<ThemeAliases>;
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "0.0.0-4943",
+  "version": "0.0.0-4946",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -41,13 +41,13 @@
     "@babel/runtime": "^7.17.9",
     "@babel/runtime-corejs3": "^7.17.9",
     "@babel/traverse": "^7.17.10",
-    "@docusaurus/cssnano-preset": "0.0.0-4943",
-    "@docusaurus/logger": "0.0.0-4943",
-    "@docusaurus/mdx-loader": "0.0.0-4943",
+    "@docusaurus/cssnano-preset": "0.0.0-4946",
+    "@docusaurus/logger": "0.0.0-4946",
+    "@docusaurus/mdx-loader": "0.0.0-4946",
     "@docusaurus/react-loadable": "5.5.2",
-    "@docusaurus/utils": "0.0.0-4943",
-    "@docusaurus/utils-common": "0.0.0-4943",
-    "@docusaurus/utils-validation": "0.0.0-4943",
+    "@docusaurus/utils": "0.0.0-4946",
+    "@docusaurus/utils-common": "0.0.0-4946",
+    "@docusaurus/utils-validation": "0.0.0-4946",
     "@slorber/static-site-generator-webpack-plugin": "^4.0.4",
     "@svgr/webpack": "^6.2.1",
     "autoprefixer": "^10.4.5",
@@ -104,8 +104,8 @@
     "webpackbar": "^5.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4943",
-    "@docusaurus/types": "0.0.0-4943",
+    "@docusaurus/module-type-aliases": "0.0.0-4946",
+    "@docusaurus/types": "0.0.0-4946",
     "@types/detect-port": "^1.3.2",
     "@types/react-dom": "^18.0.3",
     "@types/react-router-config": "^5.0.6",
@@ -125,5 +125,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "bd2b2328da8f23956a71e966ace97eb7cf951e7f"
+  "gitHead": "01073ce535af35aa33c1b221e2adb99ac993d589"
 }

package/lib/commands/commandUtils.d.ts

@@ -1,9 +0,0 @@
-/**
- * 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 { HostPortCLIOptions } from '@docusaurus/types';
-export declare function getCLIOptionHost(hostOption: HostPortCLIOptions['host']): string;
-export declare function getCLIOptionPort(portOption: HostPortCLIOptions['port'], host: string): Promise<number | null>;

package/lib/commands/commandUtils.js

@@ -1,20 +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.getCLIOptionPort = exports.getCLIOptionHost = void 0;
-const choosePort_1 = require("../server/choosePort");
-const utils_1 = require("@docusaurus/utils");
-function getCLIOptionHost(hostOption) {
-    return hostOption ?? 'localhost';
-}
-exports.getCLIOptionHost = getCLIOptionHost;
-async function getCLIOptionPort(portOption, host) {
-    const basePort = portOption ? parseInt(portOption, 10) : utils_1.DEFAULT_PORT;
-    return (0, choosePort_1.choosePort)(host, basePort);
-}
-exports.getCLIOptionPort = getCLIOptionPort;

package/lib/server/choosePort.d.ts

@@ -1,12 +0,0 @@
-/**
- * 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.
- */
-/**
- * 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.
- */
-export declare function choosePort(host: string, defaultPort: number): Promise<number | null>;