Eslint review, round 1 (#58168)

Author: heiskr

eslint.config.ts

@@ -67,63 +67,33 @@ export default [
       // JSX A11y recommended rules
       ...jsxA11y.configs.recommended.rules,
 
-      // TypeScript-specific overrides
+      // Overrides
       'import/no-extraneous-dependencies': [
         'error',
         {
           packageDir: '.',
         },
       ],
-      'import/extensions': 'off',
-      'no-console': 'off',
-      camelcase: 'off',
-      'no-shadow': 'off',
-      'prefer-template': 'off',
-      'no-constant-condition': 'off',
-      'no-unused-vars': 'off',
-      'no-undef': 'off',
-      'no-use-before-define': 'off',
-      'no-redeclare': 'off', // Allow function overloads in TypeScript
-      'import/no-named-as-default-member': 'off',
-      'one-var': 'off',
-      'import/no-namespace': 'off',
-      'import/no-anonymous-default-export': 'off',
-      'object-shorthand': 'off',
-      'no-empty': 'off',
-      'prefer-const': 'off',
-      'import/no-named-as-default': 'off',
-      'no-useless-concat': 'off',
-      'func-style': 'off',
-
-      // TypeScript ESLint specific rules
+      'import/extensions': ['error', { json: 'always' }],
+      'no-empty': ['error', { allowEmptyCatch: true }],
       '@typescript-eslint/no-unused-vars': 'error',
+      'prefer-const': ['error', { destructuring: 'all' }],
 
-      // Disable GitHub plugin rules that were disabled in original config
-      'github/array-foreach': 'off',
-      'github/no-then': 'off',
-
-      // Disable rules that might not exist or cause issues initially
-      'i18n-text/no-en': 'off',
-      'filenames/match-regex': 'off',
-      'eslint-comments/no-use': 'off',
-      'eslint-comments/no-unused-disable': 'off',
-      'eslint-comments/no-unlimited-disable': 'off',
-
-      // Disable new ESLint 9 rules that are causing issues
-      'no-constant-binary-expression': 'off',
-
-      // Disable stricter TypeScript rules initially
-      '@typescript-eslint/no-explicit-any': 'off',
-      '@typescript-eslint/no-unused-expressions': 'off',
-      '@typescript-eslint/ban-ts-comment': 'off',
-      '@typescript-eslint/no-wrapper-object-types': 'off',
-      '@typescript-eslint/no-non-null-asserted-optional-chain': 'off',
-      '@typescript-eslint/no-unsafe-function-type': 'off',
-      '@typescript-eslint/no-empty-object-type': 'off',
-      '@typescript-eslint/prefer-as-const': 'off',
+      // Rules that must be disabled
+      'no-redeclare': 'off', // Allow function overloads in TypeScript
+      'i18n-text/no-en': 'off', // This rule causes eslint to not run at all
+      'filenames/match-regex': 'off', // This rule causes eslint to not run at all
 
-      // React/JSX specific rules
-      'jsx-a11y/no-onchange': 'off',
+      // Disabled rules to review
+      'github/no-then': 'off', // 30+
+      '@typescript-eslint/ban-ts-comment': 'off', // 50+
+      'no-undef': 'off', // 50+
+      'no-shadow': 'off', // 150+
+      'prefer-template': 'off', // 150+
+      'github/array-foreach': 'off', // 250+
+      camelcase: 'off', // 600+
+      'no-console': 'off', // 800+
+      '@typescript-eslint/no-explicit-any': 'off', // 1000+
     },
   },
 

package.json

@@ -53,7 +53,7 @@
     "index-general-search": "tsx src/search/scripts/index/index-cli general-search",
     "index-test-fixtures": "./src/search/scripts/index-test-fixtures.sh",
     "labeler": "tsx .github/actions/labeler/labeler.ts",
-    "lint": "eslint '**/*.{js,mjs,ts,tsx}'",
+    "lint": "eslint '**/*.{ts,tsx}'",
     "lint-content": "tsx src/content-linter/scripts/lint-content.ts",
     "lint-translation": "vitest src/content-linter/tests/lint-files.ts",
     "liquid-markdown-tables": "tsx src/tools/scripts/liquid-markdown-tables/index.ts",
