3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-21 20:17:50 +02:00
Code Issues Projects Releases Packages Wiki Activity

refactor: mark all functions that import external modules as async (#6521)

Browse source
This commit is contained in:
Joshua Chen 2022-01-31 13:04:45 +08:00 • committed by GitHub
parent aa446b7a9c
commit c56e6194b4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
15 changed files with 125 additions and 112 deletions
Download patch file Download diff file Expand all files Collapse all files

18
packages/docusaurus-plugin-content-docs/src/sidebars/index.ts
View file

@ -38,9 +38,9 @@ export function resolveSidebarPathOption(
: sidebarPathOption;
}
function loadSidebarsFileUnsafe(
async function loadSidebarsFileUnsafe(
sidebarFilePath: string | false | undefined,
): SidebarsConfig {
): Promise<SidebarsConfig> {
// false => no sidebars
if (sidebarFilePath === false) {
return DisabledSidebars;
@ -62,19 +62,19 @@ function loadSidebarsFileUnsafe(
return importFresh(sidebarFilePath);
}
export function loadSidebarsFile(
export async function loadSidebarsFile(
sidebarFilePath: string | false | undefined,
): SidebarsConfig {
const sidebarsConfig = loadSidebarsFileUnsafe(sidebarFilePath);
): Promise<SidebarsConfig> {
const sidebarsConfig = await loadSidebarsFileUnsafe(sidebarFilePath);
validateSidebars(sidebarsConfig);
return sidebarsConfig;
}
export function loadNormalizedSidebars(
export async function loadNormalizedSidebars(
sidebarFilePath: string | false | undefined,
params: NormalizeSidebarsParams,
): NormalizedSidebars {
return normalizeSidebars(loadSidebarsFile(sidebarFilePath), params);
): Promise<NormalizedSidebars> {
return normalizeSidebars(await loadSidebarsFile(sidebarFilePath), params);
}
// Note: sidebarFilePath must be absolute, use resolveSidebarPathOption
@ -87,7 +87,7 @@ export async function loadSidebars(
version: options.version,
categoryLabelSlugger: createSlugger(),
};
const normalizedSidebars = loadNormalizedSidebars(
const normalizedSidebars = await loadNormalizedSidebars(
sidebarFilePath,
normalizeSidebarsParams,
);