diff --git a/jest/snapshotPathNormalizer.ts b/jest/snapshotPathNormalizer.ts index 485c70b4b1..957aef8c40 100644 --- a/jest/snapshotPathNormalizer.ts +++ b/jest/snapshotPathNormalizer.ts @@ -142,7 +142,7 @@ function getRealPath(pathname: string) { // eslint-disable-next-line no-restricted-properties const realPath = fs.realpathSync(pathname); return realPath; - } catch (error) { + } catch (err) { return pathname; } } diff --git a/packages/docusaurus-plugin-client-redirects/src/__tests__/writeRedirectFiles.test.ts b/packages/docusaurus-plugin-client-redirects/src/__tests__/writeRedirectFiles.test.ts index 215d968b73..739c2f6a99 100644 --- a/packages/docusaurus-plugin-client-redirects/src/__tests__/writeRedirectFiles.test.ts +++ b/packages/docusaurus-plugin-client-redirects/src/__tests__/writeRedirectFiles.test.ts @@ -199,8 +199,10 @@ describe('writeRedirectFiles', () => { 'file already exists!', ); - await expect(writeRedirectFiles(filesMetadata)).rejects.toThrowError( - `Redirect file creation error for "${filesMetadata[0].fileAbsolutePath}" path: Error: The redirect plugin is not supposed to override existing files.`, + await expect( + writeRedirectFiles(filesMetadata), + ).rejects.toThrowErrorMatchingInlineSnapshot( + `"The redirect plugin is not supposed to override existing files."`, ); }); }); diff --git a/packages/docusaurus-plugin-client-redirects/src/writeRedirectFiles.ts b/packages/docusaurus-plugin-client-redirects/src/writeRedirectFiles.ts index e0a8cabd7a..3924f60214 100644 --- a/packages/docusaurus-plugin-client-redirects/src/writeRedirectFiles.ts +++ b/packages/docusaurus-plugin-client-redirects/src/writeRedirectFiles.ts @@ -12,6 +12,7 @@ import _ from 'lodash'; import type {PluginContext, RedirectMetadata} from './types'; import createRedirectPageContent from './createRedirectPageContent'; import {normalizeUrl} from '@docusaurus/utils'; +import logger from '@docusaurus/logger'; export type WriteFilesPluginContext = Pick; @@ -100,9 +101,8 @@ export async function writeRedirectFile( {flag: 'wx'}, ); } catch (err) { - throw new Error( - `Redirect file creation error for "${file.fileAbsolutePath}" path: ${err}.`, - ); + logger.error`Redirect file creation error for path=${file.fileAbsolutePath}.`; + throw err; } } diff --git a/packages/docusaurus-plugin-content-blog/src/feed.ts b/packages/docusaurus-plugin-content-blog/src/feed.ts index 0a465f8582..390d453f48 100644 --- a/packages/docusaurus-plugin-content-blog/src/feed.ts +++ b/packages/docusaurus-plugin-content-blog/src/feed.ts @@ -18,6 +18,7 @@ import type { BlogPost, } from '@docusaurus/plugin-content-blog'; import {blogPostContainerID} from '@docusaurus/utils-common'; +import logger from '@docusaurus/logger'; async function generateBlogFeed({ blogPosts, @@ -127,7 +128,8 @@ async function createBlogFeedFile({ try { await fs.outputFile(path.join(generatePath, feedPath), feedContent); } catch (err) { - throw new Error(`Generating ${feedType} feed failed: ${err}.`); + logger.error(`Generating ${feedType} feed failed.`); + throw err; } } diff --git a/packages/docusaurus-plugin-content-docs/src/cli.ts b/packages/docusaurus-plugin-content-docs/src/cli.ts index 6c01987056..4a84ea9530 100644 --- a/packages/docusaurus-plugin-content-docs/src/cli.ts +++ b/packages/docusaurus-plugin-content-docs/src/cli.ts @@ -64,9 +64,9 @@ export async function cliDocsVersionCommand( try { validateVersionName(version); - } catch (e) { + } catch (err) { logger.info`${pluginIdLogPrefix}: Invalid version name provided. Try something like: 1.0.0`; - throw e; + throw err; } // Load existing versions. diff --git a/packages/docusaurus-plugin-sitemap/package.json b/packages/docusaurus-plugin-sitemap/package.json index 173498665e..deabe52f37 100644 --- a/packages/docusaurus-plugin-sitemap/package.json +++ b/packages/docusaurus-plugin-sitemap/package.json @@ -19,6 +19,7 @@ "license": "MIT", "dependencies": { "@docusaurus/core": "2.0.0-beta.20", + "@docusaurus/logger": "2.0.0-beta.20", "@docusaurus/utils": "2.0.0-beta.20", "@docusaurus/utils-common": "2.0.0-beta.20", "@docusaurus/utils-validation": "2.0.0-beta.20", diff --git a/packages/docusaurus-plugin-sitemap/src/index.ts b/packages/docusaurus-plugin-sitemap/src/index.ts index 3f52b8cf60..9d9f75a442 100644 --- a/packages/docusaurus-plugin-sitemap/src/index.ts +++ b/packages/docusaurus-plugin-sitemap/src/index.ts @@ -7,6 +7,7 @@ import fs from 'fs-extra'; import path from 'path'; +import logger from '@docusaurus/logger'; import createSitemap from './createSitemap'; import type {PluginOptions, Options} from './options'; import type {LoadContext, Plugin} from '@docusaurus/types'; @@ -35,7 +36,8 @@ export default function pluginSitemap( try { await fs.outputFile(sitemapPath, generatedSitemap); } catch (err) { - throw new Error(`Writing sitemap failed: ${err}`); + logger.error('Writing sitemap failed.'); + throw err; } }, }; diff --git a/packages/docusaurus/src/commands/swizzle/config.ts b/packages/docusaurus/src/commands/swizzle/config.ts index a16c7dfd4a..f62b0ad795 100644 --- a/packages/docusaurus/src/commands/swizzle/config.ts +++ b/packages/docusaurus/src/commands/swizzle/config.ts @@ -10,6 +10,7 @@ import type {SwizzleComponentConfig, SwizzleConfig} from '@docusaurus/types'; import type {SwizzlePlugin} from './common'; import {SwizzleActions, SwizzleActionsStatuses} from './common'; import {getPluginByThemeName} from './themes'; +import logger from '@docusaurus/logger'; function getModuleSwizzleConfig( swizzlePlugin: SwizzlePlugin, @@ -103,12 +104,9 @@ export function getThemeSwizzleConfig( if (config) { try { return normalizeSwizzleConfig(config); - } catch (e) { - throw new Error( - `Invalid Swizzle config for theme ${themeName}.\n${ - (e as Error).message - }`, - ); + } catch (err) { + logger.error`Invalid Swizzle config for theme name=${themeName}.`; + throw err; } } return FallbackSwizzleConfig; diff --git a/packages/docusaurus/src/webpack/__tests__/utils.test.ts b/packages/docusaurus/src/webpack/__tests__/utils.test.ts index 410824ec65..664679e3f6 100644 --- a/packages/docusaurus/src/webpack/__tests__/utils.test.ts +++ b/packages/docusaurus/src/webpack/__tests__/utils.test.ts @@ -343,17 +343,13 @@ describe('getHttpsConfig', () => { process.env.HTTPS = 'true'; process.env.SSL_CRT_FILE = path.join(__dirname, '__fixtures__/host.crt'); process.env.SSL_KEY_FILE = path.join(__dirname, '__fixtures__/invalid.key'); - await expect(getHttpsConfig()).rejects.toThrowError( - /The certificate key .*[/\\]__fixtures__[/\\]invalid\.key is invalid/, - ); + await expect(getHttpsConfig()).rejects.toThrowError(); }); it('throws for invalid cert', async () => { process.env.HTTPS = 'true'; process.env.SSL_CRT_FILE = path.join(__dirname, '__fixtures__/invalid.crt'); process.env.SSL_KEY_FILE = path.join(__dirname, '__fixtures__/host.key'); - await expect(getHttpsConfig()).rejects.toThrowError( - /The certificate .*[/\\]__fixtures__[/\\]invalid\.crt is invalid/, - ); + await expect(getHttpsConfig()).rejects.toThrowError(); }); }); diff --git a/packages/docusaurus/src/webpack/utils.ts b/packages/docusaurus/src/webpack/utils.ts index 1e823c6943..8f32ddc277 100644 --- a/packages/docusaurus/src/webpack/utils.ts +++ b/packages/docusaurus/src/webpack/utils.ts @@ -291,20 +291,16 @@ function validateKeyAndCerts({ // publicEncrypt will throw an error with an invalid cert encrypted = crypto.publicEncrypt(cert, Buffer.from('test')); } catch (err) { - throw new Error( - `The certificate ${crtFile} is invalid. -${err}`, - ); + logger.error`The certificate path=${crtFile} is invalid.`; + throw err; } try { // privateDecrypt will throw an error with an invalid key crypto.privateDecrypt(key, encrypted); } catch (err) { - throw new Error( - `The certificate key ${keyFile} is invalid. -${err}`, - ); + logger.error`The certificate key path=${keyFile} is invalid.`; + throw err; } }