@@ -67,8 +67,8 @@
     "postinstall": "cp package-lock.json .installed.package-lock.json && echo \"Updated .installed.package-lock.json\" # see husky/post-checkout and husky/post-merge",
     "precompute-pageinfo": "tsx src/article-api/scripts/precompute-pageinfo.ts",
     "prepare": "husky src/workflows/husky",
-    "prettier": "prettier -w \"**/*.{ts,tsx,js,mjs,scss,yml,yaml}\"",
-    "prettier-check": "prettier -c \"**/*.{ts,tsx,js,mjs,scss,yml,yaml}\"",
+    "prettier": "prettier -w \"**/*.{ts,tsx,scss,yml,yaml}\"",
+    "prettier-check": "prettier -c \"**/*.{ts,tsx,scss,yml,yaml}\"",
     "prevent-pushes-to-main": "tsx src/workflows/prevent-pushes-to-main.ts",
     "purge-fastly-edge-cache": "tsx src/workflows/purge-fastly-edge-cache.ts",
     "purge-fastly-edge-cache-per-language": "tsx src/languages/scripts/purge-fastly-edge-cache-per-language.ts",
@@ -105,12 +105,12 @@
     "what-docs-early-access-branch": "tsx src/early-access/scripts/what-docs-early-access-branch.ts"
   },
   "lint-staged": {
-    "*.{js,mjs,ts,tsx}": "eslint --cache --fix",
-    "*.{js,mjs,scss,ts,tsx,yml,yaml}": "prettier --write",
+    "*.{ts,tsx}": "eslint --cache --fix",
+    "*.{scss,ts,tsx,yml,yaml}": "prettier --write",
     "{content,data}/**/*.md": "npm run lint-content -- --precommit --paths"
   },
   "nodemonConfig": {
-    "ext": "ts,js,json,yml,md,html,scss",
+    "ext": "ts,json,yml,md,html,scss",
     "exec": "tsx",
     "ignore": [
       "assets",
@@ -139,7 +139,7 @@
       },
       {
         "files": [
-          "**/*.{ts,tsx,js,mjs}"
+          "**/*.{ts,tsx}"
         ],
         "options": {
           "printWidth": 100,

src/archives/middleware/archived-enterprise-versions.ts

@@ -235,7 +235,7 @@ export default async function archivedEnterpriseVersions(
       // `x-host` is a custom header set by Fastly.
       // GLB automatically deletes the `x-forwarded-host` header.
       const host = req.get('x-host') || req.get('x-forwarded-host') || req.get('host')
-      let modifiedBody = body
+      const modifiedBody = body
         .replaceAll(
           `${OLD_AZURE_BLOB_ENTERPRISE_DIR}/${requestedVersion}/assets/cb-`,
           `${ENTERPRISE_GH_PAGES_URL_PREFIX}${requestedVersion}/assets/cb-`,

src/assets/scripts/deleted-assets-pr-comment.ts

@@ -1,4 +1,4 @@
-import * as github from '@actions/github'
+import github from '@actions/github'
 import core from '@actions/core'
 
 const { GITHUB_TOKEN } = process.env

src/assets/scripts/find-orphaned-assets.ts

@@ -145,7 +145,9 @@ async function main(opts: MainOptions) {
   // Add exceptions
   sourceFiles.push('.github/CONTRIBUTING.md')
   sourceFiles.push('README.md')
-  verbose && console.log(`${sourceFiles.length.toLocaleString()} source files found in total.`)
+  if (verbose) {
+    console.log(`${sourceFiles.length.toLocaleString()} source files found in total.`)
+  }
 
   const allImages = new Set(
     walk(
@@ -159,7 +161,9 @@ async function main(opts: MainOptions) {
     ).filter((filePath) => !filePath.endsWith('.md')),
   )
 
-  verbose && console.log(`${allImages.size.toLocaleString()} images found in total.`)
+  if (verbose) {
+    console.log(`${allImages.size.toLocaleString()} images found in total.`)
+  }
 
   for (const sourceFile of sourceFiles) {
     const content = fs.readFileSync(sourceFile, 'utf-8')

src/assets/tests/static-assets.ts

@@ -43,7 +43,7 @@ type MockResponse = {
   _json?: string
   _send?: string
   headers: Record<string, string>
-  set?: (key: string | Object, value: string) => void
+  set?: (key: string | object, value: string) => void
   removeHeader?: (key: string) => void
   hasHeader?: (key: string) => boolean
 }

src/audit-logs/lib/index.ts

@@ -96,7 +96,7 @@ async function resolveReferenceLinksToTitles(
 //     docs_reference_links: 'event reference links'
 //   },
 // ]
-export function getAuditLogEvents(page: string, version: string) {
+export function getAuditLogEvents(page: string, version: string): AuditLogEventT[] {
   const openApiVersion = getOpenApiVersion(version)
   const auditLogFileName = path.join(AUDIT_LOG_DATA_DIR, openApiVersion, `${page}.json`)
 
@@ -115,14 +115,14 @@ export function getAuditLogEvents(page: string, version: string) {
       ?.set(page, readCompressedJsonFileFallback(auditLogFileName))
   }
 
-  const auditLogEvents = auditLogEventsCache.get(openApiVersion)?.get(page)!
+  const auditLogEvents = auditLogEventsCache.get(openApiVersion)?.get(page)
   // If an event doesn't yet have a description (value will be empty string or
   // "N/A"), then we don't show the event.
-  const filteredAuditLogEvents = auditLogEvents.filter(
+  const filteredAuditLogEvents = auditLogEvents?.filter(
     (event) => event.description !== 'N/A' && event.description !== '',
   )
 
-  return filteredAuditLogEvents
+  return filteredAuditLogEvents || []
 }
 
 // get categorized audit log event data for the requested page and version
@@ -137,7 +137,7 @@ export function getAuditLogEvents(page: string, version: string) {
 //   repo: [ [Object] ],
 //   user: [ [Object], [Object] ]
 // }
-export function getCategorizedAuditLogEvents(page: string, version: string) {
+export function getCategorizedAuditLogEvents(page: string, version: string): CategorizedEvents {
   const events = getAuditLogEvents(page, version)
   const openApiVersion = getOpenApiVersion(version)
 
@@ -148,7 +148,7 @@ export function getCategorizedAuditLogEvents(page: string, version: string) {
     categorizedAuditLogEventsCache.get(openApiVersion)?.set(page, categorizeEvents(events))
   }
 
-  return categorizedAuditLogEventsCache.get(openApiVersion)?.get(page)!
+  return categorizedAuditLogEventsCache.get(openApiVersion)?.get(page) || {}
 }
 
 // Filters audit log events based on allowlist values.

src/audit-logs/pages/audit-log-events.tsx

@@ -86,7 +86,9 @@ export const getServerSideProps: GetServerSideProps<Props> = async (context) =>
     Object.keys(auditLogEvents).map((category) => category),
     context,
   )
-  auditLogEventsMiniTocs && miniTocItems.push(...auditLogEventsMiniTocs)
+  if (auditLogEventsMiniTocs) {
+    miniTocItems.push(...auditLogEventsMiniTocs)
+  }
 
   return {
     props: {

src/content-linter/lib/helpers/should-include-result.ts

@@ -1,4 +1,4 @@
-import * as nodePath from 'path'
+import nodePath from 'path'
 import { reportingConfig } from '@/content-linter/style/github-docs'
 
 interface LintFlaw {

src/content-linter/lib/linting-rules/liquid-ifversion-versions.ts

@@ -30,7 +30,7 @@ export const liquidIfversionVersions = {
     // The versions frontmatter object or all versions if the file
     // being processed is a data file.
     const fm = getFrontmatter(params.lines)
-    let content = fm ? getFrontmatterLines(params.lines).join('\n') : params.lines.join('\n')
+    const content = fm ? getFrontmatterLines(params.lines).join('\n') : params.lines.join('\n')
 
     const fileVersionsFm = params.name.startsWith('data')
       ? { ghec: '*', ghes: '*', fpt: '*' }