@docusaurus/core 3.8.1-canary-6350 → 3.8.1-canary-6352

package/lib/server/configValidation.d.ts

@@ -5,8 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { Joi } from '@docusaurus/utils-validation';
-import type { FasterConfig, FutureConfig, FutureV4Config, StorageConfig } from '@docusaurus/types/src/config';
-import type { DocusaurusConfig, I18nConfig, MarkdownConfig } from '@docusaurus/types';
+import type { FasterConfig, FutureConfig, FutureV4Config, StorageConfig, DocusaurusConfig, I18nConfig, MarkdownConfig, MarkdownHooks } from '@docusaurus/types';
 export declare const DEFAULT_I18N_CONFIG: I18nConfig;
 export declare const DEFAULT_STORAGE_CONFIG: StorageConfig;
 export declare const DEFAULT_FASTER_CONFIG: FasterConfig;
@@ -14,6 +13,7 @@ export declare const DEFAULT_FASTER_CONFIG_TRUE: FasterConfig;
 export declare const DEFAULT_FUTURE_V4_CONFIG: FutureV4Config;
 export declare const DEFAULT_FUTURE_V4_CONFIG_TRUE: FutureV4Config;
 export declare const DEFAULT_FUTURE_CONFIG: FutureConfig;
+export declare const DEFAULT_MARKDOWN_HOOKS: MarkdownHooks;
 export declare const DEFAULT_MARKDOWN_CONFIG: MarkdownConfig;
 export declare const DEFAULT_CONFIG: Pick<DocusaurusConfig, 'i18n' | 'future' | 'onBrokenLinks' | 'onBrokenAnchors' | 'onBrokenMarkdownLinks' | 'onDuplicateRoutes' | 'plugins' | 'themes' | 'presets' | 'headTags' | 'stylesheets' | 'scripts' | 'clientModules' | 'customFields' | 'themeConfig' | 'titleDelimiter' | 'noIndex' | 'tagline' | 'baseUrlIssueBanner' | 'staticDirectories' | 'markdown'>;
 export declare const ConfigSchema: Joi.ObjectSchema<DocusaurusConfig>;

package/lib/server/configValidation.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigSchema = exports.DEFAULT_CONFIG = exports.DEFAULT_MARKDOWN_CONFIG = exports.DEFAULT_FUTURE_CONFIG = exports.DEFAULT_FUTURE_V4_CONFIG_TRUE = exports.DEFAULT_FUTURE_V4_CONFIG = exports.DEFAULT_FASTER_CONFIG_TRUE = exports.DEFAULT_FASTER_CONFIG = exports.DEFAULT_STORAGE_CONFIG = exports.DEFAULT_I18N_CONFIG = void 0;
+exports.ConfigSchema = exports.DEFAULT_CONFIG = exports.DEFAULT_MARKDOWN_CONFIG = exports.DEFAULT_MARKDOWN_HOOKS = exports.DEFAULT_FUTURE_CONFIG = exports.DEFAULT_FUTURE_V4_CONFIG_TRUE = exports.DEFAULT_FUTURE_V4_CONFIG = exports.DEFAULT_FASTER_CONFIG_TRUE = exports.DEFAULT_FASTER_CONFIG = exports.DEFAULT_STORAGE_CONFIG = exports.DEFAULT_I18N_CONFIG = void 0;
 exports.validateConfig = validateConfig;
 const tslib_1 = require("tslib");
 const utils_1 = require("@docusaurus/utils");
@@ -60,6 +60,10 @@ exports.DEFAULT_FUTURE_CONFIG = {
     experimental_storage: exports.DEFAULT_STORAGE_CONFIG,
     experimental_router: 'browser',
 };
