3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-13 08:12:48 +02:00
Code Issues Projects Releases Packages Wiki Activity

polish(v2): url-subpath config validation warning (#4977)

Browse source
This commit is contained in:
Sébastien Lorber 2021-06-15 18:18:12 +02:00 • committed by GitHub
parent dfe32dac9e
commit 9fe79caadc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 51 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

29
packages/docusaurus/src/server/__tests__/configValidation.test.ts
View file

@ -5,7 +5,11 @@
* LICENSE file in the root directory of this source tree.
*/
import {DEFAULT_CONFIG, validateConfig} from '../configValidation';
import {
ConfigSchema,
DEFAULT_CONFIG,
validateConfig,
} from '../configValidation';
import {DocusaurusConfig} from '@docusaurus/types';
const baseConfig = {
@ -197,3 +201,26 @@ describe('normalizeConfig', () => {
).toThrowErrorMatchingSnapshot();
});
});
describe('config warnings', () => {
function getWarning(config: unknown) {
return ConfigSchema.validate(config).warning;
}
test('baseConfig has no warning', () => {
const warning = getWarning(baseConfig);
expect(warning).toBeUndefined();
});
test('site url has warning when using subpath', () => {
const warning = getWarning({
...baseConfig,
url: 'https://mysite.com/someSubpath',
});
expect(warning).toBeDefined();
expect(warning?.details.length).toEqual(1);
expect(warning?.details[0].message).toMatchInlineSnapshot(
`"Docusaurus config validation warning. Field \\"url\\": the url is not supposed to contain a sub-path like '/someSubpath', please use the baseUrl field for sub-paths"`,
);
});
});