@docusaurus/core 0.0.0-5061 → 0.0.0-5066

package/bin/docusaurus.mjs

@@ -148,6 +148,10 @@ cli
   .option('-p, --port <port>', 'use specified port (default: 3000)')
   .option('--build', 'build website before serving (default: false)')
   .option('-h, --host <host>', 'use specified host (default: localhost)')
+  .option(
+    '--no-open',
+    'do not open page in the browser (default: false, or true in CI)',
+  )
   .action(async (siteDir, options) =>
     serve(await resolveDir(siteDir), options),
   );

package/lib/commands/serve.d.ts

@@ -9,5 +9,6 @@ import type { LoadContextOptions } from '../server';
 export declare type ServeCLIOptions = HostPortOptions & Pick<LoadContextOptions, 'config'> & {
     dir?: string;
     build?: boolean;
+    open?: boolean;
 };
 export declare function serve(siteDir: string, cliOptions: Partial<ServeCLIOptions>): Promise<void>;

package/lib/commands/serve.js

@@ -13,6 +13,7 @@ const path_1 = tslib_1.__importDefault(require("path"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_1 = require("@docusaurus/utils");
 const serve_handler_1 = tslib_1.__importDefault(require("serve-handler"));
+const openBrowser_1 = tslib_1.__importDefault(require("react-dev-utils/openBrowser"));
 const config_1 = require("../server/config");
 const build_1 = require("./build");
 const getHostPort_1 = require("../server/getHostPort");
@@ -53,7 +54,11 @@ async function serve(siteDir, cliOptions) {
             directoryListing: false,
         });
     });
-    logger_1.default.success `Serving path=${buildDir} directory at: url=${servingUrl + baseUrl}`;
+    const url = servingUrl + baseUrl;
+    logger_1.default.success `Serving path=${buildDir} directory at: url=${url}`;
     server.listen(port);
+    if (cliOptions.open && !process.env.CI) {
+        (0, openBrowser_1.default)(url);
+    }
 }
 exports.serve = serve;

package/lib/server/config.js

