chore(v2): Fix a lot of eslint warnings (#2972)

facebook · Jun 20, 2020 · 3611c96 · 3611c96
1 parent 4aa7765
commit 3611c96
Show file tree

Hide file tree

Showing 46 changed files with 145 additions and 130 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -88,16 +88,11 @@ module.exports = {
 
     // TODO re-enable some these as errors
     // context: https://github.com/facebook/docusaurus/pull/2949
-    '@typescript-eslint/no-var-requires': WARNING,
     '@typescript-eslint/ban-ts-comment': WARNING,
     '@typescript-eslint/ban-types': WARNING,
-    'import/no-duplicates': WARNING,
     'import/prefer-default-export': WARNING,
     'import/no-extraneous-dependencies': WARNING,
-    'prefer-const': WARNING,
     'no-useless-escape': WARNING,
-    'prefer-object-spread': WARNING,
-    'no-return-await': WARNING,
     'prefer-template': WARNING,
     'no-shadow': WARNING,
     'no-param-reassign': WARNING,
@@ -113,7 +108,6 @@ module.exports = {
     'no-useless-return': WARNING,
     '@typescript-eslint/no-empty-function': WARNING,
     'global-require': WARNING,
-    'import/newline-after-import': WARNING,
     'prefer-destructuring': WARNING,
     yoda: WARNING,
     'no-control-regex': WARNING,
@@ -133,5 +127,13 @@ module.exports = {
         'header/header': OFF,
       },
     },
+    {
+      files: ['*.js'],
+      rules: {
+        // Make JS code directly runnable in Node.
+        '@typescript-eslint/no-var-requires': OFF,
+        '@typescript-eslint/explicit-module-boundary-types': OFF,
+      },
+    },
   ],
 };
diff --git a/packages/docusaurus-plugin-client-redirects/src/__tests__/collectRedirects.test.ts b/packages/docusaurus-plugin-client-redirects/src/__tests__/collectRedirects.test.ts
@@ -17,7 +17,7 @@ function createTestPluginContext(
   return {
     outDir: '/tmp',
     baseUrl: 'https://docusaurus.io',
-    routesPaths: routesPaths,
+    routesPaths,
     options: normalizePluginOptions(options),
   };
 }
@@ -192,7 +192,7 @@ describe('collectRedirects', () => {
                   `/def?queryString=toto`,
                 ];
               }
-              return;
+              return undefined;
             },
           },
           ['/'],
@@ -210,7 +210,7 @@ describe('collectRedirects', () => {
               if (routePath === '/') {
                 return [[`/fromPath`]] as any;
               }
-              return;
+              return undefined;
             },
           },
           ['/'],

