@docusaurus/utils-validation 0.0.0-4759 → 0.0.0-4760

package/lib/JoiFrontMatter.d.ts

@@ -6,10 +6,11 @@
  */
 import Joi from './Joi';
 /**
- * Enhance the default Joi.string() type so that it can convert number to
+ * Enhance the default `Joi.string()` type so that it can convert number to
  * strings. If user use front matter "tag: 2021", we shouldn't need to ask her
  * 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
  */

package/lib/JoiFrontMatter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"JoiFrontMatter.d.ts","sourceRoot":"","sources":["../src/JoiFrontMatter.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,GAAG,MAAM,OAAO,CAAC;AAaxB;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,EAAE,OAAO,GAAsC,CAAC"}
+{"version":3,"file":"JoiFrontMatter.d.ts","sourceRoot":"","sources":["../src/JoiFrontMatter.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,GAAG,MAAM,OAAO,CAAC;AAcxB;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,EAAE,OAAO,GAAsC,CAAC"}

package/lib/JoiFrontMatter.js

@@ -21,10 +21,11 @@ const JoiFrontMatterString = {
     },
 };
 /**
- * Enhance the default Joi.string() type so that it can convert number to
+ * Enhance the default `Joi.string()` type so that it can convert number to
  * strings. If user use front matter "tag: 2021", we shouldn't need to ask her
  * 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
  */

package/lib/JoiFrontMatter.js.map

