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

fix(v2): make config validation less strict (#3120)

Browse source 
* fix(v2): make navbar title validation less strict

* fix(v2): fix validation for rehype plugin

* fix(v2): allow empty string for routeBasePath

* fix(v2): fix validation for stylesheets and scripts field

* fix(v2): rerun CI

* fix(v2): relax check for stylesheet href
This commit is contained in:
Teik Jun 2020-07-27 19:58:24 +08:00 • committed by GitHub
parent 41d5ac63fd
commit 2159c4fcfb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 26 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

19
packages/docusaurus-plugin-content-blog/src/pluginOptionSchema.ts
View file

@ -28,7 +28,7 @@ export const DEFAULT_OPTIONS = {
export const PluginOptionSchema = Joi.object({ export const PluginOptionSchema = Joi.object({
path: Joi.string().default(DEFAULT_OPTIONS.path), path: Joi.string().default(DEFAULT_OPTIONS.path),
routeBasePath: Joi.string().default(DEFAULT_OPTIONS.routeBasePath), routeBasePath: Joi.string().allow('').default(DEFAULT_OPTIONS.routeBasePath),
include: Joi.array().items(Joi.string()).default(DEFAULT_OPTIONS.include), include: Joi.array().items(Joi.string()).default(DEFAULT_OPTIONS.include),
postsPerPage: Joi.number() postsPerPage: Joi.number()
.integer() .integer()
@ -45,16 +45,19 @@ export const PluginOptionSchema = Joi.object({
showReadingTime: Joi.bool().default(DEFAULT_OPTIONS.showReadingTime), showReadingTime: Joi.bool().default(DEFAULT_OPTIONS.showReadingTime),
remarkPlugins: Joi.array() remarkPlugins: Joi.array()
.items( .items(
Joi.alternatives().try( Joi.array()
Joi.function(), .items(Joi.function().required(), Joi.object().required())
Joi.array() .length(2),
.items(Joi.function().required(), Joi.object().required()) Joi.function(),
.length(2),
),
) )
.default(DEFAULT_OPTIONS.remarkPlugins), .default(DEFAULT_OPTIONS.remarkPlugins),
rehypePlugins: Joi.array() rehypePlugins: Joi.array()
.items(Joi.string()) .items(
Joi.array()
.items(Joi.function().required(), Joi.object().required())
.length(2),
Joi.function(),
)
.default(DEFAULT_OPTIONS.rehypePlugins), .default(DEFAULT_OPTIONS.rehypePlugins),
editUrl: Joi.string().uri(), editUrl: Joi.string().uri(),
truncateMarker: Joi.object().default(DEFAULT_OPTIONS.truncateMarker), truncateMarker: Joi.object().default(DEFAULT_OPTIONS.truncateMarker),

13
packages/docusaurus-plugin-content-docs/src/pluginOptionSchema.ts
View file

@ -29,7 +29,7 @@ export const DEFAULT_OPTIONS: PluginOptions = {
export const PluginOptionSchema = Joi.object({ export const PluginOptionSchema = Joi.object({
path: Joi.string().default(DEFAULT_OPTIONS.path), path: Joi.string().default(DEFAULT_OPTIONS.path),
editUrl: Joi.string().uri(), editUrl: Joi.string().uri(),
routeBasePath: Joi.string().default(DEFAULT_OPTIONS.routeBasePath), routeBasePath: Joi.string().allow('').default(DEFAULT_OPTIONS.routeBasePath),
homePageId: Joi.string().default(DEFAULT_OPTIONS.homePageId), homePageId: Joi.string().default(DEFAULT_OPTIONS.homePageId),
include: Joi.array().items(Joi.string()).default(DEFAULT_OPTIONS.include), include: Joi.array().items(Joi.string()).default(DEFAULT_OPTIONS.include),
sidebarPath: Joi.string().default(DEFAULT_OPTIONS.sidebarPath), sidebarPath: Joi.string().default(DEFAULT_OPTIONS.sidebarPath),
@ -37,12 +37,19 @@ export const PluginOptionSchema = Joi.object({
docItemComponent: Joi.string().default(DEFAULT_OPTIONS.docItemComponent), docItemComponent: Joi.string().default(DEFAULT_OPTIONS.docItemComponent),
remarkPlugins: Joi.array() remarkPlugins: Joi.array()
.items( .items(
Joi.array().items(Joi.function(), Joi.object()).length(2), Joi.array()
.items(Joi.function().required(), Joi.object().required())
.length(2),
Joi.function(), Joi.function(),
) )
.default(DEFAULT_OPTIONS.remarkPlugins), .default(DEFAULT_OPTIONS.remarkPlugins),
rehypePlugins: Joi.array() rehypePlugins: Joi.array()
.items(Joi.string()) .items(
Joi.array()
.items(Joi.function().required(), Joi.object().required())
.length(2),
Joi.function(),
)
.default(DEFAULT_OPTIONS.rehypePlugins), .default(DEFAULT_OPTIONS.rehypePlugins),
showLastUpdateTime: Joi.bool().default(DEFAULT_OPTIONS.showLastUpdateTime), showLastUpdateTime: Joi.bool().default(DEFAULT_OPTIONS.showLastUpdateTime),
showLastUpdateAuthor: Joi.bool().default( showLastUpdateAuthor: Joi.bool().default(

2
packages/docusaurus-theme-classic/src/themeConfigSchema.js
View file

@ -135,7 +135,7 @@ const ThemeConfigSchema = Joi.object({
'themeConfig.navbar.links has been renamed as themeConfig.navbar.items', 'themeConfig.navbar.links has been renamed as themeConfig.navbar.items',
}), }),
items: Joi.array().items(NavbarItemSchema), items: Joi.array().items(NavbarItemSchema),
title: Joi.string().required(), title: Joi.string().allow('', null),
logo: Joi.object({ logo: Joi.object({
alt: Joi.string(), alt: Joi.string(),
src: Joi.string().required(), src: Joi.string().required(),

8
packages/docusaurus/src/server/configValidation.ts
View file

@ -6,8 +6,8 @@
*/ */
import {DocusaurusConfig} from '@docusaurus/types'; import {DocusaurusConfig} from '@docusaurus/types';
import Joi from '@hapi/joi';
import {CONFIG_FILE_NAME} from '../constants'; import {CONFIG_FILE_NAME} from '../constants';
import Joi from '@hapi/joi';
export const DEFAULT_CONFIG: Pick< export const DEFAULT_CONFIG: Pick<
DocusaurusConfig, DocusaurusConfig,
@ -66,14 +66,14 @@ const ConfigSchema = Joi.object({
src: Joi.string().required(), src: Joi.string().required(),
async: Joi.bool(), async: Joi.bool(),
defer: Joi.bool(), defer: Joi.bool(),
}).oxor('async', 'defer'), }),
), ),
stylesheets: Joi.array().items( stylesheets: Joi.array().items(
Joi.string(), Joi.string(),
Joi.object({ Joi.object({
href: Joi.string().uri().required(), href: Joi.string().required(),
type: Joi.string().required(), type: Joi.string().required(),
}), }).unknown(),
), ),
tagline: Joi.string(), tagline: Joi.string(),
}); });