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: baseUrl passed to sortConfig #5824

Merged
merged 1 commit into from Oct 29, 2021
Merged

fix: baseUrl passed to sortConfig #5824

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
45 changes: 45 additions & 0 deletions packages/docusaurus/src/server/plugins/__tests__/__snapshots__/init.test.ts.snap
View file
Open in desktop
Expand Up @@ -82,3 +82,48 @@ Array [
},
]
`;

exports[`sortConfig should sort route config given a baseURL 1`] = `
Array [
Object {
"component": "",
"path": "/latest/community",
},
Object {
"component": "",
"path": "/latest/example",
},
Object {
"component": "",
"path": "/latest/some-page",
},
Object {
"component": "",
"path": "/latest/docs",
"routes": Array [
Object {
"component": "",
"path": "/latest/docs/someDoc",
},
Object {
"component": "",
"path": "/latest/docs/someOtherDoc",
},
],
},
Object {
"component": "",
"path": "/latest",
"routes": Array [
Object {
"component": "",
"path": "/latest/someDoc",
},
Object {
"component": "",
"path": "/latest/someOtherDoc",
},
],
},
]
`;
38 changes: 38 additions & 0 deletions packages/docusaurus/src/server/plugins/__tests__/init.test.ts
View file
Open in desktop
Expand Up @@ -87,4 +87,42 @@ describe('sortConfig', () => {

expect(routes).toMatchSnapshot();
});

test('should sort route config given a baseURL', () => {
const baseURL = '/latest';
const routes: RouteConfig[] = [
{
path: baseURL,
component: '',
routes: [
{path: `${baseURL}/someDoc`, component: ''},
{path: `${baseURL}/someOtherDoc`, component: ''},
],
},
{
path: `${baseURL}/example`,
component: '',
},
{
path: `${baseURL}/docs`,
component: '',
routes: [
{path: `${baseURL}/docs/someDoc`, component: ''},
{path: `${baseURL}/docs/someOtherDoc`, component: ''},
],
},
{
path: `${baseURL}/community`,
component: '',
},
{
path: `${baseURL}/some-page`,
component: '',
},
];

sortConfig(routes, baseURL);

expect(routes).toMatchSnapshot();
});
});
11 changes: 7 additions & 4 deletions packages/docusaurus/src/server/plugins/index.ts
View file
Open in desktop
Expand Up @@ -26,15 +26,18 @@ import {chain} from 'lodash';
import {localizePluginTranslationFile} from '../translations/translations';
import applyRouteTrailingSlash from './applyRouteTrailingSlash';

export function sortConfig(routeConfigs: RouteConfig[]): void {
export function sortConfig(
routeConfigs: RouteConfig[],
baseUrl: string = '/',
): void {
// Sort the route config. This ensures that route with nested
// routes is always placed last.
routeConfigs.sort((a, b) => {
// Root route should get placed last.
if (a.path === '/' && b.path !== '/') {
if (a.path === baseUrl && b.path !== baseUrl) {
return 1;
}
if (a.path !== '/' && b.path === '/') {
if (a.path !== baseUrl && b.path === baseUrl) {
return -1;
}

Expand Down Expand Up @@ -221,7 +224,7 @@ export async function loadPlugins({

// Sort the route config. This ensures that route with nested
// routes are always placed last.
sortConfig(pluginsRouteConfigs);
sortConfig(pluginsRouteConfigs, context.siteConfig.baseUrl);

// Apply each plugin one after the other to translate the theme config
function translateThemeConfig(
Expand Down