Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(core): configValidation should allow inline theme functions #6496

Merged
merged 1 commit into from
Jan 28, 2022
Merged

fix(core): configValidation should allow inline theme functions #6496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions packages/docusaurus/src/server/__tests__/__snapshots__/configValidation.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,76 @@ exports[`normalizeConfig should throw error if scripts doesn't have src 1`] = `
"
`;

exports[`normalizeConfig should throw error if themes is not a string and it's not an array #1 for the input of: [123] 1`] = `
" => Bad Docusaurus theme value as path [themes,0].
Example valid theme config:
{
themes: [
[\\"@docusaurus/theme-classic\\",options],
\\"./myTheme\\",
[\\"./myTheme\\",{someOption: 42}],
function myTheme() { },
[function myTheme() { },options]
],
};

"
`;

exports[`normalizeConfig should throw error if themes is not an array of [string, object][] #1 for the input of: [[Array]] 1`] = `
" => Bad Docusaurus theme value as path [themes,0].
Example valid theme config:
{
themes: [
[\\"@docusaurus/theme-classic\\",options],
\\"./myTheme\\",
[\\"./myTheme\\",{someOption: 42}],
function myTheme() { },
[function myTheme() { },options]
],
};

"
`;

exports[`normalizeConfig should throw error if themes is not an array of [string, object][] #2 for the input of: [[Array]] 1`] = `
" => Bad Docusaurus theme value as path [themes,0].
Example valid theme config:
{
themes: [
[\\"@docusaurus/theme-classic\\",options],
\\"./myTheme\\",
[\\"./myTheme\\",{someOption: 42}],
function myTheme() { },
[function myTheme() { },options]
],
};

"
`;

exports[`normalizeConfig should throw error if themes is not an array of [string, object][] #3 for the input of: [[Array]] 1`] = `
" => Bad Docusaurus theme value as path [themes,0].
Example valid theme config:
{
themes: [
[\\"@docusaurus/theme-classic\\",options],
\\"./myTheme\\",
[\\"./myTheme\\",{someOption: 42}],
function myTheme() { },
[function myTheme() { },options]
],
};

"
`;

exports[`normalizeConfig should throw error if themes is not array 1`] = `
"\\"themes\\" must be an array
"
`;

exports[`normalizeConfig should throw error if themes is not array for the input of: {} 1`] = `
"\\"themes\\" must be an array
"
`;
64 changes: 64 additions & 0 deletions packages/docusaurus/src/server/__tests__/configValidation.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,32 @@ describe('normalizeConfig', () => {
}).toThrowErrorMatchingSnapshot();
});

test.each([
['should throw error if themes is not array', {}],
[
"should throw error if themes is not a string and it's not an array #1",
[123],
],
[
'should throw error if themes is not an array of [string, object][] #1',
[['example/path', 'wrong parameter here']],
],
[
'should throw error if themes is not an array of [string, object][] #2',
[[{}, 'example/path']],
],
[
'should throw error if themes is not an array of [string, object][] #3',
[[{}, {}]],
],
])(`%s for the input of: %p`, (_message, themes) => {
expect(() => {
normalizeConfig({
themes,
});
}).toThrowErrorMatchingSnapshot();
});

test.each([
['should accept [string] for plugins', ['plain/string']],
[
Expand Down Expand Up @@ -155,6 +181,44 @@ describe('normalizeConfig', () => {
}).not.toThrowError();
});

test.each([
['should accept [string] for themes', ['plain/string']],
[
'should accept string[] for themes',
['plain/string', 'another/plain/string/path'],
],
[
'should accept [string, object] for themes',
[['plain/string', {it: 'should work'}]],
],
[
'should accept [string, object][] for themes',
[
['plain/string', {it: 'should work'}],
['this/should/work', {too: 'yes'}],
],
],
[
'should accept ([string, object]|string)[] for themes',
[
'plain/string',
['plain', {it: 'should work'}],
['this/should/work', {too: 'yes'}],
],
],
['should accept function for theme', [function (_context, _options) {}]],
[
'should accept [function, object] for theme',
[[function (_context, _options) {}, {it: 'should work'}]],
],
])(`%s for the input of: %p`, (_message, themes) => {
expect(() => {
normalizeConfig({
themes,
});
}).not.toThrowError();
});

test('should throw error if themes is not array', () => {
expect(() => {
normalizeConfig({
Expand Down
64 changes: 41 additions & 23 deletions packages/docusaurus/src/server/configValidation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,21 +55,33 @@ export const DEFAULT_CONFIG: Pick<
staticDirectories: [STATIC_DIR_NAME],
};

const PluginSchema = Joi.alternatives()
.try(
Joi.function(),
Joi.array().ordered(Joi.function().required(), Joi.object().required()),
Joi.string(),
Joi.array()
.ordered(Joi.string().required(), Joi.object().required())
.length(2),
Joi.bool().equal(false), // In case of conditional adding of plugins.
)
// @ts-expect-error: bad lib def, doesn't recognize an array of reports
.error((errors) => {
errors.forEach((error) => {
error.message = ` => Bad Docusaurus plugin value as path [${error.path}].
Example valid plugin config:
function createPluginSchema(theme: boolean = false) {
return (
Joi.alternatives()
.try(
Joi.function(),
Joi.array().ordered(Joi.function().required(), Joi.object().required()),
Joi.string(),
Joi.array()
.ordered(Joi.string().required(), Joi.object().required())
.length(2),
Joi.bool().equal(false), // In case of conditional adding of plugins.
)
// @ts-expect-error: bad lib def, doesn't recognize an array of reports
.error((errors) => {
errors.forEach((error) => {
const validConfigExample = theme
? `Example valid theme config:
{
themes: [
["@docusaurus/theme-classic",options],
"./myTheme",
["./myTheme",{someOption: 42}],
function myTheme() { },
[function myTheme() { },options]
],
};`
: `Example valid plugin config:
{
plugins: [
["@docusaurus/plugin-content-docs",options],
Expand All @@ -78,16 +90,22 @@ Example valid plugin config:
function myPlugin() { },
[function myPlugin() { },options]
],
};
};`;

error.message = ` => Bad Docusaurus ${
theme ? 'theme' : 'plugin'
} value as path [${error.path}].
${validConfigExample}
`;
});
return errors;
});
});
return errors;
})
);
}

const ThemeSchema = Joi.alternatives().try(
Joi.string(),
Joi.array().items(Joi.string().required(), Joi.object().required()).length(2),
);
const PluginSchema = createPluginSchema(false);

const ThemeSchema = createPluginSchema(true);

const PresetSchema = Joi.alternatives().try(
Joi.string(),
Expand Down