fix: add docs tag validation to solve #5478

[swyxio]

fix: add docs tag validation to solve #5478

Motivation

nicer developer experience when people put in malformed tags, as suggested by @Josh-Cena #5478 (comment)

Have you read the Contributing Guidelines on pull requests?

yes

Test Plan

i confess i did not test this one locally. hoping its a simple one.

[Josh-Cena]

Suggested change

	tags: [Joi.string(), Joi.array().items(Joi.object({
	label: Joi.string,
	permalink: Joi.string
	}))]
	tags: Joi.array().items(Joi.alternatives().try(
	Joi.string(),
	Joi.object({
	label: Joi.string().required(),
	permalink: Joi.string().required(),
	}),
	)),

Joi is really a pain, yeah

[Josh-Cena]

Actually, there's a FrontMatterTagsSchema from utils-validation. See here:

docusaurus/packages/docusaurus-plugin-content-blog/src/blogFrontMatter.ts

Lines 8 to 13 in fd3c0c6

	import {
	JoiFrontMatter as Joi, // Custom instance for frontmatter
	URISchema,
	validateFrontMatter,
	FrontMatterTagsSchema,
	} from '@docusaurus/utils-validation';

docusaurus/packages/docusaurus-plugin-content-blog/src/blogFrontMatter.ts

Line 78 in fd3c0c6

tags: FrontMatterTagsSchema,

[swyxio]

thank you!

[Josh-Cena]

Also, maybe we can elaborate in the documentation? After some pondering I think it's worth documenting both possibilities to avoid confusion.

[swyxio]

added!

[netlify]

✔️ [V2]
Built without sensitive environment variables

🔨 Explore the source changes: 07cc898

🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/6131db85383ece000808ec17

😎 Browse the preview: https://deploy-preview-5479--docusaurus-2.netlify.app

[github-actions]

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🟠 Performance	76
🟢 Accessibility	98
🟢 Best practices	100
🟢 SEO	100
🟢 PWA	95

Lighthouse ran on https://deploy-preview-5479--docusaurus-2.netlify.app/

[netlify]

✔️ [V2]

🔨 Explore the source changes: 8166cac

🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/6132038502ac780007994f1e

😎 Browse the preview: https://deploy-preview-5479--docusaurus-2.netlify.app

[slorber]

Thanks,

I'll edit it a bit before merge because Joi default messages are so bad in this case :)