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

feat: throw error if there is wrong field on siteConfig.js

Browse source
This commit is contained in:
endiliey 2018-08-29 23:57:26 +08:00
parent ef17da741a
commit 9965eec798
4 changed files with 41 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

2
lib/core/components/Markdown/highlight.js
View file

@ -3,7 +3,7 @@ const chalk = require('chalk');
const escapeHtml = require('escape-html');
export default (str, rawLang) => {
if (rawLang === 'text') {
if (rawLang === 'text' || !rawLang) {
return escapeHtml(str);
}
const lang = rawLang.toLowerCase();

20
lib/load/config.js
View file

@ -18,9 +18,27 @@ module.exports = function loadConfig(siteDir, deleteCache = true) {
'projectName',
'baseUrl'
];
const optionalFields = [
'customDocsPath',
'themePath',
'highlight',
'markdownPlugins'
];
const missingFields = requiredFields.filter(field => !config[field]);
if (missingFields && missingFields.length > 0) {
throw new Error(`${missingFields.join(', ')} are missing in siteConfig.js`);
throw new Error(
`${missingFields.join(', ')} fields are missing in siteConfig.js`
);
}
const uselessFields = Object.keys(config).filter(
field => ![...requiredFields, ...optionalFields].includes(field)
);
if (uselessFields && uselessFields.length > 0) {
throw new Error(
`${uselessFields.join(', ')} fields are useless in siteConfig.js`
);
}
return config;
};

10
test/load/__fixtures__/wrong-site/siteConfig.js Normal file
View file

@ -0,0 +1,10 @@
module.exports = {
title: 'Hello',
tagline: 'Hello World',
organizationName: 'endiliey',
projectName: 'hello',
baseUrl: '/',
useLessField: 'what',
superman: 'lol',
admin: 'endi'
};

13
test/load/config.test.js
View file

@ -20,7 +20,16 @@ describe('loadConfig', () => {
expect(() => {
loadConfig(siteDir);
}).toThrowErrorMatchingInlineSnapshot(
`"tagline, organizationName, projectName are missing in siteConfig.js"`
`"tagline, organizationName, projectName fields are missing in siteConfig.js"`
);
});
test('website with useless field (wrong field) in siteConfig', () => {
const siteDir = path.join(__dirname, '__fixtures__', 'wrong-site');
expect(() => {
loadConfig(siteDir);
}).toThrowErrorMatchingInlineSnapshot(
`"useLessField, superman, admin fields are useless in siteConfig.js"`
);
});
@ -29,7 +38,7 @@ describe('loadConfig', () => {
expect(() => {
loadConfig(siteDir);
}).toThrowErrorMatchingInlineSnapshot(
`"title, tagline, organizationName, projectName, baseUrl are missing in siteConfig.js"`
`"title, tagline, organizationName, projectName, baseUrl fields are missing in siteConfig.js"`
);
});
});