3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-07-31 15:29:32 +02:00
Code Issues Projects Releases Packages Wiki Activity

chore: rename siteConfig.js to docusaurus.config.js (#1245)

Browse source 
* chore: rename siteConfig.js to docusaurus.config.js

* Prettier
This commit is contained in:
Yangshun Tay 2019-02-23 11:16:24 -08:00 • committed by GitHub
parent 870f6daa6b
commit 7dae4bd0d1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
21 changed files with 57 additions and 57 deletions
Download patch file Download diff file Expand all files Collapse all files

10
v2/lib/load/config.js
View file

@ -9,7 +9,7 @@ const fs = require('fs-extra');
const path = require('path');
module.exports = function loadConfig(siteDir, deleteCache = true) {
const configPath = path.resolve(siteDir, 'siteConfig.js');
const configPath = path.resolve(siteDir, 'docusaurus.config.js');
if (deleteCache) {
delete require.cache[configPath];
}
@ -44,7 +44,7 @@ module.exports = function loadConfig(siteDir, deleteCache = true) {
const missingFields = requiredFields.filter(field => !config[field]);
if (missingFields && missingFields.length > 0) {
throw new Error(
`${missingFields.join(', ')} fields are missing in siteConfig.js`,
`${missingFields.join(', ')} fields are missing in docusaurus.config.js`,
);
}
@ -89,14 +89,16 @@ module.exports = function loadConfig(siteDir, deleteCache = true) {
*/
const {customFields = []} = config;
/* We don't allow useless/ not meaningful field */
// We don't allow unused fields.
const allowedFields = [...requiredFields, ...optionalFields, ...customFields];
const uselessFields = Object.keys(config).filter(
field => !allowedFields.includes(field),
);
if (uselessFields && uselessFields.length > 0) {
throw new Error(
`${uselessFields.join(', ')} fields are useless in siteConfig.js`,
`The fields ${uselessFields.join(
', ',
)} are not recognized in docusaurus.config.js`,
);
}