refactor: handle all admonitions via JSX component (#7152)

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
This commit is contained in:
Alexey Pyltsyn 2022-06-03 15:26:33 +03:00 committed by GitHub
parent 17fe43ecc8
commit 5746c58f41
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
39 changed files with 709 additions and 250 deletions

View file

@ -63,7 +63,7 @@ describe('normalizeDocsPluginOptions', () => {
breadcrumbs: true,
showLastUpdateTime: true,
showLastUpdateAuthor: true,
admonitions: {},
admonitions: false,
includeCurrentVersion: false,
disableVersioning: true,
editCurrentVersion: true,
@ -84,7 +84,6 @@ describe('normalizeDocsPluginOptions', () => {
expect(testValidate(userOptions)).toEqual({
...defaultOptions,
...userOptions,
remarkPlugins: [...userOptions.remarkPlugins!, expect.any(Array)],
});
});
@ -102,7 +101,6 @@ describe('normalizeDocsPluginOptions', () => {
expect(testValidate(userOptions)).toEqual({
...defaultOptions,
...userOptions,
remarkPlugins: [...userOptions.remarkPlugins!, expect.any(Array)],
});
});
@ -116,14 +114,14 @@ describe('normalizeDocsPluginOptions', () => {
});
});
it('rejects admonitions true', () => {
const admonitionsTrue: Options = {
admonitions: true,
};
it('rejects admonitions array', () => {
expect(() =>
testValidate(admonitionsTrue),
testValidate({
// @ts-expect-error: rejected value
admonitions: [],
}),
).toThrowErrorMatchingInlineSnapshot(
`""admonitions" contains an invalid value"`,
`""admonitions" does not look like a valid admonitions config"`,
);
});