From 4b2152a96447321c33584769b9b2279ec2f56f1b Mon Sep 17 00:00:00 2001 From: Joshua Chen Date: Thu, 28 Oct 2021 12:47:40 +0800 Subject: [PATCH] refactor: clear a few ESLint warnings (#5808) * refactor: clear a few ESLint warnings Signed-off-by: Josh-Cena * Fix --- .../docusaurus-module-type-aliases/src/index.d.ts | 8 ++++++-- .../src/collectRedirects.ts | 6 +++--- .../src/theme/DocPage/index.tsx | 2 +- .../src/utils/storageUtils.ts | 4 ++-- packages/docusaurus-utils/src/markdownParser.ts | 4 ++-- .../src/server/translations/translations.ts | 7 ++++--- .../server/translations/translationsExtractor.ts | 13 +++++++++---- .../src/webpack/plugins/CleanWebpackPlugin.ts | 5 ++--- packages/docusaurus/src/webpack/utils.ts | 12 ++++++------ 9 files changed, 35 insertions(+), 26 deletions(-) diff --git a/packages/docusaurus-module-type-aliases/src/index.d.ts b/packages/docusaurus-module-type-aliases/src/index.d.ts index d61de8b4da..0f172b9304 100644 --- a/packages/docusaurus-module-type-aliases/src/index.d.ts +++ b/packages/docusaurus-module-type-aliases/src/index.d.ts @@ -6,6 +6,7 @@ */ declare module '@generated/client-modules' { + // eslint-disable-next-line @typescript-eslint/no-explicit-any const clientModules: readonly any[]; export default clientModules; } @@ -26,6 +27,7 @@ declare module '@generated/site-metadata' { declare module '@generated/registry' { const registry: { + // eslint-disable-next-line @typescript-eslint/no-explicit-any readonly [key: string]: [() => Promise, string, string]; }; export default registry; @@ -50,7 +52,8 @@ declare module '@generated/routesChunkNames' { } declare module '@generated/globalData' { - const globalData: Record; + // eslint-disable-next-line @typescript-eslint/no-explicit-any + const globalData: Record; export default globalData; } @@ -89,7 +92,7 @@ declare module '@theme/Loading' { } declare module '@theme/NotFound' { - export default function NotFound(props: any): JSX.Element; + export default function NotFound(): JSX.Element; } declare module '@theme/Root' { @@ -292,6 +295,7 @@ declare module '@docusaurus/useGlobalData' { pluginId?: string, ): T; + // eslint-disable-next-line @typescript-eslint/no-explicit-any function useGlobalData(): Record; export default useGlobalData; } diff --git a/packages/docusaurus-plugin-client-redirects/src/collectRedirects.ts b/packages/docusaurus-plugin-client-redirects/src/collectRedirects.ts index 212a0505f4..ab78bff310 100644 --- a/packages/docusaurus-plugin-client-redirects/src/collectRedirects.ts +++ b/packages/docusaurus-plugin-client-redirects/src/collectRedirects.ts @@ -59,13 +59,13 @@ function validateCollectedRedirects( redirects: RedirectMetadata[], pluginContext: PluginContext, ) { - const redirectValidationErrors: string[] = redirects + const redirectValidationErrors = redirects .map((redirect) => { try { validateRedirect(redirect); return undefined; - } catch (e: any) { - return e.message; + } catch (e) { + return (e as Error).message; } }) .filter(Boolean); diff --git a/packages/docusaurus-theme-classic/src/theme/DocPage/index.tsx b/packages/docusaurus-theme-classic/src/theme/DocPage/index.tsx index ebb2ff1abb..df3a2a29d2 100644 --- a/packages/docusaurus-theme-classic/src/theme/DocPage/index.tsx +++ b/packages/docusaurus-theme-classic/src/theme/DocPage/index.tsx @@ -148,7 +148,7 @@ function DocPage(props: Props): JSX.Element { matchPath(location.pathname, docRoute), ); if (!currentDocRoute) { - return ; + return ; } return ( <> diff --git a/packages/docusaurus-theme-common/src/utils/storageUtils.ts b/packages/docusaurus-theme-common/src/utils/storageUtils.ts index ede104f69a..adee0d2240 100644 --- a/packages/docusaurus-theme-common/src/utils/storageUtils.ts +++ b/packages/docusaurus-theme-common/src/utils/storageUtils.ts @@ -26,8 +26,8 @@ function getBrowserStorage( } else { try { return window[storageType]; - } catch (e: any) { - logOnceBrowserStorageNotAvailableWarning(e); + } catch (e) { + logOnceBrowserStorageNotAvailableWarning(e as Error); return null; } } diff --git a/packages/docusaurus-utils/src/markdownParser.ts b/packages/docusaurus-utils/src/markdownParser.ts index 2694587fd3..3649b123e8 100644 --- a/packages/docusaurus-utils/src/markdownParser.ts +++ b/packages/docusaurus-utils/src/markdownParser.ts @@ -181,9 +181,9 @@ export async function parseMarkdownFile( const markdownString = await fs.readFile(source, 'utf-8'); try { return parseMarkdownString(markdownString, options); - } catch (e: any) { + } catch (e) { throw new Error( - `Error while parsing Markdown file ${source}: "${e.message}".`, + `Error while parsing Markdown file ${source}: "${(e as Error).message}".`, ); } } diff --git a/packages/docusaurus/src/server/translations/translations.ts b/packages/docusaurus/src/server/translations/translations.ts index 0349fab61d..780cafc7de 100644 --- a/packages/docusaurus/src/server/translations/translations.ts +++ b/packages/docusaurus/src/server/translations/translations.ts @@ -55,9 +55,10 @@ export async function readTranslationFileContent( const content = JSON.parse(await fs.readFile(filePath, 'utf8')); ensureTranslationFileContent(content); return content; - // eslint-disable-next-line @typescript-eslint/no-explicit-any - } catch (e: any) { - throw new Error(`Invalid translation file at ${filePath}.\n${e.message}`); + } catch (e) { + throw new Error( + `Invalid translation file at ${filePath}.\n${(e as Error).message}`, + ); } } return undefined; diff --git a/packages/docusaurus/src/server/translations/translationsExtractor.ts b/packages/docusaurus/src/server/translations/translationsExtractor.ts index 5ec63ba12f..31d0fcaf34 100644 --- a/packages/docusaurus/src/server/translations/translationsExtractor.ts +++ b/packages/docusaurus/src/server/translations/translationsExtractor.ts @@ -157,10 +157,15 @@ export async function extractSourceCodeFileTranslations( filename: sourceCodeFilePath, }) as Node; - return await extractSourceCodeAstTranslations(ast, sourceCodeFilePath); - // eslint-disable-next-line @typescript-eslint/no-explicit-any - } catch (e: any) { - e.message = `Error while attempting to extract Docusaurus translations from source code file at path=${sourceCodeFilePath}\n${e.message}`; + const translations = await extractSourceCodeAstTranslations( + ast, + sourceCodeFilePath, + ); + return translations; + } catch (e) { + if (e instanceof Error) { + e.message = `Error while attempting to extract Docusaurus translations from source code file at path=${sourceCodeFilePath}\n${e.message}`; + } throw e; } } diff --git a/packages/docusaurus/src/webpack/plugins/CleanWebpackPlugin.ts b/packages/docusaurus/src/webpack/plugins/CleanWebpackPlugin.ts index f9b63c0068..ad94244fce 100644 --- a/packages/docusaurus/src/webpack/plugins/CleanWebpackPlugin.ts +++ b/packages/docusaurus/src/webpack/plugins/CleanWebpackPlugin.ts @@ -234,11 +234,10 @@ class CleanWebpackPlugin { console.warn(`clean-webpack-plugin: removed ${filename}`); }); } - // eslint-disable-next-line @typescript-eslint/no-explicit-any - } catch (error: any) { + } catch (error) { const needsForce = /Cannot delete files\/folders outside the current working directory\./.test( - error.message, + (error as Error).message, ); if (needsForce) { diff --git a/packages/docusaurus/src/webpack/utils.ts b/packages/docusaurus/src/webpack/utils.ts index 4d75cb0d40..a4bc7bce14 100644 --- a/packages/docusaurus/src/webpack/utils.ts +++ b/packages/docusaurus/src/webpack/utils.ts @@ -457,21 +457,21 @@ function validateKeyAndCerts({ try { // publicEncrypt will throw an error with an invalid cert encrypted = crypto.publicEncrypt(cert, Buffer.from('test')); - // eslint-disable-next-line @typescript-eslint/no-explicit-any - } catch (err: any) { + } catch (err) { throw new Error( - `The certificate "${chalk.yellow(crtFile)}" is invalid.\n${err.message}`, + `The certificate "${chalk.yellow(crtFile)}" is invalid.\n${ + (err as Error).message + }`, ); } try { // privateDecrypt will throw an error with an invalid key crypto.privateDecrypt(key, encrypted); - // eslint-disable-next-line @typescript-eslint/no-explicit-any - } catch (err: any) { + } catch (err) { throw new Error( `The certificate key "${chalk.yellow(keyFile)}" is invalid.\n${ - err.message + (err as Error).message }`, ); }