diff --git a/packages/docusaurus-plugin-client-redirects/src/__tests__/redirectValidation.test.ts b/packages/docusaurus-plugin-client-redirects/src/__tests__/redirectValidation.test.ts
@@ -51,14 +51,14 @@ describe('validateRedirect', () => {
 
     expect(() =>
       validateRedirect({
-        from: null as any,
+        from: (null as unknown) as string,
         to: '/toSomePath?queryString=xyz',
       }),
     ).toThrowErrorMatchingSnapshot();
 
     expect(() =>
       validateRedirect({
-        from: ['heyho'] as any,
+        from: (['heyho'] as unknown) as string,
         to: '/toSomePath?queryString=xyz',
       }),
     ).toThrowErrorMatchingSnapshot();

diff --git a/packages/docusaurus-plugin-client-redirects/src/__tests__/writeRedirectFiles.test.ts b/packages/docusaurus-plugin-client-redirects/src/__tests__/writeRedirectFiles.test.ts
@@ -69,7 +69,7 @@ describe('toRedirectFilesMetadata', () => {
 
 describe('writeRedirectFiles', () => {
   test('write the files', async () => {
-    const outDir = '/tmp/docusaurus_tests_' + Math.random();
+    const outDir = `/tmp/docusaurus_tests_${Math.random()}`;
 
     const filesMetadata = [
       {
@@ -94,7 +94,7 @@ describe('writeRedirectFiles', () => {
   });
 
   test('avoid overwriting existing files', async () => {
-    const outDir = '/tmp/docusaurus_tests_' + Math.random();
+    const outDir = `/tmp/docusaurus_tests_${Math.random()}`;
 
     const filesMetadata = [
       {

diff --git a/packages/docusaurus-plugin-client-redirects/src/extensionRedirects.ts b/packages/docusaurus-plugin-client-redirects/src/extensionRedirects.ts
@@ -53,7 +53,7 @@ export function createToExtensionsRedirects(
     if (extensionFound) {
       const routePathWithoutExtension = removeSuffix(path, extensionFound);
       return [routePathWithoutExtension].map((from) => ({
-        from: from,
+        from,
         to: path,
       }));
     }
@@ -78,12 +78,11 @@ export function createFromExtensionsRedirects(
   const createPathRedirects = (path: string): RedirectMetadata[] => {
     if (path === '' || path.endsWith('/') || alreadyEndsWithAnExtension(path)) {
       return [];
-    } else {
-      return extensions.map((ext) => ({
-        from: `${path}.${ext}`,
-        to: path,
-      }));
     }
+    return extensions.map((ext) => ({
+      from: `${path}.${ext}`,
+      to: path,
+    }));
   };
 
   return flatten(paths.map(createPathRedirects));

diff --git a/packages/docusaurus-plugin-client-redirects/src/normalizePluginOptions.ts b/packages/docusaurus-plugin-client-redirects/src/normalizePluginOptions.ts
@@ -21,7 +21,7 @@ export const DefaultPluginOptions: PluginOptions = {
 };
 
 function isRedirectsCreator(
-  value: any,
+  value: unknown,
 ): value is CreateRedirectsFnOption | undefined {
   if (value === null || typeof value === 'undefined') {
     return true;

diff --git a/packages/docusaurus-plugin-client-redirects/src/redirectValidation.ts b/packages/docusaurus-plugin-client-redirects/src/redirectValidation.ts
@@ -21,7 +21,7 @@ const RedirectSchema = Yup.object<RedirectMetadata>({
   to: PathnameValidator.required(),
 });
 
-export function validateRedirect(redirect: RedirectMetadata) {
+export function validateRedirect(redirect: RedirectMetadata): void {
   try {
     RedirectSchema.validateSync(redirect, {
       strict: true,

diff --git a/packages/docusaurus-plugin-client-redirects/src/writeRedirectFiles.ts b/packages/docusaurus-plugin-client-redirects/src/writeRedirectFiles.ts
@@ -54,7 +54,9 @@ export function toRedirectFilesMetadata(
   return redirects.map(createFileMetadata);
 }
 
-export async function writeRedirectFile(file: RedirectFileMetadata) {
+export async function writeRedirectFile(
+  file: RedirectFileMetadata,
+): Promise<void> {
   try {
     // User-friendly security to prevent file overrides
     if (await fs.pathExists(file.fileAbsolutePath)) {
@@ -79,6 +81,6 @@ export async function writeRedirectFile(file: RedirectFileMetadata) {
 
 export default async function writeRedirectFiles(
   redirectFiles: RedirectFileMetadata[],
-) {
+): Promise<void> {
   await Promise.all(redirectFiles.map(writeRedirectFile));
 }
diff --git a/packages/docusaurus-plugin-content-blog/package.json b/packages/docusaurus-plugin-content-blog/package.json
@@ -11,11 +11,9 @@
     "access": "public"
   },
   "license": "MIT",
-  "devDependencies": {
-    "@docusaurus/types": "^2.0.0-alpha.58"
-  },
   "dependencies": {
     "@docusaurus/mdx-loader": "^2.0.0-alpha.58",
+    "@docusaurus/types": "^2.0.0-alpha.58",
     "@docusaurus/utils": "^2.0.0-alpha.58",
     "feed": "^4.1.0",
     "fs-extra": "^8.1.0",

diff --git a/packages/docusaurus-plugin-content-blog/src/blogUtils.ts b/packages/docusaurus-plugin-content-blog/src/blogUtils.ts
@@ -19,7 +19,7 @@ import {
 } from '@docusaurus/utils';
 import {LoadContext} from '@docusaurus/types';
 
-export function truncate(fileString: string, truncateMarker: RegExp) {
+export function truncate(fileString: string, truncateMarker: RegExp): string {
   return fileString.split(truncateMarker, 1).shift()!;
 }
 
@@ -37,7 +37,7 @@ function toUrl({date, link}: DateLink) {
 export async function generateBlogFeed(
   context: LoadContext,
   options: PluginOptions,
-) {
+): Promise<Feed | null> {
   if (!options.feedOptions) {
     throw new Error(
       'Invalid options - `feedOptions` is not expected to be null.',
@@ -76,7 +76,7 @@ export async function generateBlogFeed(
     } = post;
     feed.addItem({
       title,
-      id: id,
+      id,
       link: normalizeUrl([siteUrl, permalink]),
       date,
       description,
@@ -90,7 +90,7 @@ export async function generateBlogPosts(
   blogDir: string,
   {siteConfig, siteDir}: LoadContext,
   options: PluginOptions,
-) {
+): Promise<BlogPost[]> {
   const {
     include,
     routeBasePath,
@@ -181,14 +181,16 @@ export function linkify(
   siteDir: string,
   blogPath: string,
   blogPosts: BlogPost[],
-) {
+): string {
   let fencedBlock = false;
   const lines = fileContent.split('\n').map((line) => {
     if (line.trim().startsWith('```')) {
       fencedBlock = !fencedBlock;
     }
 
-    if (fencedBlock) return line;
+    if (fencedBlock) {
+      return line;
+    }
 
     let modifiedLine = line;
     const mdRegex = /(?:(?:\]\()|(?:\]:\s?))(?!https)([^'")\]\s>]+\.mdx?)/g;

diff --git a/packages/docusaurus-plugin-content-docs/package.json b/packages/docusaurus-plugin-content-docs/package.json
@@ -12,12 +12,12 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@docusaurus/types": "^2.0.0-alpha.58",
     "commander": "^5.0.0",
     "picomatch": "^2.1.1"
   },
   "dependencies": {
     "@docusaurus/mdx-loader": "^2.0.0-alpha.58",
+    "@docusaurus/types": "^2.0.0-alpha.58",
     "@docusaurus/utils": "^2.0.0-alpha.58",
     "execa": "^3.4.0",
     "fs-extra": "^8.1.0",

diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts
@@ -310,7 +310,7 @@ describe('versioned website', () => {
         permalink: '/docs/next/',
       },
     });
-    expect(docsMetadata['hello']).toEqual({
+    expect(docsMetadata.hello).toEqual({
       id: 'hello',
       isDocsHomePage: true,
       permalink: '/docs/next/',

diff --git a/packages/docusaurus-plugin-content-docs/src/index.ts b/packages/docusaurus-plugin-content-docs/src/index.ts
@@ -68,7 +68,7 @@ const DEFAULT_OPTIONS: PluginOptions = {
 function getFirstDocLinkOfSidebar(
   sidebarItems: DocsSidebarItem[],
 ): string | null {
-  for (let sidebarItem of sidebarItems) {
+  for (const sidebarItem of sidebarItems) {
     if (sidebarItem.type === 'category') {
       const url = getFirstDocLinkOfSidebar(sidebarItem.items);
       if (url) {
@@ -534,7 +534,7 @@ Available document ids=
                   options: {
                     siteDir,
                     docsDir,
-                    sourceToPermalink: sourceToPermalink,
+                    sourceToPermalink,
                     versionedDir,
                   },
                 },

diff --git a/packages/docusaurus-plugin-content-docs/src/markdown/linkify.ts b/packages/docusaurus-plugin-content-docs/src/markdown/linkify.ts
@@ -17,7 +17,7 @@ export default function (
   siteDir: string,
   sourceToPermalink: SourceToPermalink,
   versionedDir?: string,
-) {
+): string {
   // Determine the source dir. e.g: /website/docs, /website/versioned_docs/version-1.0.0
   let sourceDir: string | undefined;
   const thisSource = filePath;
@@ -40,7 +40,9 @@ export default function (
       if (line.trim().startsWith('```')) {
         fencedBlock = !fencedBlock;
       }
-      if (fencedBlock) return line;
+      if (fencedBlock) {
+        return line;
+      }
 
       let modifiedLine = line;
       // Replace inline-style links or reference-style links e.g:

diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars.ts b/packages/docusaurus-plugin-content-docs/src/sidebars.ts
@@ -135,7 +135,7 @@ function normalizeItem(item: SidebarItemRaw): SidebarItem[] {
     case 'doc':
       assertIsDoc(item);
       return [item];
-    default:
+    default: {
       const extraMigrationError =
         item.type === 'subcategory'
           ? "Docusaurus v2: 'subcategory' has been renamed as 'category'"
@@ -145,6 +145,7 @@ function normalizeItem(item: SidebarItemRaw): SidebarItem[] {
           item.type
         }]. Sidebar item=${JSON.stringify(item)} ${extraMigrationError}`,
       );
+    }
   }
 }
 
@@ -168,7 +169,7 @@ function normalizeSidebar(sidebars: SidebarRaw): Sidebar {
 
 export default function loadSidebars(sidebarPaths?: string[]): Sidebar {
   // We don't want sidebars to be cached because of hot reloading.
-  let allSidebars: SidebarRaw = {};
+  const allSidebars: SidebarRaw = {};
 
   if (!sidebarPaths || !sidebarPaths.length) {
     return {} as Sidebar;

diff --git a/packages/docusaurus-plugin-content-docs/src/version.ts b/packages/docusaurus-plugin-content-docs/src/version.ts
@@ -19,7 +19,7 @@ export function docsVersion(
   version: string | null | undefined,
   siteDir: string,
   options: PathOptions,
-) {
+): void {
   if (!version) {
     throw new Error(
       'No version tag specified!. Pass the version you wish to create as an argument. Ex: 1.0.0',

diff --git a/packages/docusaurus-plugin-sitemap/src/__tests__/createSitemap.test.ts b/packages/docusaurus-plugin-sitemap/src/__tests__/createSitemap.test.ts
@@ -28,7 +28,7 @@ describe('createSitemap', () => {
 
   test('empty site', () => {
     expect(() => {
-      createSitemap({} as any, [], {} as any);
+      createSitemap({} as DocusaurusConfig, [], {} as any);
     }).toThrowErrorMatchingInlineSnapshot(
       `"url in docusaurus.config.js cannot be empty/undefined"`,
     );

diff --git a/packages/docusaurus-plugin-sitemap/src/index.ts b/packages/docusaurus-plugin-sitemap/src/index.ts
@@ -9,7 +9,7 @@ import fs from 'fs-extra';
 import path from 'path';
 import {PluginOptions} from './types';
 import createSitemap from './createSitemap';
-import {LoadContext, Props} from '@docusaurus/types';
+import {LoadContext, Props, Plugin} from '@docusaurus/types';
 
 const DEFAULT_OPTIONS: PluginOptions = {
   cacheTime: 600 * 1000, // 600 sec - cache purge period.
@@ -20,7 +20,7 @@ const DEFAULT_OPTIONS: PluginOptions = {
 export default function pluginSitemap(
   _context: LoadContext,
   opts: Partial<PluginOptions>,
-) {
+): Plugin<void> {
   const options = {...DEFAULT_OPTIONS, ...opts};
 
   return {