3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-18 03:26:57 +02:00
Code Issues Projects Releases Packages Wiki Activity

feat(v2): ability to add/override theme html metadatas (#3406)

Browse source 
* ability to add/override theme html metadatas
see https://github.com/facebook/docusaurus/issues/3024

* refactor/fix validateThemeConfig tests
This commit is contained in:
Sébastien Lorber 2020-09-04 16:36:56 +02:00 • committed by GitHub
parent f49d8baf2f
commit 21852948ce
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 72 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

47
packages/docusaurus-theme-classic/src/__tests__/validateThemeConfig.test.js
View file

@ -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,12 +104,15 @@ 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: {
@ -129,7 +120,8 @@ describe('themeConfig', () => {
},
};
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),
});
});
});