3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-11 08:07:26 +02:00
Code Issues Projects Releases Packages Wiki Activity

fix(v2): fix too strict markdown frontmatter validation (#4654)

Browse source 
* start work

* use orta.vscode-jest

* node 14

* add some better  infra to validate markdown frontmatter

* better docs frontmatter validation

* fix Yaml / Joi validation issues

* fix Yaml / Joi validation issues

Co-authored-by: slorber <lorber.sebastien@gmail.com>
This commit is contained in:
John Reilly 2021-04-21 15:19:55 +01:00 • committed by GitHub
parent c04e613ffe
commit e11597aba9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 238 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -0,0 +1,37 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
import {DocFrontMatter, validateDocFrontMatter} from '../docFrontMatter';
describe('validateDocFrontMatter', () => {
test('accept empty object', () => {
const frontMatter: DocFrontMatter = {};
expect(validateDocFrontMatter(frontMatter)).toEqual(frontMatter);
});
test('accept valid values', () => {
const frontMatter: DocFrontMatter = {
id: 'blog',
title: 'title',
description: 'description',
slug: 'slug',
};
expect(validateDocFrontMatter(frontMatter)).toEqual(frontMatter);
});
// See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
test('accept empty title', () => {
const frontMatter: DocFrontMatter = {title: ''};
expect(validateDocFrontMatter(frontMatter)).toEqual(frontMatter);
});
// See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
test('accept empty description', () => {
const frontMatter: DocFrontMatter = {description: ''};
expect(validateDocFrontMatter(frontMatter)).toEqual(frontMatter);
});
});