+exports.DEFAULT_MARKDOWN_HOOKS = {
+    onBrokenMarkdownLinks: 'warn',
+    onBrokenMarkdownImages: 'throw',
+};
 exports.DEFAULT_MARKDOWN_CONFIG = {
     format: 'mdx', // TODO change this to "detect" in Docusaurus v4?
     mermaid: false,
@@ -74,13 +78,14 @@ exports.DEFAULT_MARKDOWN_CONFIG = {
         maintainCase: false,
     },
     remarkRehypeOptions: undefined,
+    hooks: exports.DEFAULT_MARKDOWN_HOOKS,
 };
 exports.DEFAULT_CONFIG = {
     i18n: exports.DEFAULT_I18N_CONFIG,
     future: exports.DEFAULT_FUTURE_CONFIG,
     onBrokenLinks: 'throw',
     onBrokenAnchors: 'warn', // TODO Docusaurus v4: change to throw
-    onBrokenMarkdownLinks: 'warn',
+    onBrokenMarkdownLinks: undefined,
     onDuplicateRoutes: 'warn',
     plugins: [],
     themes: [],
@@ -248,7 +253,7 @@ exports.ConfigSchema = utils_validation_1.Joi.object({
         .default(exports.DEFAULT_CONFIG.onBrokenAnchors),
     onBrokenMarkdownLinks: utils_validation_1.Joi.string()
         .equal('ignore', 'log', 'warn', 'throw')
-        .default(exports.DEFAULT_CONFIG.onBrokenMarkdownLinks),
+        .default(() => exports.DEFAULT_CONFIG.onBrokenMarkdownLinks),
     onDuplicateRoutes: utils_validation_1.Joi.string()
         .equal('ignore', 'log', 'warn', 'throw')
         .default(exports.DEFAULT_CONFIG.onDuplicateRoutes),
@@ -332,13 +337,29 @@ exports.ConfigSchema = utils_validation_1.Joi.object({
         anchors: utils_validation_1.Joi.object({
             maintainCase: utils_validation_1.Joi.boolean().default(exports.DEFAULT_CONFIG.markdown.anchors.maintainCase),
         }).default(exports.DEFAULT_CONFIG.markdown.anchors),
+        hooks: utils_validation_1.Joi.object({
+            onBrokenMarkdownLinks: utils_validation_1.Joi.alternatives()
+                .try(utils_validation_1.Joi.string().equal('ignore', 'log', 'warn', 'throw'), utils_validation_1.Joi.function())
+                .default(exports.DEFAULT_CONFIG.markdown.hooks.onBrokenMarkdownLinks),
+            onBrokenMarkdownImages: utils_validation_1.Joi.alternatives()
+                .try(utils_validation_1.Joi.string().equal('ignore', 'log', 'warn', 'throw'), utils_validation_1.Joi.function())
+                .default(exports.DEFAULT_CONFIG.markdown.hooks.onBrokenMarkdownImages),
+        }).default(exports.DEFAULT_CONFIG.markdown.hooks),
     }).default(exports.DEFAULT_CONFIG.markdown),
 }).messages({
     'docusaurus.configValidationWarning': 'Docusaurus config validation warning. Field {#label}: {#warningMessage}',
 });
 // Expressing this kind of logic in Joi is a pain
 // We also want to decouple logic from Joi: easier to remove it later!
-function ensureDocusaurusConfigConsistency(config) {
+function postProcessDocusaurusConfig(config) {
+    if (config.onBrokenMarkdownLinks) {
+        logger_1.default.warn `The code=${'siteConfig.onBrokenMarkdownLinks'} config option is deprecated and will be removed in Docusaurus v4.
+Please migrate and move this option to code=${'siteConfig.markdown.hooks.onBrokenMarkdownLinks'} instead.`;
+        // For v3 retro compatibility we use the old attribute over the new one
+        config.markdown.hooks.onBrokenMarkdownLinks = config.onBrokenMarkdownLinks;
+        // We erase the former one to ensure we don't use it anywhere
+        config.onBrokenMarkdownLinks = undefined;
+    }
     if (config.future.experimental_faster.ssgWorkerThreads &&
         !config.future.v4.removeLegacyPostBuildHeadAttribute) {
         throw new Error(`Docusaurus config ${logger_1.default.code('future.experimental_faster.ssgWorkerThreads')} requires the future flag ${logger_1.default.code('future.v4.removeLegacyPostBuildHeadAttribute')} to be turned on.
@@ -371,6 +392,6 @@ function validateConfig(config, siteConfigPath) {
             : formattedError;
         throw new Error(formattedError);
     }
-    ensureDocusaurusConfigConsistency(value);
+    postProcessDocusaurusConfig(value);
     return value;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "3.8.1-canary-6350",
+  "version": "3.8.1-canary-6352",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -33,13 +33,13 @@
     "url": "https://github.com/facebook/docusaurus/issues"
   },
   "dependencies": {
-    "@docusaurus/babel": "3.8.1-canary-6350",
-    "@docusaurus/bundler": "3.8.1-canary-6350",
-    "@docusaurus/logger": "3.8.1-canary-6350",
-    "@docusaurus/mdx-loader": "3.8.1-canary-6350",
-    "@docusaurus/utils": "3.8.1-canary-6350",
-    "@docusaurus/utils-common": "3.8.1-canary-6350",
-    "@docusaurus/utils-validation": "3.8.1-canary-6350",
+    "@docusaurus/babel": "3.8.1-canary-6352",
+    "@docusaurus/bundler": "3.8.1-canary-6352",
+    "@docusaurus/logger": "3.8.1-canary-6352",
+    "@docusaurus/mdx-loader": "3.8.1-canary-6352",
+    "@docusaurus/utils": "3.8.1-canary-6352",
+    "@docusaurus/utils-common": "3.8.1-canary-6352",
+    "@docusaurus/utils-validation": "3.8.1-canary-6352",
     "boxen": "^6.2.1",
     "chalk": "^4.1.2",
     "chokidar": "^3.5.3",
@@ -77,8 +77,8 @@
     "webpack-merge": "^6.0.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.8.1-canary-6350",
-    "@docusaurus/types": "3.8.1-canary-6350",
+    "@docusaurus/module-type-aliases": "3.8.1-canary-6352",
+    "@docusaurus/types": "3.8.1-canary-6352",
     "@total-typescript/shoehorn": "^0.1.2",
     "@types/detect-port": "^1.3.3",
     "@types/react-dom": "^18.2.7",
@@ -98,5 +98,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "76f391c678f4d51cad345f9ac4bd53a1b44b7f90"
+  "gitHead": "a3190d2cdcb4d4ab6704dbd8de92868ef67165cb"
 }