@@ -1 +1 @@
-{"version":3,"file":"JoiFrontMatter.js","sourceRoot":"","sources":["../src/JoiFrontMatter.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,wDAAwB;AAExB,MAAM,oBAAoB,GAAkB;IAC1C,IAAI,EAAE,QAAQ;IACd,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE;IAClB,2EAA2E;IAC3E,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;QACjB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,YAAY,IAAI,EAAE;YACtD,OAAO,EAAC,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAC,CAAC;SAClC;QACD,OAAO,EAAC,KAAK,EAAC,CAAC;IACjB,CAAC;CACF,CAAC;AACF;;;;;;;GAOG;AACU,QAAA,cAAc,GAAe,aAAG,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC"}
+{"version":3,"file":"JoiFrontMatter.js","sourceRoot":"","sources":["../src/JoiFrontMatter.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,wDAAwB;AAExB,MAAM,oBAAoB,GAAkB;IAC1C,IAAI,EAAE,QAAQ;IACd,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE;IAClB,2EAA2E;IAC3E,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;QACjB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,YAAY,IAAI,EAAE;YACtD,OAAO,EAAC,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAC,CAAC;SAClC;QACD,OAAO,EAAC,KAAK,EAAC,CAAC;IACjB,CAAC;CACF,CAAC;AAEF;;;;;;;;GAQG;AACU,QAAA,cAAc,GAAe,aAAG,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC"}

package/lib/validationUtils.d.ts

@@ -5,10 +5,23 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type Joi from './Joi';
+/** Print warnings returned from Joi validation. */
 export declare function printWarning(warning?: Joi.ValidationError): void;
+/**
+ * The callback that should be used to validate plugin options. Handles plugin
+ * IDs on a generic level: no matter what the schema declares, this callback
+ * would require a string ID or default to "default".
+ */
 export declare function normalizePluginOptions<T extends {
     id?: string;
 }>(schema: Joi.ObjectSchema<T>, options?: Partial<T>): T;
+/**
+ * The callback that should be used to validate theme config. No matter what the
+ * schema declares, this callback would allow unknown attributes.
+ */
 export declare function normalizeThemeConfig<T>(schema: Joi.ObjectSchema<T>, themeConfig: Partial<T>): T;
+/**
+ * Validate front matter with better error message
+ */
 export declare function validateFrontMatter<T>(frontMatter: Record<string, unknown>, schema: Joi.ObjectSchema<T>): T;
 //# sourceMappingURL=validationUtils.d.ts.map

package/lib/validationUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validationUtils.d.ts","sourceRoot":"","sources":["../src/validationUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAI7B,wBAAgB,YAAY,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,eAAe,GAAG,IAAI,CAOhE;AAED,wBAAgB,sBAAsB,CAAC,CAAC,SAAS;IAAC,EAAE,CAAC,EAAE,MAAM,CAAA;CAAC,EAC5D,MAAM,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAE3B,OAAO,GAAE,OAAO,CAAC,CAAC,CAAM,GACvB,CAAC,CAiBH;AAED,wBAAgB,oBAAoB,CAAC,CAAC,EACpC,MAAM,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAC3B,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC,GACtB,CAAC,CAgBH;AAED,wBAAgB,mBAAmB,CAAC,CAAC,EACnC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpC,MAAM,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,GAC1B,CAAC,CAuBH"}
+{"version":3,"file":"validationUtils.d.ts","sourceRoot":"","sources":["../src/validationUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAK7B,mDAAmD;AACnD,wBAAgB,YAAY,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,eAAe,GAAG,IAAI,CAOhE;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS;IAAC,EAAE,CAAC,EAAE,MAAM,CAAA;CAAC,EAC5D,MAAM,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAE3B,OAAO,GAAE,OAAO,CAAC,CAAC,CAAM,GACvB,CAAC,CAiBH;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EACpC,MAAM,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAC3B,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC,GACtB,CAAC,CAgBH;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EACnC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpC,MAAM,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,GAC1B,CAAC,CAuBH"}

package/lib/validationUtils.js

@@ -9,7 +9,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateFrontMatter = exports.normalizeThemeConfig = exports.normalizePluginOptions = exports.printWarning = void 0;
 const tslib_1 = require("tslib");
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
 const validationSchemas_1 = require("./validationSchemas");
+/** Print warnings returned from Joi validation. */
 function printWarning(warning) {
     if (warning) {
         const warningMessages = warning.details
@@ -19,8 +21,13 @@ function printWarning(warning) {
     }
 }
 exports.printWarning = printWarning;
+/**
+ * The callback that should be used to validate plugin options. Handles plugin
+ * IDs on a generic level: no matter what the schema declares, this callback
+ * would require a string ID or default to "default".
+ */
 function normalizePluginOptions(schema, 
-// This allows us to automatically normalize undefined to {id: 'default'}
+// This allows us to automatically normalize undefined to { id: "default" }
 options = {}) {
     // All plugins can be provided an "id" option (multi-instance support)
     // we add schema validation automatically
@@ -37,6 +44,10 @@ options = {}) {
     return value;
 }
 exports.normalizePluginOptions = normalizePluginOptions;
+/**
+ * The callback that should be used to validate theme config. No matter what the
+ * schema declares, this callback would allow unknown attributes.
+ */
 function normalizeThemeConfig(schema, themeConfig) {
     // A theme should only validate its "slice" of the full themeConfig,
     // not the whole object, so we allow unknown attributes
@@ -52,6 +63,9 @@ function normalizeThemeConfig(schema, themeConfig) {
     return value;
 }
 exports.normalizeThemeConfig = normalizeThemeConfig;
+/**
+ * Validate front matter with better error message
+ */
 function validateFrontMatter(frontMatter, schema) {
     const { value, error, warning } = schema.validate(frontMatter, {
         convert: true,
@@ -60,12 +74,12 @@ function validateFrontMatter(frontMatter, schema) {
     });
     printWarning(warning);
     if (error) {
-        const frontMatterString = JSON.stringify(frontMatter, null, 2);
         const errorDetails = error.details;
         const invalidFields = errorDetails.map(({ path }) => path).join(', ');
         logger_1.default.error `The following front matter:
-${logger_1.default.yellow(frontMatterString)}
-contains invalid values for field(s): ${logger_1.default.yellow(invalidFields)}.
+---
+${js_yaml_1.default.dump(frontMatter)}---
+contains invalid values for field(s): code=${invalidFields}.
 ${errorDetails.map(({ message }) => message)}
 `;
         throw error;

package/lib/validationUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"validationUtils.js","sourceRoot":"","sources":["../src/validationUtils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAGH,wEAAwC;AACxC,2DAAmD;AAEnD,SAAgB,YAAY,CAAC,OAA6B;IACxD,IAAI,OAAO,EAAE;QACX,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO;aACpC,GAAG,CAAC,CAAC,EAAC,OAAO,EAAC,EAAE,EAAE,CAAC,OAAO,CAAC;aAC3B,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,gBAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;KAC9B;AACH,CAAC;AAPD,oCAOC;AAED,SAAgB,sBAAsB,CACpC,MAA2B;AAC3B,yEAAyE;AACzE,UAAsB,EAAE;IAExB,sEAAsE;IACtE,yCAAyC;IACzC,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC;QAChC,EAAE,EAAE,kCAAc;KACnB,CAAC,CAAC;IACH,MAAM,EAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAC,GAAG,WAAW,CAAC,QAAQ,CAAC,OAAO,EAAE;QAC5D,OAAO,EAAE,KAAK;KACf,CAAC,CAAC;IAEH,YAAY,CAAC,OAAO,CAAC,CAAC;IAEtB,IAAI,KAAK,EAAE;QACT,MAAM,KAAK,CAAC;KACb;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AArBD,wDAqBC;AAED,SAAgB,oBAAoB,CAClC,MAA2B,EAC3B,WAAuB;IAEvB,oEAAoE;IACpE,uDAAuD;IACvD,sEAAsE;IACtE,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;IAErC,MAAM,EAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAC,GAAG,WAAW,CAAC,QAAQ,CAAC,WAAW,EAAE;QAChE,OAAO,EAAE,KAAK;KACf,CAAC,CAAC;IAEH,YAAY,CAAC,OAAO,CAAC,CAAC;IAEtB,IAAI,KAAK,EAAE;QACT,MAAM,KAAK,CAAC;KACb;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAnBD,oDAmBC;AAED,SAAgB,mBAAmB,CACjC,WAAoC,EACpC,MAA2B;IAE3B,MAAM,EAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE;QAC3D,OAAO,EAAE,IAAI;QACb,YAAY,EAAE,IAAI;QAClB,UAAU,EAAE,KAAK;KAClB,CAAC,CAAC;IAEH,YAAY,CAAC,OAAO,CAAC,CAAC;IAEtB,IAAI,KAAK,EAAE;QACT,MAAM,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAC/D,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC;QACnC,MAAM,aAAa,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,EAAC,IAAI,EAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEpE,gBAAM,CAAC,KAAK,CAAA;EACd,gBAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC;wCACM,gBAAM,CAAC,MAAM,CAAC,aAAa,CAAC;EAClE,YAAY,CAAC,GAAG,CAAC,CAAC,EAAC,OAAO,EAAC,EAAE,EAAE,CAAC,OAAO,CAAC;CACzC,CAAC;QACE,MAAM,KAAK,CAAC;KACb;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AA1BD,kDA0BC"}
+{"version":3,"file":"validationUtils.js","sourceRoot":"","sources":["../src/validationUtils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAGH,wEAAwC;AACxC,8DAA2B;AAC3B,2DAAmD;AAEnD,mDAAmD;AACnD,SAAgB,YAAY,CAAC,OAA6B;IACxD,IAAI,OAAO,EAAE;QACX,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO;aACpC,GAAG,CAAC,CAAC,EAAC,OAAO,EAAC,EAAE,EAAE,CAAC,OAAO,CAAC;aAC3B,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,gBAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;KAC9B;AACH,CAAC;AAPD,oCAOC;AAED;;;;GAIG;AACH,SAAgB,sBAAsB,CACpC,MAA2B;AAC3B,2EAA2E;AAC3E,UAAsB,EAAE;IAExB,sEAAsE;IACtE,yCAAyC;IACzC,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC;QAChC,EAAE,EAAE,kCAAc;KACnB,CAAC,CAAC;IACH,MAAM,EAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAC,GAAG,WAAW,CAAC,QAAQ,CAAC,OAAO,EAAE;QAC5D,OAAO,EAAE,KAAK;KACf,CAAC,CAAC;IAEH,YAAY,CAAC,OAAO,CAAC,CAAC;IAEtB,IAAI,KAAK,EAAE;QACT,MAAM,KAAK,CAAC;KACb;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AArBD,wDAqBC;AAED;;;GAGG;AACH,SAAgB,oBAAoB,CAClC,MAA2B,EAC3B,WAAuB;IAEvB,oEAAoE;IACpE,uDAAuD;IACvD,sEAAsE;IACtE,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;IAErC,MAAM,EAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAC,GAAG,WAAW,CAAC,QAAQ,CAAC,WAAW,EAAE;QAChE,OAAO,EAAE,KAAK;KACf,CAAC,CAAC;IAEH,YAAY,CAAC,OAAO,CAAC,CAAC;IAEtB,IAAI,KAAK,EAAE;QACT,MAAM,KAAK,CAAC;KACb;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAnBD,oDAmBC;AAED;;GAEG;AACH,SAAgB,mBAAmB,CACjC,WAAoC,EACpC,MAA2B;IAE3B,MAAM,EAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE;QAC3D,OAAO,EAAE,IAAI;QACb,YAAY,EAAE,IAAI;QAClB,UAAU,EAAE,KAAK;KAClB,CAAC,CAAC;IAEH,YAAY,CAAC,OAAO,CAAC,CAAC;IAEtB,IAAI,KAAK,EAAE;QACT,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC;QACnC,MAAM,aAAa,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,EAAC,IAAI,EAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEpE,gBAAM,CAAC,KAAK,CAAA;;EAEd,iBAAI,CAAC,IAAI,CAAC,WAAW,CAAC;6CACqB,aAAa;EACxD,YAAY,CAAC,GAAG,CAAC,CAAC,EAAC,OAAO,EAAC,EAAE,EAAE,CAAC,OAAO,CAAC;CACzC,CAAC;QACE,MAAM,KAAK,CAAC;KACb;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AA1BD,kDA0BC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/utils-validation",
-  "version": "0.0.0-4759",
+  "version": "0.0.0-4760",
   "description": "Node validation utility functions for Docusaurus packages.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -18,13 +18,14 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/logger": "0.0.0-4759",
-    "@docusaurus/utils": "0.0.0-4759",
+    "@docusaurus/logger": "0.0.0-4760",
+    "@docusaurus/utils": "0.0.0-4760",
     "joi": "^17.6.0",
+    "js-yaml": "^4.1.0",
     "tslib": "^2.3.1"
   },
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "27c0191b8a17b392b946c59f5ae8d56f787ffd0e"
+  "gitHead": "ca58c5f867aec349fb405a2056d4bdb4d140a0b5"
 }

package/src/JoiFrontMatter.ts

@@ -18,11 +18,13 @@ const JoiFrontMatterString: Joi.Extension = {
     return {value};
   },
 };
+
 /**
- * Enhance the default Joi.string() type so that it can convert number to
+ * Enhance the default `Joi.string()` type so that it can convert number to
  * strings. If user use front matter "tag: 2021", we shouldn't need to ask her
  * 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
  */

package/src/validationUtils.ts

@@ -7,8 +7,10 @@
 
 import type Joi from './Joi';
 import logger from '@docusaurus/logger';
+import Yaml from 'js-yaml';
 import {PluginIdSchema} from './validationSchemas';
 
+/** Print warnings returned from Joi validation. */
 export function printWarning(warning?: Joi.ValidationError): void {
   if (warning) {
     const warningMessages = warning.details
@@ -18,9 +20,14 @@ export function printWarning(warning?: Joi.ValidationError): void {
   }
 }
 
+/**
+ * The callback that should be used to validate plugin options. Handles plugin
+ * IDs on a generic level: no matter what the schema declares, this callback
+ * would require a string ID or default to "default".
+ */
 export function normalizePluginOptions<T extends {id?: string}>(
   schema: Joi.ObjectSchema<T>,
-  // This allows us to automatically normalize undefined to {id: 'default'}
+  // This allows us to automatically normalize undefined to { id: "default" }
   options: Partial<T> = {},
 ): T {
   // All plugins can be provided an "id" option (multi-instance support)
@@ -41,6 +48,10 @@ export function normalizePluginOptions<T extends {id?: string}>(
   return value;
 }
 
+/**
+ * The callback that should be used to validate theme config. No matter what the
+ * schema declares, this callback would allow unknown attributes.
+ */
 export function normalizeThemeConfig<T>(
   schema: Joi.ObjectSchema<T>,
   themeConfig: Partial<T>,
@@ -62,6 +73,9 @@ export function normalizeThemeConfig<T>(
   return value;
 }
 
+/**
+ * Validate front matter with better error message
+ */
 export function validateFrontMatter<T>(
   frontMatter: Record<string, unknown>,
   schema: Joi.ObjectSchema<T>,
@@ -75,13 +89,13 @@ export function validateFrontMatter<T>(
   printWarning(warning);
 
   if (error) {
-    const frontMatterString = JSON.stringify(frontMatter, null, 2);
     const errorDetails = error.details;
     const invalidFields = errorDetails.map(({path}) => path).join(', ');
 
     logger.error`The following front matter:
-${logger.yellow(frontMatterString)}
-contains invalid values for field(s): ${logger.yellow(invalidFields)}.
+---
+${Yaml.dump(frontMatter)}---
+contains invalid values for field(s): code=${invalidFields}.
 ${errorDetails.map(({message}) => message)}
 `;
     throw error;