3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-10 15:47:23 +02:00
Code Issues Projects Releases Packages Wiki Activity

refactor(theme): split admonitions, make swizzle easier, better retrocompatibility (#7945)

Browse source 
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
This commit is contained in:
Sébastien Lorber 2022-09-07 17:49:44 +02:00 • committed by GitHub
parent f1415525c0
commit 6f63ffe0a3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
32 changed files with 914 additions and 236 deletions
Download patch file Download diff file Expand all files Collapse all files

2
packages/docusaurus-utils-validation/src/__tests__/__snapshots__/validationSchemas.test.ts.snap
View file

@ -20,7 +20,7 @@ You now need to swizzle the admonitions component to provide UI customizations s
Please refer to https://github.com/facebook/docusaurus/pull/7152 for detailed upgrade instructions."
`;
exports[`validation schemas admonitionsSchema: for value={"keywords":[]} 1`] = `""keywords" does not contain 1 required value(s)"`;
exports[`validation schemas admonitionsSchema: for value={"keywords":["custom-keyword"],"extendDefaults":42} 1`] = `""extendDefaults" must be a boolean"`;
exports[`validation schemas admonitionsSchema: for value={"tag":""} 1`] = `""tag" is not allowed to be empty"`;

9
packages/docusaurus-utils-validation/src/__tests__/validationSchemas.test.ts
View file

@ -96,13 +96,20 @@ describe('validation schemas', () => {
testOK({});
testOK({tag: '+++'});
testOK({keywords: ['info', 'tip']});
testOK({keywords: ['info', 'tip'], extendDefaults: true});
testOK({keywords: ['info', 'tip'], extendDefaults: false});
testOK({keywords: []});
testOK({keywords: [], extendDefaults: true}); // noop
testOK({keywords: [], extendDefaults: false}); // disable admonitions
testOK({tag: '+++', keywords: ['info', 'tip']});
testOK({tag: '+++', keywords: ['custom-keyword'], extendDefaults: true});
testOK({tag: '+++', keywords: ['custom-keyword'], extendDefaults: false});
testFail(3);
testFail([]);
testFail({unknownAttribute: 'val'});
testFail({tag: ''});
testFail({keywords: []});
testFail({keywords: ['custom-keyword'], extendDefaults: 42});
// Legacy types
testFail({

6
packages/docusaurus-utils-validation/src/validationSchemas.ts
View file

@ -44,8 +44,12 @@ export const AdmonitionsSchema = JoiFrontMatter.alternatives()
JoiFrontMatter.object({
tag: JoiFrontMatter.string(),
keywords: JoiFrontMatter.array().items(
JoiFrontMatter.string().required(),
JoiFrontMatter.string(),
// Apparently this is how we tell job to accept empty arrays...
// .required(),
),
extendDefaults: JoiFrontMatter.boolean(),
// TODO Remove before 2023
customTypes: LegacyAdmonitionConfigSchema,
icons: LegacyAdmonitionConfigSchema,