chore(v2): Fix linter warnings (#4442)

* chore(v2): Fix linter warnings 223 warnings to 145 warnings * Remove explicit type annotations * Do not prefetch when targetLink == null
facebook · Mar 17, 2021 · 5e73c72 · 5e73c72
1 parent f041a37
commit 5e73c72
Show file tree

Hide file tree

Showing 39 changed files with 146 additions and 71 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -90,6 +90,7 @@ module.exports = {
     ],
     'no-unused-vars': OFF,
     'no-nested-ternary': WARNING,
+    '@typescript-eslint/no-empty-function': OFF,
     '@typescript-eslint/no-unused-vars': [ERROR, {argsIgnorePattern: '^_'}],
     '@typescript-eslint/ban-ts-comment': [
       ERROR,
@@ -108,7 +109,6 @@ module.exports = {
     camelcase: WARNING,
     'no-restricted-syntax': WARNING,
     'no-unused-expressions': WARNING,
-    '@typescript-eslint/no-empty-function': WARNING,
     'global-require': WARNING,
     'prefer-destructuring': WARNING,
     yoda: WARNING,

diff --git a/packages/docusaurus-migrate/src/__tests__/migrationConfig.test.ts b/packages/docusaurus-migrate/src/__tests__/migrationConfig.test.ts
@@ -13,7 +13,7 @@ describe('create config', () => {
   test('simple test', () => {
     const v1Config: VersionOneConfig = importFresh(
       `${__dirname}/__fixtures__/sourceSiteConfig.js`,
-    ) as any;
+    );
     const siteDir = 'website';
     const newDir = 'websiteMigrated';
 

diff --git a/packages/docusaurus-migrate/src/types.ts b/packages/docusaurus-migrate/src/types.ts
@@ -16,9 +16,9 @@ export type Data = {
 };
 
 export type ClassicPresetEntries = {
-  docs: {[key: string]: any};
-  blog: {[key: string]: any};
-  theme: {[key: string]: any};
+  docs: {[key: string]: unknown};
+  blog: {[key: string]: unknown};
+  theme: {[key: string]: unknown};
 };
 
 export type SidebarEntries = {
@@ -39,7 +39,7 @@ export interface VersionTwoConfig {
   githubHost?: string;
   onBrokenLinks: string;
   onBrokenMarkdownLinks: string;
-  plugins: Array<[string, {[key: string]: any}]>;
+  plugins: Array<[string, {[key: string]: unknown}]>;
   themes?: [];
   presets: [[string, ClassicPresetEntries]];
   themeConfig: {
@@ -114,8 +114,8 @@ export type VersionOneConfig = {
   gaTrackingId?: string;
   highlight?: Record<string, unknown>;
   markdownPlugins?: Array<() => void>;
-  scripts?: Array<{src: string; [key: string]: any} | string>;
-  stylesheets?: Array<{href: string; [key: string]: any} | string>;
+  scripts?: Array<{src: string; [key: string]: unknown} | string>;
+  stylesheets?: Array<{href: string; [key: string]: unknown} | string>;
   facebookAppId?: string;
   facebookComments?: true;
   facebookPixelId?: string;

diff --git a/packages/docusaurus-module-type-aliases/src/index.d.ts b/packages/docusaurus-module-type-aliases/src/index.d.ts
@@ -43,7 +43,7 @@ declare module '@generated/routesChunkNames' {
 }
 
 declare module '@generated/globalData' {
-  const globalData: any;
+  const globalData: Record<string, unknown>;
   export default globalData;
 }
 

diff --git a/packages/docusaurus-plugin-content-docs/src/docs.ts b/packages/docusaurus-plugin-content-docs/src/docs.ts
@@ -120,7 +120,10 @@ export function processDocMetadata({
   const docsFileDirName = path.dirname(source);
 
   const {frontMatter = {}, excerpt} = parseMarkdownString(content);
-  const {sidebar_label, custom_edit_url} = frontMatter;
+  const {
+    sidebar_label: sidebarLabel,
+    custom_edit_url: customEditURL,
+  } = frontMatter;
 
   const baseID: string =
     frontMatter.id || path.basename(source, path.extname(source));
@@ -206,7 +209,7 @@ export function processDocMetadata({
     source: aliasedSitePath(filePath, siteDir),
     slug: docSlug,
     permalink,
-    editUrl: custom_edit_url !== undefined ? custom_edit_url : getDocEditUrl(),
+    editUrl: customEditURL !== undefined ? customEditURL : getDocEditUrl(),
     version: versionMetadata.versionName,
     lastUpdatedBy: lastUpdate.lastUpdatedBy,
     lastUpdatedAt: lastUpdate.lastUpdatedAt,
@@ -215,6 +218,6 @@ export function processDocMetadata({
           lastUpdate.lastUpdatedAt * 1000,
         )
       : undefined,
-    sidebar_label,
+    sidebar_label: sidebarLabel,
   };
 }
diff --git a/packages/docusaurus-plugin-content-docs/src/plugin-content-docs.d.ts b/packages/docusaurus-plugin-content-docs/src/plugin-content-docs.d.ts
@@ -22,7 +22,7 @@ declare module '@docusaurus/plugin-content-docs-types' {
   };
 
   type PropsSidebarItemBase = {
-    customProps?: object;
+    customProps?: Record<string, unknown>;
   };
 
   export type PropSidebarItemLink = PropsSidebarItemBase & {

diff --git a/packages/docusaurus-plugin-content-docs/src/props.ts b/packages/docusaurus-plugin-content-docs/src/props.ts
@@ -33,11 +33,11 @@ Available document ids=
       );
     }
 
-    const {title, permalink, sidebar_label} = docMetadata;
+    const {title, permalink, sidebar_label: sidebarLabel} = docMetadata;
 
     return {
       type: 'link',
-      label: sidebar_label || title,
+      label: sidebarLabel || title,
       href: permalink,
       customProps: item.customProps,
     };

diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars.ts b/packages/docusaurus-plugin-content-docs/src/sidebars.ts
@@ -76,7 +76,7 @@ function normalizeCategoryShorthand(
  * Check that item contains only allowed keys.
  */
 function assertItem<K extends string>(
-  item: any,
+  item: Record<string, unknown>,
   keys: K[],
 ): asserts item is Record<K, any> {
   const unknownKeys = Object.keys(item).filter(
@@ -94,7 +94,7 @@ function assertItem<K extends string>(
 }
 
 function assertIsCategory(
-  item: unknown,
+  item: Record<string, unknown>,
 ): asserts item is SidebarItemCategoryJSON {
   assertItem(item, ['items', 'label', 'collapsed', 'customProps']);
   if (typeof item.label !== 'string') {
@@ -115,7 +115,9 @@ function assertIsCategory(
   }
 }
 
-function assertIsDoc(item: unknown): asserts item is SidebarItemDoc {
+function assertIsDoc(
+  item: Record<string, unknown>,
+): asserts item is SidebarItemDoc {
   assertItem(item, ['id', 'customProps']);
   if (typeof item.id !== 'string') {
     throw new Error(
@@ -124,7 +126,9 @@ function assertIsDoc(item: unknown): asserts item is SidebarItemDoc {
   }
 }
 
-function assertIsLink(item: unknown): asserts item is SidebarItemLink {
+function assertIsLink(
+  item: Record<string, unknown>,
+): asserts item is SidebarItemLink {
   assertItem(item, ['href', 'label', 'customProps']);
   if (typeof item.href !== 'string') {
     throw new Error(

diff --git a/packages/docusaurus-plugin-content-docs/src/theme/hooks/useDocs.ts b/packages/docusaurus-plugin-content-docs/src/theme/hooks/useDocs.ts
@@ -27,7 +27,7 @@ import {
 export const useAllDocsData = (): Record<string, GlobalPluginData> =>
   useAllPluginInstancesData('docusaurus-plugin-content-docs');
 
-export const useDocsData = (pluginId: string | undefined) =>
+export const useDocsData = (pluginId: string | undefined): GlobalPluginData =>
   usePluginData('docusaurus-plugin-content-docs', pluginId) as GlobalPluginData;
 
 export const useActivePlugin = (

diff --git a/packages/docusaurus-plugin-content-docs/src/types.ts b/packages/docusaurus-plugin-content-docs/src/types.ts
@@ -94,7 +94,7 @@ export type PluginOptions = MetadataOptions &
   };
 
 export type SidebarItemBase = {
-  customProps?: object;
+  customProps?: Record<string, unknown>;
 };
 
 export type SidebarItemDoc = SidebarItemBase & {
@@ -147,6 +147,7 @@ export type DocMetadataBase = LastUpdateData & {
   source: string;
   slug: string;
   permalink: string;
+  // eslint-disable-next-line camelcase
   sidebar_label?: string;
   editUrl?: string | null;
 };

diff --git a/packages/docusaurus-plugin-content-docs/src/versions.ts b/packages/docusaurus-plugin-content-docs/src/versions.ts
@@ -427,7 +427,7 @@ function filterVersions(
 ) {
   if (options.onlyIncludeVersions) {
     return versionNamesUnfiltered.filter((name) =>
-      options.onlyIncludeVersions!.includes(name),
+      (options.onlyIncludeVersions || []).includes(name),
     );
   } else {
     return versionNamesUnfiltered;

diff --git a/packages/docusaurus-plugin-content-pages/src/__tests__/index.test.ts b/packages/docusaurus-plugin-content-pages/src/__tests__/index.test.ts
@@ -22,7 +22,7 @@ describe('docusaurus-plugin-content-pages', () => {
         path: pluginPath,
       }),
     );
-    const pagesMetadatas = (await plugin.loadContent?.())!;
+    const pagesMetadatas = await plugin.loadContent?.();
 
     expect(pagesMetadatas).toEqual([
       {
@@ -89,7 +89,7 @@ describe('docusaurus-plugin-content-pages', () => {
         path: pluginPath,
       }),
     );
-    const pagesMetadatas = (await plugin.loadContent?.())!;
+    const pagesMetadatas = await plugin.loadContent?.();
 
     const frTranslationsPath = path.posix.join(
       '@site',

diff --git a/packages/docusaurus-plugin-content-pages/src/plugin-content-pages.d.ts b/packages/docusaurus-plugin-content-pages/src/plugin-content-pages.d.ts
@@ -14,6 +14,7 @@ declare module '@theme/MDXPage' {
         readonly title: string;
         readonly description: string;
         readonly wrapperClassName?: string;
+        // eslint-disable-next-line camelcase
         readonly hide_table_of_contents?: string;
       };
       readonly metadata: {readonly permalink: string};

diff --git a/packages/docusaurus-plugin-debug/src/theme/DebugJsonView/index.js b/packages/docusaurus-plugin-debug/src/theme/DebugJsonView/index.js
@@ -18,6 +18,7 @@ const BrowserOnlyReactJson = (props) => {
   return (
     <BrowserOnly>
       {() => {
+        // eslint-disable-next-line global-require
         const ReactJson = require('react-json-view').default;
         return <ReactJson {...props} />;
       }}

diff --git a/packages/docusaurus-theme-bootstrap/src/theme/CodeBlock/index.tsx b/packages/docusaurus-theme-bootstrap/src/theme/CodeBlock/index.tsx
@@ -6,18 +6,19 @@
  */
 
 import React from 'react';
-import Highlight, {defaultProps} from 'prism-react-renderer';
+import Highlight, {defaultProps, Language} from 'prism-react-renderer';
 import theme from 'prism-react-renderer/themes/nightOwl';
+import type {Props} from '@theme/CodeBlock';
 
-export default ({children, className}): JSX.Element => {
+export default ({children, className}: Props): JSX.Element => {
   const language = className && className.replace(/language-/, '');
 
   return (
     <Highlight
       {...defaultProps}
       theme={theme}
       code={children}
-      language={language}>
+      language={language as Language}>
       {({style, tokens, getLineProps, getTokenProps}) => (
         <pre className={className} style={{...style, padding: '20px'}}>
           {tokens.map((line, i) => (

diff --git a/packages/docusaurus-theme-bootstrap/src/theme/Footer/index.tsx b/packages/docusaurus-theme-bootstrap/src/theme/Footer/index.tsx
@@ -30,7 +30,7 @@ function FooterLink({to, href, label, ...props}) {
   );
 }
 
-function Footer() {
+function Footer(): JSX.Element {
   const context = useDocusaurusContext();
   const {siteConfig = {}} = context;
   const {themeConfig = {}} = siteConfig;

diff --git a/packages/docusaurus-theme-bootstrap/src/theme/MDXComponents/index.tsx b/packages/docusaurus-theme-bootstrap/src/theme/MDXComponents/index.tsx
@@ -6,7 +6,7 @@
  */
 
 import React, {ReactNode} from 'react';
-import CodeBlock from '@theme/CodeBlock';
+import CodeBlock, {Props} from '@theme/CodeBlock';
 import {Table} from 'reactstrap';
 
 const Heading = (tag: string): ReactNode => {
@@ -22,16 +22,18 @@ export default {
   h4: Heading('h4'),
   h5: Heading('h5'),
   h6: Heading('h6'),
-  code: (props) => {
+  code: (props: Props): JSX.Element => {
     const {children} = props;
     if (typeof children === 'string') {
       return <CodeBlock {...props} />;
     }
     return children;
   },
   table: Table,
-  blockquote: (props) => (
+  blockquote: (props: {children: ReactNode}): JSX.Element => (
     <blockquote className="blockquote-footer">{props.children}</blockquote>
   ),
-  p: (props) => <div className="font-weight-light">{props.children}</div>,
+  p: (props: {children: ReactNode}): JSX.Element => (
+    <div className="font-weight-light">{props.children}</div>
+  ),
 };
diff --git a/packages/docusaurus-theme-bootstrap/src/theme/Navbar/index.tsx b/packages/docusaurus-theme-bootstrap/src/theme/Navbar/index.tsx
@@ -62,7 +62,7 @@ function NavItem({
   );
 }
 
-function Navbar() {
+function Navbar(): JSX.Element {
   const {
     siteConfig: {
       themeConfig: {navbar: {title = '', items: links = []} = {}},

diff --git a/packages/docusaurus-theme-bootstrap/src/theme/TOCInline/index.tsx b/packages/docusaurus-theme-bootstrap/src/theme/TOCInline/index.tsx
@@ -7,7 +7,7 @@
 
 import React from 'react';
 
-function TOCInline(_props: any): JSX.Element {
+function TOCInline(_props: Record<string, unknown>): JSX.Element {
   return <div>TODO bootstrap toc</div>;
 }
 

diff --git a/packages/docusaurus-theme-classic/src/__tests__/validateThemeConfig.test.js b/packages/docusaurus-theme-classic/src/__tests__/validateThemeConfig.test.js
@@ -10,6 +10,8 @@ import {merge} from 'lodash';
 const {ThemeConfigSchema, DEFAULT_CONFIG} = require('../validateThemeConfig');
 
 const {normalizeThemeConfig} = require('@docusaurus/utils-validation');
+const theme = require('prism-react-renderer/themes/github');
+const darkTheme = require('prism-react-renderer/themes/dracula');
 
 function testValidateThemeConfig(partialThemeConfig) {
   return normalizeThemeConfig(ThemeConfigSchema, {
@@ -31,8 +33,8 @@ describe('themeConfig', () => {
   test('should accept valid theme config', () => {
     const userConfig = {
       prism: {
-        theme: require('prism-react-renderer/themes/github'),
-        darkTheme: require('prism-react-renderer/themes/dracula'),
+        theme,
+        darkTheme,
         defaultLanguage: 'javascript',
         additionalLanguages: ['kotlin', 'java'],
       },

diff --git a/packages/docusaurus-theme-classic/src/theme/Footer/index.tsx b/packages/docusaurus-theme-classic/src/theme/Footer/index.tsx
@@ -9,12 +9,18 @@ import React from 'react';
 import clsx from 'clsx';
 
 import Link from '@docusaurus/Link';
-import {useThemeConfig} from '@docusaurus/theme-common';
+import {FooterLinkItem, useThemeConfig} from '@docusaurus/theme-common';
 import useBaseUrl from '@docusaurus/useBaseUrl';
 import styles from './styles.module.css';
 import ThemedImage, {Props as ThemedImageProps} from '@theme/ThemedImage';
 
-function FooterLink({to, href, label, prependBaseUrlToHref, ...props}: any) {
+function FooterLink({
+  to,
+  href,
+  label,
+  prependBaseUrlToHref,
+  ...props
+}: FooterLinkItem) {
   const toUrl = useBaseUrl(to);
   const normalizedHref = useBaseUrl(href, {forcePrependBaseUrl: true});
 

diff --git a/packages/docusaurus-theme-classic/src/theme/MDXComponents/index.tsx b/packages/docusaurus-theme-classic/src/theme/MDXComponents/index.tsx
@@ -23,7 +23,7 @@ const MDXComponents: MDXComponentsObject = {
     return children;
   },
   a: (props) => <Link {...props} />,
-  pre: (props: any) => {
+  pre: (props) => {
     const {children} = props;
     return (
       <CodeBlock

diff --git a/packages/docusaurus-theme-classic/src/theme/NavbarItem/index.tsx b/packages/docusaurus-theme-classic/src/theme/NavbarItem/index.tsx
@@ -19,13 +19,13 @@ const NavbarItemComponents = {
   // Need to lazy load these items as we don't know for sure the docs plugin is loaded
   // See https://github.com/facebook/docusaurus/issues/3360
   docsVersion: () =>
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    // eslint-disable-next-line @typescript-eslint/no-var-requires, global-require
     require('@theme/NavbarItem/DocsVersionNavbarItem').default,
   docsVersionDropdown: () =>
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    // eslint-disable-next-line @typescript-eslint/no-var-requires, global-require
     require('@theme/NavbarItem/DocsVersionDropdownNavbarItem').default,
   doc: () =>
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    // eslint-disable-next-line @typescript-eslint/no-var-requires, global-require
     require('@theme/NavbarItem/DocNavbarItem').default,
 } as const;
 

diff --git a/packages/docusaurus-theme-classic/src/theme/hooks/useDocs.ts b/packages/docusaurus-theme-classic/src/theme/hooks/useDocs.ts
@@ -12,6 +12,7 @@
 // see https://github.com/webpack/webpack/issues/7713#issuecomment-467888437
 // note: warning can be filtered: https://github.com/facebook/docusaurus/pull/3382#issuecomment-684966924
 try {
+  // eslint-disable-next-line global-require
   module.exports = require('@theme-init/hooks/useDocs');
 } catch (e) {
   // In case the docs plugin is not available, might be useful to stub some methods here

diff --git a/packages/docusaurus-theme-common/package.json b/packages/docusaurus-theme-common/package.json
@@ -29,6 +29,7 @@
     "@docusaurus/module-type-aliases": "2.0.0-alpha.72"
   },
   "peerDependencies": {
+    "prism-react-renderer": "^1.1.1",
     "react": "^16.8.4 || ^17.0.0",
     "react-dom": "^16.8.4 || ^17.0.0"
   },