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

fix(v2): fix validation rejecting admonitions false (#4629)

Browse source 
Prevents disabling default admonitions as documented under
https://docusaurus.io/docs/presets#official-presets
This commit is contained in:
kazk 2021-04-19 01:49:58 -07:00 • committed by GitHub
parent 808b0fa62a
commit 5088a1e48f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 24 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

21
packages/docusaurus-plugin-content-docs/src/__tests__/options.test.ts
View file

@ -74,6 +74,27 @@ describe('normalizeDocsPluginOptions', () => {
expect(error).toBe(undefined);
});
test('should accept admonitions false', async () => {
const admonitionsFalse = {
...DEFAULT_OPTIONS,
admonitions: false,
};
const {value, error} = OptionsSchema.validate(admonitionsFalse);
expect(value).toEqual(admonitionsFalse);
expect(error).toBe(undefined);
});
test('should reject admonitions true', async () => {
const admonitionsTrue = {
...DEFAULT_OPTIONS,
admonitions: true,
};
const {error} = OptionsSchema.validate(admonitionsTrue);
expect(error).toMatchInlineSnapshot(
`[ValidationError: "admonitions" contains an invalid value]`,
);
});
test('should reject invalid remark plugin options', () => {
expect(() => {
normalizePluginOptions(OptionsSchema, {

4
packages/docusaurus-plugin-content-docs/src/options.ts
View file

@ -76,7 +76,9 @@ export const OptionsSchema = Joi.object({
beforeDefaultRehypePlugins: RehypePluginsSchema.default(
DEFAULT_OPTIONS.beforeDefaultRehypePlugins,
),
admonitions: AdmonitionsSchema.default(DEFAULT_OPTIONS.admonitions),
admonitions: Joi.alternatives()
.try(AdmonitionsSchema, Joi.boolean().invalid(true))
.default(DEFAULT_OPTIONS.admonitions),
showLastUpdateTime: Joi.bool().default(DEFAULT_OPTIONS.showLastUpdateTime),
showLastUpdateAuthor: Joi.bool().default(
DEFAULT_OPTIONS.showLastUpdateAuthor,