From 3f4757569d5b0912e1ddefe7ebb1a3421658c249 Mon Sep 17 00:00:00 2001 From: slorber Date: Tue, 27 Apr 2021 12:02:13 +0200 Subject: [PATCH] accept empty/null custom_edit_url docs frontmatter --- .../src/__tests__/docFrontMatter.test.ts | 11 +++++++++++ .../src/docFrontMatter.ts | 2 +- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/docFrontMatter.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/docFrontMatter.test.ts index 54b78691e2dc..956dff52547c 100644 --- a/packages/docusaurus-plugin-content-docs/src/__tests__/docFrontMatter.test.ts +++ b/packages/docusaurus-plugin-content-docs/src/__tests__/docFrontMatter.test.ts @@ -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); + }); }); diff --git a/packages/docusaurus-plugin-content-docs/src/docFrontMatter.ts b/packages/docusaurus-plugin-content-docs/src/docFrontMatter.ts index 08a57e5d1c32..d0bac4ec40c5 100644 --- a/packages/docusaurus-plugin-content-docs/src/docFrontMatter.ts +++ b/packages/docusaurus-plugin-content-docs/src/docFrontMatter.ts @@ -33,7 +33,7 @@ const DocFrontMatterSchema = Joi.object({ 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(), });