@@ -11,10 +11,25 @@ const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const import_fresh_1 = tslib_1.__importDefault(require("import-fresh"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_1 = require("@docusaurus/utils");
 const configValidation_1 = require("./configValidation");
+async function findConfig(siteDir) {
+    // We could support .mjs, .ts, etc. in the future
+    const candidates = ['.js', '.cjs'].map((ext) => utils_1.DEFAULT_CONFIG_FILE_NAME + ext);
+    const configPath = await (0, utils_1.findAsyncSequential)(candidates.map((file) => path_1.default.join(siteDir, file)), fs_extra_1.default.pathExists);
+    if (!configPath) {
+        logger_1.default.error('No config file found.');
+        logger_1.default.info `Expected one of:${candidates}
+You can provide a custom config path with the code=${'--config'} option.`;
+        throw new Error();
+    }
+    return configPath;
+}
 async function loadSiteConfig({ siteDir, customConfigFilePath, }) {
-    const siteConfigPath = path_1.default.resolve(siteDir, customConfigFilePath ?? utils_1.DEFAULT_CONFIG_FILE_NAME);
+    const siteConfigPath = customConfigFilePath
+        ? path_1.default.resolve(siteDir, customConfigFilePath)
+        : await findConfig(siteDir);
     if (!(await fs_extra_1.default.pathExists(siteConfigPath))) {
         throw new Error(`Config file at "${siteConfigPath}" not found.`);
     }
@@ -22,7 +37,7 @@ async function loadSiteConfig({ siteDir, customConfigFilePath, }) {
     const loadedConfig = typeof importedConfig === 'function'
         ? await importedConfig()
         : await importedConfig;
-    const siteConfig = (0, configValidation_1.validateConfig)(loadedConfig);
+    const siteConfig = (0, configValidation_1.validateConfig)(loadedConfig, path_1.default.relative(siteDir, siteConfigPath));
     return { siteConfig, siteConfigPath };
 }
 exports.loadSiteConfig = loadSiteConfig;

package/lib/server/configValidation.d.ts

@@ -9,4 +9,4 @@ import type { DocusaurusConfig, I18nConfig } from '@docusaurus/types';
 export declare const DEFAULT_I18N_CONFIG: I18nConfig;
 export declare const DEFAULT_CONFIG: Pick<DocusaurusConfig, 'i18n' | 'onBrokenLinks' | 'onBrokenMarkdownLinks' | 'onDuplicateRoutes' | 'plugins' | 'themes' | 'presets' | 'stylesheets' | 'scripts' | 'clientModules' | 'customFields' | 'themeConfig' | 'titleDelimiter' | 'noIndex' | 'tagline' | 'baseUrlIssueBanner' | 'staticDirectories'>;
 export declare const ConfigSchema: Joi.ObjectSchema<DocusaurusConfig>;
-export declare function validateConfig(config: unknown): DocusaurusConfig;
+export declare function validateConfig(config: unknown, siteConfigPath: string): DocusaurusConfig;

package/lib/server/configValidation.js

@@ -181,7 +181,7 @@ exports.ConfigSchema = utils_validation_1.Joi.object({
     'docusaurus.configValidationWarning': 'Docusaurus config validation warning. Field {#label}: {#warningMessage}',
 });
 // TODO move to @docusaurus/utils-validation
-function validateConfig(config) {
+function validateConfig(config, siteConfigPath) {
     const { error, warning, value } = exports.ConfigSchema.validate(config, {
         abortEarly: false,
     });
@@ -197,7 +197,7 @@ function validateConfig(config) {
             ? `${accumulatedErr}${err.message}\n`
             : accumulatedErr, '');
         formattedError = unknownFields
-            ? `${formattedError}These field(s) (${unknownFields}) are not recognized in ${utils_1.DEFAULT_CONFIG_FILE_NAME}.\nIf you still want these fields to be in your configuration, put them in the "customFields" field.\nSee https://docusaurus.io/docs/api/docusaurus-config/#customfields`
+            ? `${formattedError}These field(s) (${unknownFields}) are not recognized in ${siteConfigPath}.\nIf you still want these fields to be in your configuration, put them in the "customFields" field.\nSee https://docusaurus.io/docs/api/docusaurus-config/#customfields`
             : formattedError;
         throw new Error(formattedError);
     }

package/lib/server/index.js

@@ -90,7 +90,7 @@ DO NOT hand-modify files in this folder because they will be overwritten in the
 next build. You can clear all build artifacts (including this folder) with the
 \`docusaurus clear\` command.
 `);
-    const genSiteConfig = (0, utils_1.generate)(generatedFilesDir, utils_1.DEFAULT_CONFIG_FILE_NAME, `/*
+    const genSiteConfig = (0, utils_1.generate)(generatedFilesDir, `${utils_1.DEFAULT_CONFIG_FILE_NAME}.mjs`, `/*
  * AUTOGENERATED - DON'T EDIT
  * Your edits in this file will be overwritten in the next build!
  * Modify the docusaurus.config.js file at your site's root instead.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "0.0.0-5061",
+  "version": "0.0.0-5066",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -43,13 +43,13 @@
     "@babel/runtime": "^7.18.0",
     "@babel/runtime-corejs3": "^7.18.0",
     "@babel/traverse": "^7.18.0",
-    "@docusaurus/cssnano-preset": "0.0.0-5061",
-    "@docusaurus/logger": "0.0.0-5061",
-    "@docusaurus/mdx-loader": "0.0.0-5061",
+    "@docusaurus/cssnano-preset": "0.0.0-5066",
+    "@docusaurus/logger": "0.0.0-5066",
+    "@docusaurus/mdx-loader": "0.0.0-5066",
     "@docusaurus/react-loadable": "5.5.2",
-    "@docusaurus/utils": "0.0.0-5061",
-    "@docusaurus/utils-common": "0.0.0-5061",
-    "@docusaurus/utils-validation": "0.0.0-5061",
+    "@docusaurus/utils": "0.0.0-5066",
+    "@docusaurus/utils-common": "0.0.0-5066",
+    "@docusaurus/utils-validation": "0.0.0-5066",
     "@slorber/static-site-generator-webpack-plugin": "^4.0.4",
     "@svgr/webpack": "^6.2.1",
     "autoprefixer": "^10.4.7",
@@ -107,8 +107,8 @@
     "webpackbar": "^5.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-5061",
-    "@docusaurus/types": "0.0.0-5061",
+    "@docusaurus/module-type-aliases": "0.0.0-5066",
+    "@docusaurus/types": "0.0.0-5066",
     "@types/detect-port": "^1.3.2",
     "@types/react-dom": "^18.0.4",
     "@types/react-router-config": "^5.0.6",
@@ -128,5 +128,5 @@
   "engines": {
     "node": ">=16.14"
   },
-  "gitHead": "36ac644f128e358499e206f5e77e3f7ade970217"
+  "gitHead": "441e77f61991faa76e06efbc4bd0be7332055945"
 }