refactor/fix validateThemeConfig tests

facebook · Sep 4, 2020 · 0b11a4d · 0b11a4d
1 parent 1d99014
commit 0b11a4d
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 26 deletions.
diff --git a/packages/docusaurus-theme-classic/src/__tests__/validateThemeConfig.test.js b/packages/docusaurus-theme-classic/src/__tests__/validateThemeConfig.test.js
@@ -4,27 +4,15 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+
 import merge from 'lodash/merge';
 
-const {
-  validateThemeConfig,
-  DEFAULT_COLOR_MODE_CONFIG,
-} = require('../validateThemeConfig');
+const {ThemeConfigSchema, DEFAULT_CONFIG} = require('../validateThemeConfig');
 
-const mergeDefault = (config) => merge({}, DEFAULT_COLOR_MODE_CONFIG, config);
+const {normalizeThemeConfig} = require('@docusaurus/utils-validation');
 
 function testValidateThemeConfig(themeConfig) {
-  function validate(schema, cfg) {
-    const {value, error} = schema.validate(cfg, {
-      convert: false,
-    });
-    if (error) {
-      throw error;
-    }
-    return value;
-  }
-
-  return validateThemeConfig({themeConfig, validate});
+  return normalizeThemeConfig(ThemeConfigSchema, themeConfig);
 }
 
 describe('themeConfig', () => {
@@ -88,7 +76,7 @@ describe('themeConfig', () => {
       },
     };
     expect(testValidateThemeConfig(userConfig)).toEqual({
-      colorMode: DEFAULT_COLOR_MODE_CONFIG,
+      ...DEFAULT_CONFIG,
       ...userConfig,
     });
   });
@@ -104,7 +92,7 @@ describe('themeConfig', () => {
       },
     };
     expect(testValidateThemeConfig(altTagConfig)).toEqual({
-      colorMode: DEFAULT_COLOR_MODE_CONFIG,
+      ...DEFAULT_CONFIG,
       ...altTagConfig,
     });
   });
@@ -116,20 +104,24 @@ describe('themeConfig', () => {
       },
     };
     expect(testValidateThemeConfig(prismConfig)).toEqual({
-      colorMode: DEFAULT_COLOR_MODE_CONFIG,
+      ...DEFAULT_CONFIG,
       ...prismConfig,
     });
   });
 
   describe('color mode config', () => {
+    const withDefaultValues = (colorMode) =>
+      merge({}, DEFAULT_CONFIG.colorMode, colorMode);
+
     test('minimal config', () => {
       const colorMode = {
         switchConfig: {
           darkIcon: '🌙',
         },
       };
       expect(testValidateThemeConfig({colorMode})).toEqual({
-        colorMode: mergeDefault(colorMode),
+        ...DEFAULT_CONFIG,
+        colorMode: withDefaultValues(colorMode),
       });
     });
 
@@ -151,21 +143,27 @@ describe('themeConfig', () => {
         },
       };
       expect(testValidateThemeConfig({colorMode})).toEqual({
-        colorMode: mergeDefault(colorMode),
+        ...DEFAULT_CONFIG,
+        colorMode: withDefaultValues(colorMode),
       });
     });
 
     test('undefined config', () => {
       const colorMode = undefined;
       expect(testValidateThemeConfig({colorMode})).toEqual({
-        colorMode: mergeDefault(colorMode),
+        ...DEFAULT_CONFIG,
+        colorMode: withDefaultValues(colorMode),
       });
     });
 
     test('empty config', () => {
       const colorMode = {};
       expect(testValidateThemeConfig({colorMode})).toEqual({
-        colorMode: mergeDefault(colorMode),
+        ...DEFAULT_CONFIG,
+        colorMode: {
+          ...DEFAULT_CONFIG.colorMode,
+          ...colorMode,
+        },
       });
     });
 
@@ -174,7 +172,8 @@ describe('themeConfig', () => {
         switchConfig: {},
       };
       expect(testValidateThemeConfig({colorMode})).toEqual({
-        colorMode: mergeDefault(colorMode),
+        ...DEFAULT_CONFIG,
+        colorMode: withDefaultValues(colorMode),
       });
     });
   });

diff --git a/packages/docusaurus-theme-classic/src/validateThemeConfig.js b/packages/docusaurus-theme-classic/src/validateThemeConfig.js
@@ -19,7 +19,12 @@ const DEFAULT_COLOR_MODE_CONFIG = {
     lightIconStyle: {},
   },
 };
-exports.DEFAULT_COLOR_MODE_CONFIG = DEFAULT_COLOR_MODE_CONFIG;
+
+const DEFAULT_CONFIG = {
+  colorMode: DEFAULT_COLOR_MODE_CONFIG,
+  metadatas: [],
+};
+exports.DEFAULT_CONFIG = DEFAULT_CONFIG;
 
 const NavbarItemPosition = Joi.string().equal('left', 'right').default('left');
 
@@ -173,7 +178,9 @@ const ThemeConfigSchema = Joi.object({
   }),
   colorMode: ColorModeSchema,
   image: Joi.string(),
-  metadatas: Joi.array().items(HtmlMetadataSchema).default([]),
+  metadatas: Joi.array()
+    .items(HtmlMetadataSchema)
+    .default(DEFAULT_CONFIG.metadatas),
   announcementBar: Joi.object({
     id: Joi.string().default('announcement-bar'),
     content: Joi.string(),
@@ -226,6 +233,7 @@ const ThemeConfigSchema = Joi.object({
     additionalLanguages: Joi.array().items(Joi.string()),
   }).unknown(),
 });
+exports.ThemeConfigSchema = ThemeConfigSchema;
 
 exports.validateThemeConfig = ({validate, themeConfig}) => {
   return validate(ThemeConfigSchema, themeConfig);