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

fix(v2): accept empty/null custom_edit_url docs frontmatter for retrocompat (#4687)

Browse source
This commit is contained in:
Sébastien Lorber 2021-04-27 12:50:30 +02:00 • committed by GitHub
parent 66254cf0b3
commit 8efc0cd3b8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

11
packages/docusaurus-plugin-content-docs/src/__tests__/docFrontMatter.test.ts
View file

@ -34,4 +34,15 @@ describe('validateDocFrontMatter', () => {
const frontMatter: DocFrontMatter = {description: ''};
expect(validateDocFrontMatter(frontMatter)).toEqual(frontMatter);
});
test('accept null custom_edit_url', () => {
const frontMatter: DocFrontMatter = {custom_edit_url: null};
expect(validateDocFrontMatter(frontMatter)).toEqual(frontMatter);
});
// See https://github.com/demisto/content-docs/pull/616#issuecomment-827087566
test('accept empty custom_edit_url', () => {
const frontMatter: DocFrontMatter = {custom_edit_url: ''};
expect(validateDocFrontMatter(frontMatter)).toEqual(frontMatter);
});
});

2
packages/docusaurus-plugin-content-docs/src/docFrontMatter.ts
View file

@ -33,7 +33,7 @@ const DocFrontMatterSchema = Joi.object<DocFrontMatter>({
slug: Joi.string(),
sidebar_label: Joi.string(),
sidebar_position: Joi.number(),
custom_edit_url: Joi.string().allow(null),
custom_edit_url: Joi.string().allow('', null),
parse_number_prefixes: Joi.boolean(),
});