style(v2): reduce number of ESLint warnings (#4993)

* Initial work

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* More fixes

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Update packages/docusaurus-theme-classic/src/theme/ThemedImage/index.tsx

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>

* Update packages/docusaurus-theme-bootstrap/src/theme/ThemedImage/index.tsx

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>

* Fix

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Replace versionPathPart with function

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Prefer non-null assertions

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Substitute for-of with forEach

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Fill `catch` block with placeholder comment

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Ignore local require

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Revert global require change

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Tighten eslint disable range

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Make eslint ignore examples and more tolerating to templates

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Use reduce to handle doc items sequentially

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Revert "Use reduce to handle doc items sequentially"

This reverts commit c7525d463b.

* Address change requests

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>

.eslintignore

@@ -8,6 +8,7 @@ jest.config.js
 jest.transform.js
 website/
 scripts
+examples/
 
 packages/docusaurus/lib/
 packages/docusaurus-*/lib/*

.eslintrc.js

@@ -92,6 +92,7 @@ module.exports = {
     'no-unused-vars': OFF,
     'no-nested-ternary': WARNING,
     '@typescript-eslint/no-empty-function': OFF,
+    '@typescript-eslint/no-non-null-assertion': OFF, // Have to use type assertion anyways
     '@typescript-eslint/no-unused-vars': [ERROR, {argsIgnorePattern: '^_'}],
     '@typescript-eslint/ban-ts-comment': [
       ERROR,
@@ -113,7 +114,7 @@ module.exports = {
     'prefer-destructuring': WARNING,
     yoda: WARNING,
     'no-control-regex': WARNING,
-    'no-empty': WARNING,
+    'no-empty': [WARNING, {allowEmptyCatch: true}],
     'no-prototype-builtins': WARNING,
     'no-case-declarations': WARNING,
     'no-undef': OFF,
@@ -130,6 +131,7 @@ module.exports = {
       ],
       rules: {
         'header/header': OFF,
+        'global-require': OFF,
       },
     },
     {

packages/docusaurus-plugin-content-docs/src/docs.ts

@@ -130,6 +130,7 @@ function doProcessDocMetadata({
 
     // Strip number prefixes by default (01-MyFolder/01-MyDoc.md => MyFolder/MyDoc) by default,
     // but allow to disable this behavior with frontmatterr
+    // eslint-disable-next-line camelcase
     parse_number_prefixes = true,
   } = frontMatter;
 
@@ -144,6 +145,7 @@ function doProcessDocMetadata({
   // ex: myDoc -> .
   const sourceDirName = path.dirname(source);
 
+  // eslint-disable-next-line camelcase
   const {filename: unprefixedFileName, numberPrefix} = parse_number_prefixes
     ? options.numberPrefixParser(sourceFileNameWithoutExtension)
     : {filename: sourceFileNameWithoutExtension, numberPrefix: undefined};
@@ -172,6 +174,7 @@ function doProcessDocMetadata({
       return undefined;
     }
     // Eventually remove the number prefixes from intermediate directories
+    // eslint-disable-next-line camelcase
     return parse_number_prefixes
       ? stripPathNumberPrefixes(sourceDirName, options.numberPrefixParser)
       : sourceDirName;

packages/docusaurus-plugin-content-docs/src/sidebars.ts

@@ -127,7 +127,10 @@ function assertIsCategory(
     );
   }
   // "collapsed" is an optional property
-  if (item.hasOwnProperty('collapsed') && typeof item.collapsed !== 'boolean') {
+  if (
+    typeof item.collapsed !== 'undefined' &&
+    typeof item.collapsed !== 'boolean'
+  ) {
     throw new Error(
       `Error loading ${JSON.stringify(item)}: "collapsed" must be a boolean.`,
     );
@@ -438,7 +441,20 @@ export function collectSidebarsDocIds(
   });
 }
 
-export function createSidebarsUtils(sidebars: Sidebars) {
+export function createSidebarsUtils(
+  sidebars: Sidebars,
+): {
+  getFirstDocIdOfFirstSidebar: () => string | undefined;
+  getSidebarNameByDocId: (docId: string) => string | undefined;
+  getDocNavigation: (
+    docId: string,
+  ) => {
+    sidebarName: string | undefined;
+    previousId: string | undefined;
+    nextId: string | undefined;
+  };
+  checkSidebarsDocIds: (validDocIds: string[], sidebarFilePath: string) => void;
+} {
   const sidebarNameToDocIds = collectSidebarsDocIds(sidebars);
 
   function getFirstDocIdOfFirstSidebar(): string | undefined {

packages/docusaurus-plugin-content-docs/src/types.ts

@@ -187,6 +187,8 @@ export type LastUpdateData = {
 };
 
 export type DocFrontMatter = {
+  // Front matter uses snake case
+  /* eslint-disable camelcase */
   id?: string;
   title?: string;
   hide_title?: boolean;
@@ -200,6 +202,7 @@ export type DocFrontMatter = {
   pagination_label?: string;
   custom_edit_url?: string | null;
   parse_number_prefixes?: boolean;
+  /* eslint-enable camelcase */
 };
 
 export type DocMetadataBase = LastUpdateData & {
@@ -213,7 +216,6 @@ export type DocMetadataBase = LastUpdateData & {
   sourceDirName: string; // relative to the docs folder (can be ".")
   slug: string;
   permalink: string;
-  // eslint-disable-next-line camelcase
   sidebarPosition?: number;
   editUrl?: string | null;
   frontMatter: DocFrontMatter & Record<string, unknown>;

packages/docusaurus-plugin-content-docs/src/versions.ts

@@ -341,11 +341,13 @@ function createVersionMetadata({
   // retro-compatible values
   const defaultVersionLabel =
     versionName === CURRENT_VERSION_NAME ? 'Next' : versionName;
-  const defaultVersionPathPart = isLast
-    ? ''
-    : versionName === CURRENT_VERSION_NAME
-    ? 'next'
-    : versionName;
+  function getDefaultVersionPathPart() {
+    if (isLast) {
+      return '';
+    }
+    return versionName === CURRENT_VERSION_NAME ? 'next' : versionName;
+  }
+  const defaultVersionPathPart = getDefaultVersionPathPart();
 
   const versionOptions: VersionOptions = options.versions[versionName] ?? {};
 

packages/docusaurus-plugin-ideal-image/src/index.ts

@@ -39,6 +39,7 @@ export default function (
                   options: {
                     emitFile: !isServer, // don't emit for server-side rendering
                     disable: !isProd,
+                    // eslint-disable-next-line global-require
                     adapter: require('@docusaurus/responsive-loader/sharp'),
                     name: isProd
                       ? 'assets/ideal-img/[name].[hash:hex:7].[width].[ext]'

packages/docusaurus-theme-bootstrap/src/theme/ThemedImage/index.tsx

@@ -21,10 +21,10 @@ const ThemedImage = (props: Props): JSX.Element => {
 
   type SourceName = keyof Props['sources'];
 
+  const clientThemes: SourceName[] = isDarkTheme ? ['dark'] : ['light'];
+
   const renderedSourceNames: SourceName[] = isClient
-    ? isDarkTheme
-      ? ['dark']
-      : ['light']
+    ? clientThemes
     : // We need to render both images on the server to avoid flash
       // See https://github.com/facebook/docusaurus/pull/3730
       ['light', 'dark'];

packages/docusaurus-theme-classic/src/theme/ThemedImage/index.tsx

@@ -21,10 +21,10 @@ const ThemedImage = (props: Props): JSX.Element => {
 
   type SourceName = keyof Props['sources'];
 
+  const clientThemes: SourceName[] = isDarkTheme ? ['dark'] : ['light'];
+
   const renderedSourceNames: SourceName[] = isClient
-    ? isDarkTheme
-      ? ['dark']
-      : ['light']
+    ? clientThemes
     : // We need to render both images on the server to avoid flash
       // See https://github.com/facebook/docusaurus/pull/3730
       ['light', 'dark'];

packages/docusaurus-theme-classic/src/theme/hooks/useTabGroupChoice.ts

@@ -22,12 +22,12 @@ const useTabGroupChoice = (): useTabGroupChoiceReturns => {
   useEffect(() => {
     try {
       const localStorageChoices = {};
-      for (const storageKey of listStorageKeys()) {
+      listStorageKeys().forEach((storageKey) => {
         if (storageKey.startsWith(TAB_CHOICE_PREFIX)) {
           const groupId = storageKey.substring(TAB_CHOICE_PREFIX.length);
           localStorageChoices[groupId] = createStorageSlot(storageKey).get();
         }
-      }
+      });
       setChoices(localStorageChoices);
     } catch (err) {
       console.error(err);

packages/docusaurus-theme-classic/update-code-translations.js

@@ -53,6 +53,7 @@ async function extractThemeCodeMessages() {
   const {
     globSourceCodeFilePaths,
     extractAllSourceCodeFileTranslations,
+    // eslint-disable-next-line global-require
   } = require('@docusaurus/core/lib/server/translations/translationsExtractor');
 
   const filePaths = (

packages/docusaurus-theme-common/src/utils/useAlternatePageUtils.ts

@@ -11,7 +11,15 @@ import {useLocation} from '@docusaurus/router';
 // Permits to obtain the url of the current page in another locale
 // Useful to generate hreflang meta headers etc...
 // See https://developers.google.com/search/docs/advanced/crawling/localized-versions
-export function useAlternatePageUtils() {
+export function useAlternatePageUtils(): {
+  createUrl: ({
+    locale,
+    fullyQualified,
+  }: {
+    locale: string;
+    fullyQualified: boolean;
+  }) => string;
+} {
   const {
     siteConfig: {baseUrl, url},
     i18n: {defaultLocale, currentLocale},

packages/docusaurus-theme-common/src/utils/usePluralForm.ts

@@ -107,7 +107,9 @@ function selectPluralMessage(
   }
 }
 
-export function usePluralForm() {
+export function usePluralForm(): {
+  selectMessage: (count: number, pluralMessages: string) => string;
+} {
   const localePluralForm = useLocalePluralForms();
   return {
     selectMessage: (count: number, pluralMessages: string): string => {

packages/docusaurus-utils-common/src/applyTrailingSlash.tsx

@@ -21,6 +21,9 @@ export default function applyTrailingSlash(
   function removeTrailingSlash(str: string): string {
     return str.endsWith('/') ? str.slice(0, -1) : str;
   }
+  function handleTrailingSlash(str: string, trailing: boolean): string {
+    return trailing ? addTrailingSlash(str) : removeTrailingSlash(str);
+  }
 
   // undefined = legacy retrocompatible behavior
   if (typeof trailingSlash === 'undefined') {
@@ -32,10 +35,6 @@ export default function applyTrailingSlash(
 
   // Never transform '/' to ''
   const newPathname =
-    pathname === '/'
-      ? '/'
-      : trailingSlash
-      ? addTrailingSlash(pathname)
-      : removeTrailingSlash(pathname);
+    pathname === '/' ? '/' : handleTrailingSlash(pathname, trailingSlash);
   return path.replace(pathname, newPathname);
 }

packages/docusaurus-utils-validation/src/validationUtils.ts

@@ -35,7 +35,7 @@ export const logValidationBugReportHint = (): void => {
   );
 };
 
-export function printWarning(warning?: Joi.ValidationError) {
+export function printWarning(warning?: Joi.ValidationError): void {
   if (warning) {
     const warningMessages = warning.details
       .map(({message}) => message)

packages/docusaurus-utils/src/markdownParser.ts

@@ -36,17 +36,17 @@ export function createExcerpt(fileString: string): string | undefined {
       // Remove HTML tags.
       .replace(/<[^>]*>/g, '')
       // Remove Title headers
-      .replace(/^\#\s*([^#]*)\s*\#?/gm, '')
+      .replace(/^#\s*([^#]*)\s*#?/gm, '')
       // Remove Markdown + ATX-style headers
-      .replace(/^\#{1,6}\s*([^#]*)\s*(\#{1,6})?/gm, '$1')
+      .replace(/^#{1,6}\s*([^#]*)\s*(#{1,6})?/gm, '$1')
       // Remove emphasis and strikethroughs.
-      .replace(/([\*_~]{1,3})(\S.*?\S{0,1})\1/g, '$2')
+      .replace(/([*_~]{1,3})(\S.*?\S{0,1})\1/g, '$2')
       // Remove images.
-      .replace(/\!\[(.*?)\][\[\(].*?[\]\)]/g, '$1')
+      .replace(/!\[(.*?)\][[(].*?[\])]/g, '$1')
       // Remove footnotes.
-      .replace(/\[\^.+?\](\: .*?$)?/g, '')
+      .replace(/\[\^.+?\](: .*?$)?/g, '')
       // Remove inline links.
-      .replace(/\[(.*?)\][\[\(].*?[\]\)]/g, '$1')
+      .replace(/\[(.*?)\][[(].*?[\])]/g, '$1')
       // Remove inline code.
       .replace(/`(.+?)`/g, '$1')
       // Remove blockquotes.

packages/docusaurus/src/commands/buildRemoteBranchUrl.ts

@@ -12,7 +12,7 @@ export function buildUrl(
   organizationName: string,
   projectName: string,
   useSSH: boolean | undefined,
-) {
+): string {
   return useSSH
     ? buildSshUrl(githubHost, organizationName, projectName, githubPort)
     : buildHttpsUrl(

packages/docusaurus/src/server/i18n.ts

@@ -29,7 +29,10 @@ export function getDefaultLocaleConfig(locale: string): I18nLocaleConfig {
   };
 }
 
-export function shouldWarnAboutNodeVersion(version: number, locales: string[]) {
+export function shouldWarnAboutNodeVersion(
+  version: number,
+  locales: string[],
+): boolean {
   const isOnlyEnglish = locales.length === 1 && locales.includes('en');
   const isOlderNodeVersion = version < 14;
   return isOlderNodeVersion && !isOnlyEnglish;

packages/docusaurus/src/server/index.ts

@@ -50,7 +50,7 @@ export async function loadSiteConfig({
 }: {
   siteDir: string;
   customConfigFilePath?: string;
-}) {
+}): Promise<{siteConfig: DocusaurusConfig; siteConfigPath: string}> {
   const siteConfigPathUnresolved =
     customConfigFilePath ?? DEFAULT_CONFIG_FILE_NAME;
 

packages/docusaurus/src/server/plugins/applyRouteTrailingSlash.ts

@@ -11,7 +11,7 @@ import {applyTrailingSlash} from '@docusaurus/utils-common';
 export default function applyRouteTrailingSlash(
   route: RouteConfig,
   trailingSlash: boolean | undefined,
-) {
+): RouteConfig {
   return {
     ...route,
     path: applyTrailingSlash(route.path, trailingSlash),