refactor(core): enforce noImplicitAny (#5605)

Josh-Cena · web-flow · commit 452f85b5a31d · 2021-09-23T15:25:16.000+02:00
* Initial work

Signed-off-by: Josh-Cena &lt;sidachen2003@gmail.com&gt;

* Fix errors

Signed-off-by: Josh-Cena &lt;sidachen2003@gmail.com&gt;

* Remove .d.ts files

Signed-off-by: Josh-Cena &lt;sidachen2003@gmail.com&gt;

* Fix

Signed-off-by: Josh-Cena &lt;sidachen2003@gmail.com&gt;
diff --git a/packages/docusaurus/package.json b/packages/docusaurus/package.json
@@ -32,8 +32,17 @@
   },
   "devDependencies": {
     "@docusaurus/module-type-aliases": "2.0.0-beta.6",
+    "@types/copy-webpack-plugin": "^8.0.1",
+    "@types/css-minimizer-webpack-plugin": "^3.0.2",
     "@types/detect-port": "^1.3.0",
+    "@types/mini-css-extract-plugin": "^2.3.0",
+    "@types/module-alias": "^2.0.1",
     "@types/nprogress": "^0.2.0",
+    "@types/react-dom": "^17.0.9",
+    "@types/rtl-detect": "^1.0.0",
+    "@types/serve-handler": "^6.1.1",
+    "@types/terser-webpack-plugin": "^5.2.0",
+    "@types/webpack-bundle-analyzer": "^4.4.1",
     "tmp-promise": "^3.0.2"
   },
   "dependencies": {
diff --git a/packages/docusaurus/src/client/baseUrlIssueBanner/BaseUrlIssueBanner.tsx b/packages/docusaurus/src/client/baseUrlIssueBanner/BaseUrlIssueBanner.tsx
@@ -80,7 +80,8 @@ function BaseUrlIssueBannerEnabled() {
   // useLayoutEffect fires before DOMContentLoaded.
   // It gives the opportunity to avoid inserting the banner in the first place
   useLayoutEffect(() => {
-    window[InsertBannerWindowAttribute] = false;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    (window as any)[InsertBannerWindowAttribute] = false;
   }, []);
 
   return (
diff --git a/packages/docusaurus/src/client/templates/ssr.html.template.d.ts b/packages/docusaurus/src/client/templates/ssr.html.template.d.ts
@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+const template: string;
+export default template;
diff --git a/packages/docusaurus/src/commands/deploy.ts b/packages/docusaurus/src/commands/deploy.ts
@@ -16,14 +16,14 @@ import os from 'os';
 import {buildUrl} from './buildRemoteBranchUrl';
 
 // GIT_PASS env variable should not appear in logs
-function obfuscateGitPass(str) {
+function obfuscateGitPass(str: string) {
   const gitPass = process.env.GIT_PASS;
   return gitPass ? str.replace(gitPass, 'GIT_PASS') : str;
 }
 
 // Log executed commands so that user can figure out mistakes on his own
 // for example: https://github.com/facebook/docusaurus/issues/3875
-function shellExecLog(cmd) {
+function shellExecLog(cmd: string) {
   try {
     const result = shell.exec(cmd);
     console.log(
@@ -162,7 +162,7 @@ Try using DEPLOYMENT_BRANCH=main or DEPLOYMENT_BRANCH=master`);
   // out to deployment branch.
   const currentCommit = shellExecLog('git rev-parse HEAD').stdout.trim();
 
-  const runDeploy = async (outputDirectory) => {
+  const runDeploy = async (outputDirectory: string) => {
     const fromPath = outputDirectory;
     const toPath = await fs.mkdtemp(
       path.join(os.tmpdir(), `${projectName}-${deploymentBranch}`),
diff --git a/packages/docusaurus/src/commands/start.ts b/packages/docusaurus/src/commands/start.ts
@@ -88,22 +88,22 @@ export default async function start(
   }, 500);
   const {siteConfig, plugins = []} = props;
 
-  const normalizeToSiteDir = (filepath) => {
+  const normalizeToSiteDir = (filepath: string) => {
     if (filepath && path.isAbsolute(filepath)) {
       return posixPath(path.relative(siteDir, filepath));
     }
     return posixPath(filepath);
   };
 
-  const pluginPaths: string[] = ([] as string[])
+  const pluginPaths = ([] as string[])
     .concat(
       ...plugins
         .map((plugin) => plugin.getPathsToWatch?.() ?? [])
         .filter(Boolean),
     )
     .map(normalizeToSiteDir);
 
-  const pathsToWatch: string[] = [
+  const pathsToWatch = [
     ...pluginPaths,
     props.siteConfigPath,
     getTranslationsLocaleDirPath({
diff --git a/packages/docusaurus/src/server/index.ts b/packages/docusaurus/src/server/index.ts
@@ -224,7 +224,7 @@ function createMDXFallbackPlugin({siteDir}: {siteDir: string}): LoadedPlugin {
                   loader: require.resolve('@docusaurus/mdx-loader'),
                   options: {
                     staticDir: path.join(siteDir, STATIC_DIR_NAME),
-                    isMDXPartial: (_filename) => true, // External mdx files are always meant to be imported as partials
+                    isMDXPartial: (_filename: string) => true, // External mdx files are always meant to be imported as partials
                     isMDXPartialFrontMatterWarningDisabled: true, // External mdx files might have frontmatter, let's just disable the warning
                     remarkPlugins: [admonitions],
                   },
diff --git a/packages/docusaurus/src/server/plugins/index.ts b/packages/docusaurus/src/server/plugins/index.ts
@@ -123,7 +123,7 @@ export async function loadPlugins({
   // 3. Plugin Lifecycle - contentLoaded.
   const pluginsRouteConfigs: RouteConfig[] = [];
 
-  const globalData = {};
+  const globalData: Record<string, Record<string, unknown>> = {};
 
   await Promise.all(
     contentLoadedTranslatedPlugins.map(
diff --git a/packages/docusaurus/src/server/routes.ts b/packages/docusaurus/src/server/routes.ts
@@ -21,6 +21,10 @@ import {
   ChunkNames,
 } from '@docusaurus/types';
 
+type RegistryMap = {
+  [chunkName: string]: ChunkRegistry;
+};
+
 function indent(str: string) {
   const spaces = '  ';
   return `${spaces}${str.replace(/(\n)/g, `\n${spaces}`)}`;
@@ -183,15 +187,38 @@ ${indent(NotFoundRouteCode)}
   };
 }
 
+function genRouteChunkNames(
+  registry: RegistryMap,
+  value: Module,
+  prefix?: string,
+  name?: string,
+): string;
+function genRouteChunkNames(
+  registry: RegistryMap,
+  value: RouteModule,
+  prefix?: string,
+  name?: string,
+): ChunkNames;
+function genRouteChunkNames(
+  registry: RegistryMap,
+  value: RouteModule[],
+  prefix?: string,
+  name?: string,
+): ChunkNames[];
+function genRouteChunkNames(
+  registry: RegistryMap,
+  value: RouteModule | RouteModule[] | Module,
+  prefix?: string,
+  name?: string,
+): ChunkNames | ChunkNames[] | string;
+
 function genRouteChunkNames(
   // TODO instead of passing a mutating the registry, return a registry slice?
-  registry: {
-    [chunkName: string]: ChunkRegistry;
-  },
+  registry: RegistryMap,
   value: RouteModule | RouteModule[] | Module | null | undefined,
   prefix?: string,
   name?: string,
-) {
+): null | string | ChunkNames | ChunkNames[] {
   if (!value) {
     return null;
   }
diff --git a/packages/docusaurus/src/server/translations/translations.ts b/packages/docusaurus/src/server/translations/translations.ts
@@ -55,7 +55,8 @@ export async function readTranslationFileContent(
       const content = JSON.parse(await fs.readFile(filePath, 'utf8'));
       ensureTranslationFileContent(content);
       return content;
-    } catch (e) {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    } catch (e: any) {
       throw new Error(`Invalid translation file at ${filePath}.\n${e.message}`);
     }
   }
diff --git a/packages/docusaurus/src/server/translations/translationsExtractor.ts b/packages/docusaurus/src/server/translations/translationsExtractor.ts
@@ -157,7 +157,8 @@ export async function extractSourceCodeFileTranslations(
     }) as Node;
 
     return await extractSourceCodeAstTranslations(ast, sourceCodeFilePath);
-  } catch (e) {
+    // 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}`;
     throw e;
   }
diff --git a/packages/docusaurus/src/types.d.ts b/packages/docusaurus/src/types.d.ts
@@ -0,0 +1,20 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+declare module 'remark-admonitions';
+
+declare module 'react-loadable-ssr-addon-v5-slorber';
+
+declare module 'resolve-pathname';
+
+declare module '@slorber/static-site-generator-webpack-plugin';
+
+declare module 'webpack/lib/HotModuleReplacementPlugin' {
+  import {HotModuleReplacementPlugin} from 'webpack';
+
+  export default HotModuleReplacementPlugin;
+}
diff --git a/packages/docusaurus/src/webpack/base.ts b/packages/docusaurus/src/webpack/base.ts
@@ -51,7 +51,7 @@ export function getDocusaurusAliases(): Record<string, string> {
   const dirPath = path.resolve(__dirname, '../client/exports');
   const extensions = ['.js', '.ts', '.tsx'];
 
-  const aliases = {};
+  const aliases: Record<string, string> = {};
 
   fs.readdirSync(dirPath)
     .filter((fileName) => extensions.includes(path.extname(fileName)))
diff --git a/packages/docusaurus/src/webpack/plugins/CleanWebpackPlugin.ts b/packages/docusaurus/src/webpack/plugins/CleanWebpackPlugin.ts
@@ -234,7 +234,8 @@ class CleanWebpackPlugin {
           console.warn(`clean-webpack-plugin: removed ${filename}`);
         });
       }
-    } catch (error) {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    } catch (error: any) {
       const needsForce = /Cannot delete files\/folders outside the current working directory\./.test(
         error.message,
       );
diff --git a/packages/docusaurus/src/webpack/plugins/LogPlugin.ts b/packages/docusaurus/src/webpack/plugins/LogPlugin.ts
@@ -9,7 +9,7 @@ import {Compiler} from 'webpack';
 // import formatWebpackMessages from 'react-dev-utils/formatWebpackMessages';
 import formatWebpackMessages from '../react-dev-utils-webpack5/formatWebpackMessages';
 
-function showError(arr) {
+function showError(arr: string[]) {
   console.log(`\n\n${arr.join('\n')}`);
 }
 
diff --git a/packages/docusaurus/src/webpack/server.ts b/packages/docusaurus/src/webpack/server.ts
@@ -37,7 +37,7 @@ export default function createServerConfig({
   } = props;
   const config = createBaseConfig(props, true);
 
-  const routesLocation = {};
+  const routesLocation: Record<string, string> = {};
   // Array of paths to be rendered. Relative to output directory
   const ssgPaths = routesPaths.map((str) => {
     const ssgPath =
diff --git a/packages/docusaurus/src/webpack/utils.ts b/packages/docusaurus/src/webpack/utils.ts
@@ -249,7 +249,7 @@ export function applyConfigurePostCss(
   }
 
   // Does not handle all edge cases, but good enough for now
-  function overridePostCssOptions(entry) {
+  function overridePostCssOptions(entry: RuleSetRule) {
     if (isPostCssLoader(entry)) {
       entry.options.postcssOptions = configurePostCss(
         entry.options.postcssOptions,
@@ -259,11 +259,13 @@ export function applyConfigurePostCss(
     } else if (Array.isArray(entry.use)) {
       entry.use
         .filter((u) => typeof u === 'object')
-        .forEach(overridePostCssOptions);
+        .forEach((rule) => overridePostCssOptions(rule as RuleSetRule));
     }
   }
 
-  config.module?.rules?.forEach(overridePostCssOptions);
+  config.module?.rules?.forEach((rule) =>
+    overridePostCssOptions(rule as RuleSetRule),
+  );
 
   return config;
 }
@@ -442,12 +444,23 @@ export function getFileLoaderUtils(): FileLoaderUtils {
 
 // Ensure the certificate and key provided are valid and if not
 // throw an easy to debug error
-function validateKeyAndCerts({cert, key, keyFile, crtFile}) {
-  let encrypted;
+function validateKeyAndCerts({
+  cert,
+  key,
+  keyFile,
+  crtFile,
+}: {
+  cert: Buffer;
+  key: Buffer;
+  keyFile: string;
+  crtFile: string;
+}) {
+  let encrypted: Buffer;
   try {
     // publicEncrypt will throw an error with an invalid cert
     encrypted = crypto.publicEncrypt(cert, Buffer.from('test'));
-  } catch (err) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  } catch (err: any) {
     throw new Error(
       `The certificate "${chalk.yellow(crtFile)}" is invalid.\n${err.message}`,
     );
@@ -456,7 +469,8 @@ function validateKeyAndCerts({cert, key, keyFile, crtFile}) {
   try {
     // privateDecrypt will throw an error with an invalid key
     crypto.privateDecrypt(key, encrypted);
-  } catch (err) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  } catch (err: any) {
     throw new Error(
       `The certificate key "${chalk.yellow(keyFile)}" is invalid.\n${
         err.message
@@ -466,7 +480,7 @@ function validateKeyAndCerts({cert, key, keyFile, crtFile}) {
 }
 
 // Read file and throw an error if it doesn't exist
-function readEnvFile(file, type) {
+function readEnvFile(file: string, type: string) {
   if (!fs.existsSync(file)) {
     throw new Error(
       `You specified ${chalk.cyan(
@@ -515,7 +529,7 @@ function getTerserParallel() {
 export function getMinimizer(
   useSimpleCssMinifier = false,
 ): WebpackPluginInstance[] {
-  const minimizer = [
+  const minimizer: WebpackPluginInstance[] = [
     new TerserPlugin({
       parallel: getTerserParallel(),
       terserOptions: {
@@ -525,10 +539,11 @@ export function getMinimizer(
           // into invalid ecma 5 code. This is why the 'compress' and 'output'
           // sections only apply transformations that are ecma 5 safe
           // https://github.com/facebook/create-react-app/pull/4234
-          ecma: 8,
+          ecma: 2020,
         },
         compress: {
           ecma: 5,
+          // @ts-expect-error: API change in new version?
           warnings: false,
         },
         mangle: {
@@ -558,6 +573,7 @@ export function getMinimizer(
           },
           // CleanCss options
           {
+            // @ts-expect-error: API change in new version?
             inline: false,
             level: {
               1: {
diff --git a/packages/docusaurus/tsconfig.client.json b/packages/docusaurus/tsconfig.client.json
@@ -6,7 +6,6 @@
     "module": "esnext",
     "tsBuildInfoFile": "./lib/client/.tsbuildinfo",
     "outDir": "lib/client",
-    "noImplicitAny": false,
     "jsx": "react"
   },
   "include": ["src/client"]
diff --git a/packages/docusaurus/tsconfig.json b/packages/docusaurus/tsconfig.json
@@ -6,8 +6,9 @@
     "tsBuildInfoFile": "./lib/.tsbuildinfo",
     "rootDir": "src",
     "outDir": "lib",
-    "noImplicitAny": false,
-    "jsx": "react"
+    "jsx": "react",
+    "allowJs": true
   },
-  "exclude": ["node_modules", "**/__tests__/**/*", "**/lib/**/*", "src/client"]
+  "include": ["src"],
+  "exclude": ["**/__tests__/**/*", "src/client"]
 }
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,8 @@ export async function readTranslationFileContent(`
`55`	`55`	`const content = JSON.parse(await fs.readFile(filePath, 'utf8'));`
`56`	`56`	`ensureTranslationFileContent(content);`
`57`	`57`	`return content;`
`58`		`- } catch (e) {`
	`58`	`+ // eslint-disable-next-line @typescript-eslint/no-explicit-any`
	`59`	`+ } catch (e: any) {`
`59`	`60`	throw new Error(`Invalid translation file at ${filePath}.\n${e.message}`);
`60`	`61`	`}`
`61`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -157,7 +157,8 @@ export async function extractSourceCodeFileTranslations(`
`157`	`157`	`}) as Node;`
`158`	`158`
`159`	`159`	`return await extractSourceCodeAstTranslations(ast, sourceCodeFilePath);`
`160`		`- } catch (e) {`
	`160`	`+ // eslint-disable-next-line @typescript-eslint/no-explicit-any`
	`161`	`+ } catch (e: any) {`
`161`	`162`	e.message = `Error while attempting to extract Docusaurus translations from source code file at path=${sourceCodeFilePath}\n${e.message}`;
`162`	`163`	`throw e;`
`163`	`164`	`}`