@docusaurus/utils-validation 2.0.0-beta.15d451942 → 2.0.0-beta.16

package/src/validationUtils.ts

@@ -4,37 +4,20 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import Joi from './Joi';
-import chalk from 'chalk';
-import {PluginIdSchema} from './validationSchemas';
 
-// TODO temporary escape hatch for alpha-60: to be removed soon
-// Our validation schemas might be buggy at first
-// will permit users to bypass validation until we fix all validation errors
-// see for example: https://github.com/facebook/docusaurus/pull/3120
-// Undocumented on purpose, as we don't want users to keep using it over time
-// Maybe we'll make this escape hatch official some day, with a better api?
-export const isValidationDisabledEscapeHatch =
-  process.env.DISABLE_DOCUSAURUS_VALIDATION === 'true';
+import type Joi from './Joi';
+import logger from '@docusaurus/logger';
+import {PluginIdSchema} from './validationSchemas';
 
-if (isValidationDisabledEscapeHatch) {
-  console.error(
-    chalk.red(
-      'You should avoid using DISABLE_DOCUSAURUS_VALIDATION escape hatch, this will be removed',
-    ),
-  );
+export function printWarning(warning?: Joi.ValidationError): void {
+  if (warning) {
+    const warningMessages = warning.details
+      .map(({message}) => message)
+      .join('\n');
+    logger.warn(warningMessages);
+  }
 }
 
-export const logValidationBugReportHint = (): void => {
-  console.log(
-    `\n${chalk.red('A validation error occured.')}${chalk.cyanBright(
-      '\nThe validation system was added recently to Docusaurus as an attempt to avoid user configuration errors.' +
-        '\nWe may have made some mistakes.' +
-        '\nIf you think your configuration is valid and should keep working, please open a bug report.',
-    )}\n`,
-  );
-};
-
 export function normalizePluginOptions<T extends {id?: string}>(
   schema: Joi.ObjectSchema<T>,
   options: Partial<T>,
@@ -44,19 +27,17 @@ export function normalizePluginOptions<T extends {id?: string}>(
   const finalSchema = schema.append({
     id: PluginIdSchema,
   });
-  const {error, value} = finalSchema.validate(options, {
+  const {error, warning, value} = finalSchema.validate(options, {
     convert: false,
   });
+
+  printWarning(warning);
+
   if (error) {
-    logValidationBugReportHint();
-    if (isValidationDisabledEscapeHatch) {
-      console.error(error);
-      return options as T;
-    } else {
-      throw error;
-    }
+    throw error;
   }
-  return value;
+
+  return value!; // TODO remove this ! in TS 4.6, see https://twitter.com/sebastienlorber/status/1481950042277793793
 }
 
 export function normalizeThemeConfig<T>(
@@ -68,40 +49,18 @@ export function normalizeThemeConfig<T>(
   // otherwise one theme would fail validating the data of another theme
   const finalSchema = schema.unknown();
 
-  const {error, value} = finalSchema.validate(themeConfig, {
+  const {error, warning, value} = finalSchema.validate(themeConfig, {
     convert: false,
   });
 
+  printWarning(warning);
+
   if (error) {
-    logValidationBugReportHint();
-    if (isValidationDisabledEscapeHatch) {
-      console.error(error);
-      return themeConfig as T;
-    } else {
-      throw error;
-    }
+    throw error;
   }
-  return value;
+  return value!; // TODO remove this ! in TS 4.6
 }
 
-// Enhance the default Joi.string() type so that it can convert number to strings
-// If user use frontmatter "tag: 2021", we shouldn't need to ask the user to write "tag: '2021'"
-// Also yaml tries to convert patterns like "2019-01-01" to dates automatically
-// see https://github.com/facebook/docusaurus/issues/4642
-// see https://github.com/sideway/joi/issues/1442#issuecomment-823997884
-const JoiFrontMatterString: Joi.Extension = {
-  type: 'string',
-  base: Joi.string(),
-  // Fix Yaml that tries to auto-convert many things to string out of the box
-  prepare: (value) => {
-    if (typeof value === 'number' || value instanceof Date) {
-      return {value: value.toString()};
-    }
-    return {value};
-  },
-};
-export const JoiFrontMatter: typeof Joi = Joi.extend(JoiFrontMatterString);
-
 export function validateFrontMatter<T>(
   frontMatter: Record<string, unknown>,
   schema: Joi.ObjectSchema<T>,
@@ -112,32 +71,20 @@ export function validateFrontMatter<T>(
     abortEarly: false,
   });
 
+  printWarning(warning);
+
   if (error) {
     const frontMatterString = JSON.stringify(frontMatter, null, 2);
     const errorDetails = error.details;
     const invalidFields = errorDetails.map(({path}) => path).join(', ');
-    const errorMessages = errorDetails
-      .map(({message}) => ` - ${message}`)
-      .join('\n');
-
-    logValidationBugReportHint();
 
-    console.error(
-      chalk.red(
-        `The following FrontMatter:\n${chalk.yellow(
-          frontMatterString,
-        )}\ncontains invalid values for field(s): ${invalidFields}.\n${errorMessages}\n`,
-      ),
-    );
+    logger.error`The following front matter:
+${logger.yellow(frontMatterString)}
+contains invalid values for field(s): ${logger.yellow(invalidFields)}.
+${errorDetails.map(({message}) => message)}
+`;
     throw error;
   }
 
-  if (warning) {
-    const warningMessages = warning.details
-      .map(({message}) => message)
-      .join('\n');
-    console.log(chalk.yellow(warningMessages));
-  }
-
-  return value;
+  return value!; // TODO remove this ! in TS 4.6
 }