mirror of
https://github.com/facebook/docusaurus.git
synced 2025-12-30 14:14:17 +00:00
e11597aba9
* 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>
45 lines
1.5 KiB
TypeScript
45 lines
1.5 KiB
TypeScript
/**
|
|
* 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 {
|
|
JoiFrontMatter as Joi, // Custom instance for frontmatter
|
|
validateFrontMatter,
|
|
} from '@docusaurus/utils-validation';
|
|
|
|
// TODO complete this frontmatter + add unit tests
|
|
export type DocFrontMatter = {
|
|
id?: string;
|
|
title?: string;
|
|
description?: string;
|
|
slug?: string;
|
|
sidebar_label?: string;
|
|
sidebar_position?: number;
|
|
custom_edit_url?: string | null;
|
|
parse_number_prefixes?: boolean;
|
|
};
|
|
|
|
// NOTE: we don't add any default value on purpose here
|
|
// We don't want default values to magically appear in doc metadatas and props
|
|
// While the user did not provide those values explicitly
|
|
// We use default values in code instead
|
|
const DocFrontMatterSchema = Joi.object<DocFrontMatter>({
|
|
id: Joi.string(),
|
|
title: Joi.string().allow(''), // see https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
|
|
description: Joi.string().allow(''), // see https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
|
|
slug: Joi.string(),
|
|
sidebar_label: Joi.string(),
|
|
sidebar_position: Joi.number(),
|
|
custom_edit_url: Joi.string().allow(null),
|
|
parse_number_prefixes: Joi.boolean(),
|
|
});
|
|
|
|
export function validateDocFrontMatter(
|
|
frontMatter: Record<string, unknown>,
|
|
): DocFrontMatter {
|
|
return validateFrontMatter(frontMatter, DocFrontMatterSchema);
|
|
}
|