@docusaurus/core 4.0.0-canary-6965 → 4.0.0-canary-6967

package/lib/commands/cli.js

@@ -112,9 +112,9 @@ async function createCLIProgram({ cli, cliArgs, siteDir, config, }) {
         .option('--no-open', 'do not open page in the browser (default: false)')
         .option('--poll [interval]', 'use polling rather than watching for reload (default: false). Can specify a poll interval in milliseconds', normalizePollValue)
         .option('--no-minify', 'build website without minimizing JS bundles (default: false)')
-        .option('--https', 'serve the dev site over HTTPS using a self-signed cert (default: false). Preferred over the HTTPS=true env var. Implied when both --ssl-cert and --ssl-key are provided.')
-        .option('--ssl-cert <path>', 'path to a TLS certificate file (implies HTTPS). Preferred over the SSL_CRT_FILE env var; CLI takes precedence if both are set.')
-        .option('--ssl-key <path>', 'path to a TLS private key file (implies HTTPS). Preferred over the SSL_KEY_FILE env var; CLI takes precedence if both are set.')
+        .option('--https', 'serve the dev site over HTTPS using a self-signed cert (default: false). Implied when both --ssl-cert and --ssl-key are provided. Takes precedence over the DOCUSAURUS_HTTPS env var.')
+        .option('--ssl-cert <path>', 'path to a TLS certificate file (implies HTTPS). Takes precedence over the DOCUSAURUS_SSL_CRT_FILE env var.')
+        .option('--ssl-key <path>', 'path to a TLS private key file (implies HTTPS). Takes precedence over the DOCUSAURUS_SSL_KEY_FILE env var.')
         .action(start_1.start);
     cli
         .command('serve [siteDir]')

package/lib/commands/start/utils.d.ts

@@ -5,16 +5,21 @@
  * LICENSE file in the root directory of this source tree.
  */
 import _ from 'lodash';
+import { type HttpsConfig } from '../../webpack/utils/getHttpsConfig';
 import type { StartCLIOptions } from './start';
 import type { LoadedPlugin, RouterType } from '@docusaurus/types';
 export type OpenUrlContext = {
     host: string;
     port: number;
+    httpsConfig: HttpsConfig;
     getOpenUrl: ({ baseUrl, router, }: {
         baseUrl: string;
         router: RouterType;
     }) => string;
 };
+export declare function createOpenUrlContext({ cliOptions, }: {
+    cliOptions: StartCLIOptions;
+}): Promise<OpenUrlContext>;
 type StartParams = {
     siteDirParam: string;
     cliOptions: Partial<StartCLIOptions>;

package/lib/commands/start/utils.js

@@ -6,6 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.createOpenUrlContext = createOpenUrlContext;
 exports.createReloadableSite = createReloadableSite;
 const tslib_1 = require("tslib");
 const node_url_1 = tslib_1.__importDefault(require("node:url"));
@@ -14,6 +15,7 @@ const utils_1 = require("@docusaurus/utils");
 const logger_1 = tslib_1.__importStar(require("@docusaurus/logger"));
 const fs_1 = require("@docusaurus/fs");
 const getHostPort_1 = require("../../server/getHostPort");
+const getHttpsConfig_1 = tslib_1.__importDefault(require("../../webpack/utils/getHttpsConfig"));
 const site_1 = require("../../server/site");
 const pluginsUtils_1 = require("../../server/plugins/pluginsUtils");
 // This code was historically in CRA/react-dev-utils (deprecated in 2025)
@@ -32,7 +34,12 @@ function getOpenUrlOrigin(protocol, host, port) {
     return localUrlForBrowser;
 }
 async function createOpenUrlContext({ cliOptions, }) {
-    const protocol = process.env.HTTPS === 'true' ? 'https' : 'http';
+    const httpsConfig = await (0, getHttpsConfig_1.default)({
+        https: cliOptions.https,
+        sslCert: cliOptions.sslCert,
+        sslKey: cliOptions.sslKey,
+    });
+    const protocol = httpsConfig ? 'https' : 'http';
     const { host, port } = await (0, getHostPort_1.getHostPort)(cliOptions);
     if (port === null) {
         return process.exit();
@@ -44,7 +51,7 @@ async function createOpenUrlContext({ cliOptions, }) {
             baseUrl,
         ]);
     };
-    return { host, port, getOpenUrl };
+    return { host, port, httpsConfig, getOpenUrl };
 }
 async function createLoadSiteParams({ siteDirParam, cliOptions, }) {
     const siteDir = await (0, fs_1.realpath)(siteDirParam);

package/lib/commands/start/webpack.js

@@ -13,7 +13,6 @@ const webpack_merge_1 = tslib_1.__importDefault(require("webpack-merge"));
 const bundler_1 = require("@docusaurus/bundler");
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const watcher_1 = require("./watcher");
-const getHttpsConfig_1 = tslib_1.__importDefault(require("../../webpack/utils/getHttpsConfig"));
 const configure_1 = require("../../webpack/configure");
 const client_1 = require("../../webpack/client");
 // E2E_TEST=true docusaurus start
@@ -36,14 +35,9 @@ function registerWebpackE2ETestHook(compiler) {
         }
     });
 }
-async function createDevServerConfig({ cliOptions, props, host, port, }) {
+function createDevServerConfig({ cliOptions, props, host, port, httpsConfig, }) {
     const { baseUrl, siteDir, siteConfig } = props;
     const pollingOptions = (0, watcher_1.createPollingOptions)(cliOptions);
-    const httpsConfig = await (0, getHttpsConfig_1.default)({
-        https: cliOptions.https,
-        sslCert: cliOptions.sslCert,
-        sslKey: cliOptions.sslKey,
-    });
     // https://webpack.js.org/configuration/dev-server
     return {
         hot: cliOptions.hotOnly ? 'only' : true,
@@ -122,11 +116,12 @@ async function createWebpackDevServer({ props, cliOptions, openUrlContext, }) {
     });
     const compiler = props.currentBundler.instance(config);
     registerWebpackE2ETestHook(compiler);
-    const defaultDevServerConfig = await createDevServerConfig({
+    const defaultDevServerConfig = createDevServerConfig({
         cliOptions,
         props,
         host: openUrlContext.host,
         port: openUrlContext.port,
+        httpsConfig: openUrlContext.httpsConfig,
     });
     // Allow plugin authors to customize/override devServer config
     const devServerConfig = (0, webpack_merge_1.default)([defaultDevServerConfig, config.devServer].filter(Boolean));

package/lib/webpack/utils/getHttpsConfig.d.ts

@@ -9,8 +9,9 @@ type HttpsConfigOptions = {
     sslCert: string;
     sslKey: string;
 };
-export default function getHttpsConfig(options?: Partial<HttpsConfigOptions>): Promise<boolean | {
+export type HttpsConfig = boolean | {
     cert: Buffer;
     key: Buffer;
-}>;
+};
+export default function getHttpsConfig(options?: Partial<HttpsConfigOptions>): Promise<HttpsConfig>;
 export {};

package/lib/webpack/utils/getHttpsConfig.js

@@ -41,9 +41,6 @@ function getExplicitHttps(options) {
     return (options.https ??
         (typeof process.env.DOCUSAURUS_HTTPS !== 'undefined'
             ? process.env.DOCUSAURUS_HTTPS == 'true'
-            : undefined) ??
-        (typeof process.env.HTTPS !== 'undefined'
-            ? process.env.HTTPS == 'true'
             : undefined));
 }
 async function readCryptoFile(filepath, source) {
@@ -68,9 +65,6 @@ function getCert(options, cwd) {
     if (process.env.DOCUSAURUS_SSL_CRT_FILE) {
         return readCryptoFile(node_path_1.default.resolve(cwd, process.env.DOCUSAURUS_SSL_CRT_FILE), 'env DOCUSAURUS_SSL_CRT_FILE');
     }
-    if (process.env.SSL_CRT_FILE) {
-        return readCryptoFile(node_path_1.default.resolve(cwd, process.env.SSL_CRT_FILE), 'env SSL_CRT_FILE');
-    }
     return null;
 }
 function getKeyFile(options, cwd) {
@@ -80,9 +74,6 @@ function getKeyFile(options, cwd) {
     if (process.env.DOCUSAURUS_SSL_KEY_FILE) {
         return readCryptoFile(node_path_1.default.resolve(cwd, process.env.DOCUSAURUS_SSL_KEY_FILE), 'env DOCUSAURUS_SSL_KEY_FILE');
     }
-    if (process.env.SSL_KEY_FILE) {
-        return readCryptoFile(node_path_1.default.resolve(cwd, process.env.SSL_KEY_FILE), 'env SSL_KEY_FILE');
-    }
     return null;
 }
 function ensureCertKeyBothProvided(cert, key) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "4.0.0-canary-6965",
+  "version": "4.0.0-canary-6967",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -27,15 +27,15 @@
     "url": "https://github.com/facebook/docusaurus/issues"
   },
   "dependencies": {
-    "@docusaurus/babel": "4.0.0-canary-6965",
-    "@docusaurus/bundler": "4.0.0-canary-6965",
-    "@docusaurus/fs": "4.0.0-canary-6965",
-    "@docusaurus/glob": "4.0.0-canary-6965",
-    "@docusaurus/logger": "4.0.0-canary-6965",
-    "@docusaurus/mdx-loader": "4.0.0-canary-6965",
-    "@docusaurus/utils": "4.0.0-canary-6965",
-    "@docusaurus/utils-common": "4.0.0-canary-6965",
-    "@docusaurus/utils-validation": "4.0.0-canary-6965",
+    "@docusaurus/babel": "4.0.0-canary-6967",
+    "@docusaurus/bundler": "4.0.0-canary-6967",
+    "@docusaurus/fs": "4.0.0-canary-6967",
+    "@docusaurus/glob": "4.0.0-canary-6967",
+    "@docusaurus/logger": "4.0.0-canary-6967",
+    "@docusaurus/mdx-loader": "4.0.0-canary-6967",
+    "@docusaurus/utils": "4.0.0-canary-6967",
+    "@docusaurus/utils-common": "4.0.0-canary-6967",
+    "@docusaurus/utils-validation": "4.0.0-canary-6967",
     "@rspack/core": "^2.2.3",
     "@rspack/dev-server": "^2.2.1",
     "boxen": "^9.0.0",
@@ -68,8 +68,8 @@
     "webpack-merge": "^6.0.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "4.0.0-canary-6965",
-    "@docusaurus/types": "4.0.0-canary-6965",
+    "@docusaurus/module-type-aliases": "4.0.0-canary-6967",
+    "@docusaurus/types": "4.0.0-canary-6967",
     "@total-typescript/shoehorn": "^0.1.2",
     "@types/escape-html": "^1.0.4",
     "@types/history": "^4.7.11",