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

refactor: unify error handling behavior (#6755)

Browse source 
* refactor: unify error handling behavior

* revert

* normalize paths

* test...

* change

* does this work...

* fix...

* maybe fix

* maybe fix

* fix

* fix...
This commit is contained in:
Joshua Chen 2022-02-25 15:07:13 +08:00 • committed by GitHub
parent dcbf9f644e
commit f903422617
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
58 changed files with 1123 additions and 299 deletions
Download patch file Download diff file Expand all files Collapse all files

8
packages/docusaurus-plugin-content-docs/src/__tests__/cli.test.ts
View file

@ -73,8 +73,8 @@ describe('docsVersion', () => {
DEFAULT_PLUGIN_ID,
DEFAULT_OPTIONS,
),
).rejects.toThrowErrorMatchingInlineSnapshot(
`"[docs]: invalid version tag specified! Do not include slash (/) or backslash (\\\\). Try something like: 1.0.0."`,
).rejects.toThrowError(
'[docs]: invalid version tag specified! Do not include slash (/) or backslash (\\). Try something like: 1.0.0.',
);
await expect(() =>
cliDocsVersionCommand(
@ -83,8 +83,8 @@ describe('docsVersion', () => {
DEFAULT_PLUGIN_ID,
DEFAULT_OPTIONS,
),
).rejects.toThrowErrorMatchingInlineSnapshot(
`"[docs]: invalid version tag specified! Do not include slash (/) or backslash (\\\\). Try something like: 1.0.0."`,
).rejects.toThrowError(
'[docs]: invalid version tag specified! Do not include slash (/) or backslash (\\). Try something like: 1.0.0.',
);
});

4
packages/docusaurus-plugin-content-docs/src/__tests__/docFrontMatter.test.ts
View file

@ -51,9 +51,9 @@ function testField(params: {
)}`,
),
);
} catch (e) {
} catch (err) {
// eslint-disable-next-line jest/no-conditional-expect
expect(e.message).toMatch(new RegExp(escapeStringRegexp(message)));
expect(err.message).toMatch(new RegExp(escapeStringRegexp(message)));
}
});
});

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

@ -123,15 +123,13 @@ function createTestUtils({
async function generateNavigation(
docFiles: DocFile[],
): Promise<[DocNavLink | undefined, DocNavLink | undefined][]> {
const rawDocs = await Promise.all(
docFiles.map((docFile) =>
processDocMetadata({
docFile,
versionMetadata,
context,
options,
}),
),
const rawDocs = docFiles.map((docFile) =>
processDocMetadata({
docFile,
versionMetadata,
context,
options,
}),
);
const sidebars = await loadSidebars(versionMetadata.sidebarFilePath, {
sidebarItemsGenerator: ({defaultSidebarItemsGenerator, ...args}) =>

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

@ -275,9 +275,9 @@ export function processDocMetadata(args: {
}): DocMetadataBase {
try {
return doProcessDocMetadata(args);
} catch (e) {
} catch (err) {
logger.error`Can't process doc metadata for doc at path path=${args.docFile.filePath} in version name=${args.versionMetadata.versionName}`;
throw e;
throw err;
}
}

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

@ -196,9 +196,9 @@ export default async function pluginContentDocs(
async function loadVersion(versionMetadata: VersionMetadata) {
try {
return await doLoadVersion(versionMetadata);
} catch (e) {
} catch (err) {
logger.error`Loading of version failed for version name=${versionMetadata.versionName}`;
throw e;
throw err;
}
}

6
packages/docusaurus-plugin-content-docs/src/lastUpdate.ts
View file

@ -27,12 +27,12 @@ export async function getFileLastUpdate(
includeAuthor: true,
});
return {timestamp: result.timestamp, author: result.author};
} catch (e) {
if (e instanceof GitNotFoundError && !showedGitRequirementError) {
} catch (err) {
if (err instanceof GitNotFoundError && !showedGitRequirementError) {
logger.warn('Sorry, the docs plugin last update options require Git.');
showedGitRequirementError = true;
} else {
logger.error(e);
logger.error(err);
}
return null;
}

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

@ -178,8 +178,8 @@ export async function createVersionRoutes({
try {
return await doCreateVersionRoutes(loadedVersion);
} catch (e) {
} catch (err) {
logger.error`Can't create version routes for version name=${loadedVersion.versionName}`;
throw e;
throw err;
}
}

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

@ -61,9 +61,9 @@ async function readCategoriesMetadata(contentPath: string) {
);
try {
return validateCategoryMetadataFile(Yaml.load(content));
} catch (e) {
} catch (err) {
logger.error`The docs sidebar category metadata file path=${filePath} looks invalid!`;
throw e;
throw err;
}
}),
);