From 17a7ce6d0dbe7fee69c768ff8591ae94d52f2b98 Mon Sep 17 00:00:00 2001 From: Armano Date: Wed, 24 Mar 2021 12:31:26 +0100 Subject: [PATCH] fix(v2): do not warn about duplicated title for pages (#4507) --- .../__snapshots__/parseMarkdown.test.ts.snap | 11 +++++++++++ .../src/__tests__/parseMarkdown.test.ts | 17 +++++++++++++++++ packages/docusaurus-utils/src/index.ts | 8 +++++--- 3 files changed, 33 insertions(+), 3 deletions(-) diff --git a/packages/docusaurus-utils/src/__tests__/__snapshots__/parseMarkdown.test.ts.snap b/packages/docusaurus-utils/src/__tests__/__snapshots__/parseMarkdown.test.ts.snap index 2f0c114b7b..8163fed6fb 100644 --- a/packages/docusaurus-utils/src/__tests__/__snapshots__/parseMarkdown.test.ts.snap +++ b/packages/docusaurus-utils/src/__tests__/__snapshots__/parseMarkdown.test.ts.snap @@ -81,6 +81,17 @@ Object { } `; +exports[`load utils: parseMarkdown readFrontMatter should not warn about duplicated title 1`] = ` +Object { + "content": "# test", + "excerpt": "", + "frontMatter": Object { + "title": "title", + }, + "hasFrontMatter": true, +} +`; + exports[`load utils: parseMarkdown readFrontMatter should parse first heading as title 1`] = ` Object { "content": "", diff --git a/packages/docusaurus-utils/src/__tests__/parseMarkdown.test.ts b/packages/docusaurus-utils/src/__tests__/parseMarkdown.test.ts index 3926584d3a..5513cfdcff 100644 --- a/packages/docusaurus-utils/src/__tests__/parseMarkdown.test.ts +++ b/packages/docusaurus-utils/src/__tests__/parseMarkdown.test.ts @@ -96,6 +96,23 @@ describe('load utils: parseMarkdown', () => { ).toMatchSnapshot(); expect(warn).not.toBeCalled(); }); + test('should not warn about duplicated title', () => { + const warn = jest.spyOn(console, 'warn').mockImplementation(() => {}); + expect( + readFrontMatter( + dedent` + --- + title: title + --- + # test + `, + undefined, + {}, + false, + ), + ).toMatchSnapshot(); + expect(warn).not.toBeCalled(); + }); }); describe('parseMarkdownString', () => { diff --git a/packages/docusaurus-utils/src/index.ts b/packages/docusaurus-utils/src/index.ts index 043de52482..35b0df6b31 100644 --- a/packages/docusaurus-utils/src/index.ts +++ b/packages/docusaurus-utils/src/index.ts @@ -276,9 +276,11 @@ export function readFrontMatter( const heading = /^# (.*)[\n\r]?/gi.exec(result.content); if (heading) { if (result.data.title) { - console.warn( - `Duplicate title detected in \`${source || 'this'}\` file`, - ); + if (removeTitleHeading) { + console.warn( + `Duplicate title detected in \`${source || 'this'}\` file`, + ); + } } else { result.data.title = heading[1].trim(); if (removeTitleHeading) {