mirror of
https://github.com/facebook/docusaurus.git
synced 2025-07-04 18:37:53 +02:00
wip tests
This commit is contained in:
ozakione
parent
c42c15eb32
commit
e147034d2e
1 changed files with 26 additions and 404 deletions
|
|
@ -62,418 +62,40 @@ function testField(params: {
|
||||||
}
|
}
|
||||||
|
|
||||||
describe('doc front matter schema', () => {
|
describe('doc front matter schema', () => {
|
||||||
it('accepts empty object', () => {
|
it('accepts valid frontmatter', () => {
|
||||||
const frontMatter: ShowcaseFrontMatter = {};
|
const frontMatter: ShowcaseFrontMatter = {
|
||||||
|
title: 'title',
|
||||||
|
description: 'description',
|
||||||
|
preview: 'preview',
|
||||||
|
source: 'source',
|
||||||
|
tags: [],
|
||||||
|
website: 'website',
|
||||||
|
};
|
||||||
expect(validateShowcaseFrontMatter(frontMatter)).toEqual(frontMatter);
|
expect(validateShowcaseFrontMatter(frontMatter)).toEqual(frontMatter);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('accepts unknown field', () => {
|
it('reject invalid frontmatter', () => {
|
||||||
const frontMatter = {abc: '1'};
|
const frontMatter = {};
|
||||||
expect(validateShowcaseFrontMatter(frontMatter)).toEqual(frontMatter);
|
expect(() =>
|
||||||
|
validateShowcaseFrontMatter(frontMatter),
|
||||||
|
).toThrowErrorMatchingInlineSnapshot(
|
||||||
|
`""title" is required. "description" is required. "preview" is required. "website" is required. "source" is required. "tags" is required"`,
|
||||||
|
);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('validateShowcaseFrontMatter id', () => {
|
describe('validateShowcaseFrontMatter full', () => {
|
||||||
testField({
|
testField({
|
||||||
prefix: 'id',
|
prefix: 'valid full frontmatter',
|
||||||
validFrontMatters: [{id: '123'}, {id: 'unique_id'}],
|
|
||||||
invalidFrontMatters: [[{id: ''}, 'is not allowed to be empty']],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('validateShowcaseFrontMatter title', () => {
|
|
||||||
testField({
|
|
||||||
prefix: 'title',
|
|
||||||
validFrontMatters: [
|
validFrontMatters: [
|
||||||
// See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
|
{
|
||||||
{title: ''},
|
title: 'title',
|
||||||
{title: 'title'},
|
description: 'description',
|
||||||
],
|
preview: 'preview',
|
||||||
});
|
source: 'source',
|
||||||
});
|
tags: [],
|
||||||
|
website: 'website',
|
||||||
describe('validateShowcaseFrontMatter hide_title', () => {
|
},
|
||||||
testField({
|
|
||||||
prefix: 'hide_title',
|
|
||||||
validFrontMatters: [{hide_title: true}, {hide_title: false}],
|
|
||||||
convertibleFrontMatter: [
|
|
||||||
[{hide_title: 'true'}, {hide_title: true}],
|
|
||||||
[{hide_title: 'false'}, {hide_title: false}],
|
|
||||||
],
|
|
||||||
invalidFrontMatters: [
|
|
||||||
[{hide_title: 'yes'}, 'must be a boolean'],
|
|
||||||
[{hide_title: 'no'}, 'must be a boolean'],
|
|
||||||
[{hide_title: ''}, 'must be a boolean'],
|
|
||||||
],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('validateShowcaseFrontMatter hide_table_of_contents', () => {
|
|
||||||
testField({
|
|
||||||
prefix: 'hide_table_of_contents',
|
|
||||||
validFrontMatters: [
|
|
||||||
{hide_table_of_contents: true},
|
|
||||||
{hide_table_of_contents: false},
|
|
||||||
],
|
|
||||||
convertibleFrontMatter: [
|
|
||||||
[{hide_table_of_contents: 'true'}, {hide_table_of_contents: true}],
|
|
||||||
[{hide_table_of_contents: 'false'}, {hide_table_of_contents: false}],
|
|
||||||
],
|
|
||||||
invalidFrontMatters: [
|
|
||||||
[{hide_table_of_contents: 'yes'}, 'must be a boolean'],
|
|
||||||
[{hide_table_of_contents: 'no'}, 'must be a boolean'],
|
|
||||||
[{hide_table_of_contents: ''}, 'must be a boolean'],
|
|
||||||
],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('validateShowcaseFrontMatter keywords', () => {
|
|
||||||
testField({
|
|
||||||
prefix: 'keywords',
|
|
||||||
validFrontMatters: [
|
|
||||||
{keywords: ['hello']},
|
|
||||||
{keywords: ['hello', 'world']},
|
|
||||||
{keywords: ['hello', 'world']},
|
|
||||||
{keywords: ['hello']},
|
|
||||||
],
|
|
||||||
invalidFrontMatters: [
|
|
||||||
[{keywords: ''}, 'must be an array'],
|
|
||||||
[{keywords: ['']}, 'is not allowed to be empty'],
|
|
||||||
[{keywords: []}, 'does not contain 1 required value(s)'],
|
|
||||||
],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('validateShowcaseFrontMatter image', () => {
|
|
||||||
testField({
|
|
||||||
prefix: 'image',
|
|
||||||
validFrontMatters: [
|
|
||||||
{image: 'https://docusaurus.io/blog/image.png'},
|
|
||||||
{image: '/absolute/image.png'},
|
|
||||||
{image: '../relative/image.png'},
|
|
||||||
],
|
|
||||||
invalidFrontMatters: [
|
|
||||||
[{image: ''}, '"image" does not look like a valid url (value=\'\')'],
|
|
||||||
],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('validateShowcaseFrontMatter description', () => {
|
|
||||||
testField({
|
|
||||||
prefix: 'description',
|
|
||||||
validFrontMatters: [
|
|
||||||
// See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
|
|
||||||
{description: ''},
|
|
||||||
{description: 'description'},
|
|
||||||
],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('validateShowcaseFrontMatter slug', () => {
|
|
||||||
testField({
|
|
||||||
prefix: 'slug',
|
|
||||||
validFrontMatters: [
|
|
||||||
{slug: '/'},
|
|
||||||
{slug: 'slug'},
|
|
||||||
{slug: '/slug/'},
|
|
||||||
{slug: './slug'},
|
|
||||||
{slug: '../../slug'},
|
|
||||||
{slug: '/api/plugins/@docusaurus'},
|
|
||||||
{slug: '@site/api/asset'},
|
|
||||||
{slug: 'slug1 slug2'},
|
|
||||||
],
|
|
||||||
invalidFrontMatters: [[{slug: ''}, 'is not allowed to be empty']],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('validateShowcaseFrontMatter sidebar_label', () => {
|
|
||||||
testField({
|
|
||||||
prefix: 'sidebar_label',
|
|
||||||
validFrontMatters: [{sidebar_label: 'Awesome docs'}],
|
|
||||||
invalidFrontMatters: [[{sidebar_label: ''}, 'is not allowed to be empty']],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('validateShowcaseFrontMatter sidebar_position', () => {
|
|
||||||
testField({
|
|
||||||
prefix: 'sidebar_position',
|
|
||||||
validFrontMatters: [
|
|
||||||
{sidebar_position: -5},
|
|
||||||
{sidebar_position: -3.5},
|
|
||||||
{sidebar_position: 0},
|
|
||||||
{sidebar_position: 5},
|
|
||||||
{sidebar_position: 3.5},
|
|
||||||
],
|
|
||||||
convertibleFrontMatter: [
|
|
||||||
[{sidebar_position: '-1.5'}, {sidebar_position: -1.5}],
|
|
||||||
[{sidebar_position: '1'}, {sidebar_position: 1}],
|
|
||||||
[{sidebar_position: '1.5'}, {sidebar_position: 1.5}],
|
|
||||||
],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('validateShowcaseFrontMatter sidebar_custom_props', () => {
|
|
||||||
testField({
|
|
||||||
prefix: 'sidebar_custom_props',
|
|
||||||
validFrontMatters: [
|
|
||||||
{sidebar_custom_props: {}},
|
|
||||||
{sidebar_custom_props: {prop: 'custom', number: 1, boolean: true}},
|
|
||||||
],
|
|
||||||
invalidFrontMatters: [
|
|
||||||
[{sidebar_custom_props: ''}, 'must be of type object'],
|
|
||||||
],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('validateShowcaseFrontMatter custom_edit_url', () => {
|
|
||||||
testField({
|
|
||||||
prefix: 'custom_edit_url',
|
|
||||||
validFrontMatters: [
|
|
||||||
// See https://github.com/demisto/content-docs/pull/616#issuecomment-827087566
|
|
||||||
{custom_edit_url: ''},
|
|
||||||
{custom_edit_url: null},
|
|
||||||
{custom_edit_url: 'https://github.com/facebook/docusaurus/markdown.md'},
|
|
||||||
{custom_edit_url: '../../api/docs/markdown.md'},
|
|
||||||
{custom_edit_url: '@site/api/docs/markdown.md'},
|
|
||||||
],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('validateShowcaseFrontMatter parse_number_prefixes', () => {
|
|
||||||
testField({
|
|
||||||
prefix: 'parse_number_prefixes',
|
|
||||||
validFrontMatters: [
|
|
||||||
{parse_number_prefixes: true},
|
|
||||||
{parse_number_prefixes: false},
|
|
||||||
],
|
|
||||||
convertibleFrontMatter: [
|
|
||||||
[{parse_number_prefixes: 'true'}, {parse_number_prefixes: true}],
|
|
||||||
[{parse_number_prefixes: 'false'}, {parse_number_prefixes: false}],
|
|
||||||
],
|
|
||||||
invalidFrontMatters: [
|
|
||||||
[{parse_number_prefixes: 'yes'}, 'must be a boolean'],
|
|
||||||
[{parse_number_prefixes: 'no'}, 'must be a boolean'],
|
|
||||||
[{parse_number_prefixes: ''}, 'must be a boolean'],
|
|
||||||
],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('validateShowcaseFrontMatter tags', () => {
|
|
||||||
testField({
|
|
||||||
prefix: 'tags',
|
|
||||||
validFrontMatters: [{}, {tags: undefined}, {tags: ['tag1', 'tag2']}],
|
|
||||||
convertibleFrontMatter: [[{tags: ['tag1', 42]}, {tags: ['tag1', '42']}]],
|
|
||||||
invalidFrontMatters: [
|
|
||||||
[
|
|
||||||
{tags: 42},
|
|
||||||
'"tags" does not look like a valid front matter Yaml array.',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
{tags: 'tag1, tag2'},
|
|
||||||
'"tags" does not look like a valid front matter Yaml array.',
|
|
||||||
],
|
|
||||||
[{tags: [{}]}, '"tags[0]" does not look like a valid tag'],
|
|
||||||
[{tags: [true]}, '"tags[0]" does not look like a valid tag'],
|
|
||||||
[
|
|
||||||
{tags: ['tag1', {hey: 'test'}]},
|
|
||||||
'"tags[1]" does not look like a valid tag',
|
|
||||||
],
|
|
||||||
],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('toc_min_heading_level', () => {
|
|
||||||
testField({
|
|
||||||
prefix: 'toc_min_heading_level',
|
|
||||||
validFrontMatters: [
|
|
||||||
{},
|
|
||||||
{toc_min_heading_level: undefined},
|
|
||||||
{toc_min_heading_level: 2},
|
|
||||||
{toc_min_heading_level: 3},
|
|
||||||
{toc_min_heading_level: 4},
|
|
||||||
{toc_min_heading_level: 5},
|
|
||||||
{toc_min_heading_level: 6},
|
|
||||||
],
|
|
||||||
convertibleFrontMatter: [
|
|
||||||
[{toc_min_heading_level: '2'}, {toc_min_heading_level: 2}],
|
|
||||||
],
|
|
||||||
invalidFrontMatters: [
|
|
||||||
[
|
|
||||||
{toc_min_heading_level: 1},
|
|
||||||
'"toc_min_heading_level" must be greater than or equal to 2',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
{toc_min_heading_level: 7},
|
|
||||||
'"toc_min_heading_level" must be less than or equal to 6',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
{toc_min_heading_level: 'hello'},
|
|
||||||
'"toc_min_heading_level" must be a number',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
{toc_min_heading_level: true},
|
|
||||||
'"toc_min_heading_level" must be a number',
|
|
||||||
],
|
|
||||||
],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('toc_max_heading_level', () => {
|
|
||||||
testField({
|
|
||||||
prefix: 'toc_max_heading_level',
|
|
||||||
validFrontMatters: [
|
|
||||||
{},
|
|
||||||
{toc_max_heading_level: undefined},
|
|
||||||
{toc_max_heading_level: 2},
|
|
||||||
{toc_max_heading_level: 3},
|
|
||||||
{toc_max_heading_level: 4},
|
|
||||||
{toc_max_heading_level: 5},
|
|
||||||
{toc_max_heading_level: 6},
|
|
||||||
],
|
|
||||||
convertibleFrontMatter: [
|
|
||||||
[{toc_max_heading_level: '2'}, {toc_max_heading_level: 2}],
|
|
||||||
],
|
|
||||||
invalidFrontMatters: [
|
|
||||||
[
|
|
||||||
{toc_max_heading_level: 1},
|
|
||||||
'"toc_max_heading_level" must be greater than or equal to 2',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
{toc_max_heading_level: 7},
|
|
||||||
'"toc_max_heading_level" must be less than or equal to 6',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
{toc_max_heading_level: 'hello'},
|
|
||||||
'"toc_max_heading_level" must be a number',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
{toc_max_heading_level: true},
|
|
||||||
'"toc_max_heading_level" must be a number',
|
|
||||||
],
|
|
||||||
],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('toc min/max consistency', () => {
|
|
||||||
testField({
|
|
||||||
prefix: 'toc min/max',
|
|
||||||
validFrontMatters: [
|
|
||||||
{},
|
|
||||||
{toc_min_heading_level: undefined, toc_max_heading_level: undefined},
|
|
||||||
{toc_min_heading_level: 2, toc_max_heading_level: 2},
|
|
||||||
{toc_min_heading_level: 2, toc_max_heading_level: 6},
|
|
||||||
{toc_min_heading_level: 2, toc_max_heading_level: 3},
|
|
||||||
{toc_min_heading_level: 3, toc_max_heading_level: 3},
|
|
||||||
],
|
|
||||||
invalidFrontMatters: [
|
|
||||||
[
|
|
||||||
{toc_min_heading_level: 4, toc_max_heading_level: 3},
|
|
||||||
'"toc_min_heading_level" must be less than or equal to ref:toc_max_heading_level',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
{toc_min_heading_level: 6, toc_max_heading_level: 2},
|
|
||||||
'"toc_min_heading_level" must be less than or equal to ref:toc_max_heading_level',
|
|
||||||
],
|
|
||||||
],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('validateShowcaseFrontMatter draft', () => {
|
|
||||||
testField({
|
|
||||||
prefix: 'draft',
|
|
||||||
validFrontMatters: [{draft: true}, {draft: false}],
|
|
||||||
convertibleFrontMatter: [
|
|
||||||
[{draft: 'true'}, {draft: true}],
|
|
||||||
[{draft: 'false'}, {draft: false}],
|
|
||||||
],
|
|
||||||
invalidFrontMatters: [
|
|
||||||
[{draft: 'yes'}, 'must be a boolean'],
|
|
||||||
[{draft: 'no'}, 'must be a boolean'],
|
|
||||||
[{draft: ''}, 'must be a boolean'],
|
|
||||||
],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('validateShowcaseFrontMatter unlisted', () => {
|
|
||||||
testField({
|
|
||||||
prefix: 'unlisted',
|
|
||||||
validFrontMatters: [{unlisted: true}, {unlisted: false}],
|
|
||||||
convertibleFrontMatter: [
|
|
||||||
[{unlisted: 'true'}, {unlisted: true}],
|
|
||||||
[{unlisted: 'false'}, {unlisted: false}],
|
|
||||||
],
|
|
||||||
invalidFrontMatters: [
|
|
||||||
[{unlisted: 'yes'}, 'must be a boolean'],
|
|
||||||
[{unlisted: 'no'}, 'must be a boolean'],
|
|
||||||
[{unlisted: ''}, 'must be a boolean'],
|
|
||||||
],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('validateShowcaseFrontMatter draft XOR unlisted', () => {
|
|
||||||
testField({
|
|
||||||
prefix: 'draft XOR unlisted',
|
|
||||||
validFrontMatters: [
|
|
||||||
{draft: false},
|
|
||||||
{unlisted: false},
|
|
||||||
{draft: false, unlisted: false},
|
|
||||||
{draft: true, unlisted: false},
|
|
||||||
{draft: false, unlisted: true},
|
|
||||||
],
|
|
||||||
invalidFrontMatters: [
|
|
||||||
[
|
|
||||||
{draft: true, unlisted: true},
|
|
||||||
"Can't be draft and unlisted at the same time.",
|
|
||||||
],
|
|
||||||
],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('validateShowcaseFrontMatter last_update', () => {
|
|
||||||
testField({
|
|
||||||
prefix: 'last_update',
|
|
||||||
validFrontMatters: [
|
|
||||||
{last_update: undefined},
|
|
||||||
{last_update: {author: 'test author', date: undefined}},
|
|
||||||
{last_update: {author: undefined, date: '1/1/2000'}},
|
|
||||||
{last_update: {author: undefined, date: new Date('1/1/2000')}},
|
|
||||||
{last_update: {author: 'test author', date: '1/1/2000'}},
|
|
||||||
{last_update: {author: 'test author', date: '1995-12-17T03:24:00'}},
|
|
||||||
{last_update: {author: undefined, date: 'December 17, 1995 03:24:00'}},
|
|
||||||
],
|
|
||||||
invalidFrontMatters: [
|
|
||||||
[
|
|
||||||
{last_update: null},
|
|
||||||
'"last_update" does not look like a valid last update object. Please use an author key with a string or a date with a string or Date',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
{last_update: {}},
|
|
||||||
'"last_update" does not look like a valid last update object. Please use an author key with a string or a date with a string or Date',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
{last_update: ''},
|
|
||||||
'"last_update" does not look like a valid last update object. Please use an author key with a string or a date with a string or Date',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
{last_update: {invalid: 'key'}},
|
|
||||||
'"last_update" does not look like a valid last update object. Please use an author key with a string or a date with a string or Date',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
{last_update: {author: 'test author', date: 'I am not a date :('}},
|
|
||||||
'must be a valid date',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
{last_update: {author: 'test author', date: '2011-10-45'}},
|
|
||||||
'must be a valid date',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
{last_update: {author: 'test author', date: '2011-0-10'}},
|
|
||||||
'must be a valid date',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
{last_update: {author: 'test author', date: ''}},
|
|
||||||
'must be a valid date',
|
|
||||||
],
|
|
||||||
],
|
],
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue