mirror of
https://github.com/facebook/docusaurus.git
synced 2025-06-14 00:32:47 +02:00
fix(docusaurus-utils-validation): baseUrl + routeBasePath: allow empty string, normalized as "/" (#8258)
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com> fix https://github.com/facebook/docusaurus/issues/8254
This commit is contained in:
parent
85d0b5674f
commit
e553ce7e59
12 changed files with 92 additions and 17 deletions
|
@ -5,7 +5,12 @@
|
|||
* LICENSE file in the root directory of this source tree.
|
||||
*/
|
||||
|
||||
import {isValidPathname, DEFAULT_PLUGIN_ID, type Tag} from '@docusaurus/utils';
|
||||
import {
|
||||
isValidPathname,
|
||||
DEFAULT_PLUGIN_ID,
|
||||
type Tag,
|
||||
addLeadingSlash,
|
||||
} from '@docusaurus/utils';
|
||||
import Joi from './Joi';
|
||||
import {JoiFrontMatter} from './JoiFrontMatter';
|
||||
|
||||
|
@ -96,6 +101,26 @@ export const PathnameSchema = Joi.string()
|
|||
'{{#label}} is not a valid pathname. Pathname should start with slash and not contain any domain or query string.',
|
||||
);
|
||||
|
||||
// Normalized schema for url path segments: baseUrl + routeBasePath...
|
||||
// Note we only add a leading slash
|
||||
// we don't always want to enforce a trailing slash on urls such as /docs
|
||||
//
|
||||
// Examples:
|
||||
// '' => '/'
|
||||
// 'docs' => '/docs'
|
||||
// '/docs' => '/docs'
|
||||
// 'docs/' => '/docs'
|
||||
// 'prefix/docs' => '/prefix/docs'
|
||||
// TODO tighter validation: not all strings are valid path segments
|
||||
export const RouteBasePathSchema = Joi
|
||||
// Weird Joi trick needed, otherwise value '' is not normalized...
|
||||
.alternatives()
|
||||
.try(Joi.string().required().allow(''))
|
||||
.custom((value: string) =>
|
||||
// /!\ do not add trailing slash here
|
||||
addLeadingSlash(value),
|
||||
);
|
||||
|
||||
const FrontMatterTagSchema = JoiFrontMatter.alternatives()
|
||||
.try(
|
||||
JoiFrontMatter.string().required(),
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue