Fix all no-shadow ESLint violations (#58234)

Author: heiskr

eslint.config.ts

@@ -97,7 +97,6 @@ export default [
 
       // Disabled rules to review
       '@typescript-eslint/ban-ts-comment': 'off', // 50+
-      'no-shadow': 'off', // 150+
       'github/array-foreach': 'off', // 250+
       'no-console': 'off', // 800+
       '@typescript-eslint/no-explicit-any': 'off', // 1000+

next.config.ts

@@ -49,11 +49,11 @@ const config: NextConfig = {
       }
     })
   },
-  webpack: (config) => {
-    config.experiments = config.experiments || {}
-    config.experiments.topLevelAwait = true
-    config.resolve.fallback = { fs: false, async_hooks: false }
-    return config
+  webpack: (webpackConfig) => {
+    webpackConfig.experiments = webpackConfig.experiments || {}
+    webpackConfig.experiments.topLevelAwait = true
+    webpackConfig.resolve.fallback = { fs: false, async_hooks: false }
+    return webpackConfig
   },
 
   // https://nextjs.org/docs/api-reference/next.config.js/compression

src/assets/middleware/dynamic-assets.ts

@@ -143,9 +143,9 @@ export default async function dynamicAssets(
       const buffer = await image.webp({ effort }).toBuffer()
       assetCacheControl(res)
       return res.type('image/webp').send(buffer)
-    } catch (error) {
-      if (error instanceof Error && (error as any).code !== 'ENOENT') {
-        throw error
+    } catch (catchError) {
+      if (catchError instanceof Error && (catchError as any).code !== 'ENOENT') {
+        throw catchError
       }
     }
   }

src/assets/tests/static-assets.ts

@@ -16,13 +16,13 @@ function getNextStaticAsset(directory: string) {
   return path.join(root, files[0])
 }
 
-function mockRequest(path: string, { headers }: { headers?: Record<string, string> } = {}) {
+function mockRequest(requestPath: string, { headers }: { headers?: Record<string, string> } = {}) {
   const _headers = Object.fromEntries(
     Object.entries(headers || {}).map(([key, value]) => [key.toLowerCase(), value]),
   )
   return {
-    path,
-    url: path,
+    path: requestPath,
+    url: requestPath,
     get: (header: string) => {
       return _headers[header.toLowerCase()]
     },
@@ -74,8 +74,8 @@ const mockResponse = () => {
     if (typeof key === 'string') {
       res.headers[key.toLowerCase()] = value
     } else {
-      for (const [k, value] of Object.entries(key)) {
-        res.headers[k.toLowerCase()] = value
+      for (const [k, v] of Object.entries(key)) {
+        res.headers[k.toLowerCase()] = v
       }
     }
   }
@@ -319,9 +319,9 @@ describe('archived enterprise static assets', () => {
     },
   ])(
     'should return $expectStatus for $name',
-    ({ name, path, referrer, expectStatus, shouldCallNext }) => {
+    ({ name, path: testPath, referrer, expectStatus, shouldCallNext }) => {
       test(name, async () => {
-        const req = mockRequest(path, {
+        const req = mockRequest(testPath, {
           headers: {
             Referrer: referrer,
           },
@@ -359,22 +359,25 @@ describe('archived enterprise static assets', () => {
       expectStatus: undefined,
       shouldCallNext: true,
     },
-  ])('should not suppress $name', ({ name, path, referrer, expectStatus, shouldCallNext }) => {
-    test(name, async () => {
-      const req = mockRequest(path, {
-        headers: {
-          Referrer: referrer,
-        },
+  ])(
+    'should not suppress $name',
+    ({ name, path: testPath, referrer, expectStatus, shouldCallNext }) => {
+      test(name, async () => {
+        const req = mockRequest(testPath, {
+          headers: {
+            Referrer: referrer,
+          },
+        })
+        const res = mockResponse()
+        let nexted = false
+        const next = () => {
+          nexted = true
+        }
+        setDefaultFastlySurrogateKey(req, res, () => {})
+        await archivedEnterpriseVersionsAssets(req as any, res as any, next)
+        expect(nexted).toBe(shouldCallNext)
+        expect(res.statusCode).toBe(expectStatus)
       })
-      const res = mockResponse()
-      let nexted = false
-      const next = () => {
-        nexted = true
-      }
-      setDefaultFastlySurrogateKey(req, res, () => {})
-      await archivedEnterpriseVersionsAssets(req as any, res as any, next)
-      expect(nexted).toBe(shouldCallNext)
-      expect(res.statusCode).toBe(expectStatus)
-    })
-  })
+    },
+  )
 })

src/codeql-cli/scripts/sync.ts

@@ -83,8 +83,8 @@ async function setupEnvironment() {
 
 // copy the raw rst files to the temp directory and convert them
 // to Markdownusing pandoc
-async function rstToMarkdown(sourceDirectory: string) {
-  const sourceFiles = walk(sourceDirectory, {
+async function rstToMarkdown(rstSourceDirectory: string) {
+  const sourceFiles = walk(rstSourceDirectory, {
     includeBasePath: true,
     globs: ['**/*.rst'],
   })

src/content-linter/lib/helpers/get-lintable-yml.ts

@@ -80,15 +80,15 @@ export async function getLintableYml(dataFilePath: string): Promise<Record<strin
 // back to a file in the data directory.
 // The resulting key looks like:
 // 'data/variables/product.yml /pat_v1_caps'
-function addPathToKey(mdDict: Map<string, string>, dataFilePath: string): Map<string, string> {
-  const keys = Array.from(mdDict.keys())
+function addPathToKey(mdDictMap: Map<string, string>, dataFilePath: string): Map<string, string> {
+  const keys = Array.from(mdDictMap.keys())
   keys.forEach((key) => {
     const newKey = `${dataFilePath} ${key}`
-    const value = mdDict.get(key)
+    const value = mdDictMap.get(key)
     if (value !== undefined) {
-      mdDict.delete(key)
-      mdDict.set(newKey, value)
+      mdDictMap.delete(key)
+      mdDictMap.set(newKey, value)
     }
   })
-  return mdDict
+  return mdDictMap
 }

src/content-linter/lib/linting-rules/frontmatter-hero-image.ts

@@ -45,7 +45,7 @@ export const frontmatterHeroImage: Rule = {
 
     // Check if heroImage is an absolute path
     if (!heroImage.startsWith('/')) {
-      const line = params.lines.find((line: string) => line.trim().startsWith('heroImage:'))
+      const line = params.lines.find((ln: string) => ln.trim().startsWith('heroImage:'))
       const lineNumber = line ? params.lines.indexOf(line) + 1 : 1
       addError(
         onError,
@@ -59,7 +59,7 @@ export const frontmatterHeroImage: Rule = {
 
     // Check if heroImage points to banner-images directory
     if (!heroImage.startsWith('/assets/images/banner-images/')) {
-      const line = params.lines.find((line: string) => line.trim().startsWith('heroImage:'))
+      const line = params.lines.find((ln: string) => ln.trim().startsWith('heroImage:'))
       const lineNumber = line ? params.lines.indexOf(line) + 1 : 1
       addError(
         onError,
@@ -74,7 +74,7 @@ export const frontmatterHeroImage: Rule = {
     // Check if the file actually exists
     const validHeroImages = getValidHeroImages()
     if (validHeroImages.length > 0 && !validHeroImages.includes(heroImage)) {
-      const line = params.lines.find((line: string) => line.trim().startsWith('heroImage:'))
+      const line = params.lines.find((ln: string) => ln.trim().startsWith('heroImage:'))
       const lineNumber = line ? params.lines.indexOf(line) + 1 : 1
       const availableImages = validHeroImages.join(', ')
       addError(

src/content-linter/lib/linting-rules/frontmatter-intro-links.ts

@@ -48,8 +48,8 @@ export const frontmatterIntroLinks: Rule = {
     for (const key of Object.keys(introLinks)) {
       if (!validKeys.includes(key)) {
         // Find the line with this key
-        const line = params.lines.find((line: string) => {
-          const trimmed = line.trim()
+        const line = params.lines.find((ln: string) => {
+          const trimmed = ln.trim()
           return trimmed.startsWith(`${key}:`) && !trimmed.startsWith('introLinks:')
         })
         const lineNumber = line ? params.lines.indexOf(line) + 1 : 1

src/content-linter/lib/linting-rules/frontmatter-schema.ts

@@ -24,7 +24,7 @@ export const frontmatterSchema: Rule = {
     for (const key of deprecatedKeys) {
       // Early access articles are allowed to have deprecated properties
       if (params.name.includes('early-access')) continue
-      const line = params.lines.find((line: string) => line.trim().startsWith(key))
+      const line = params.lines.find((ln: string) => ln.trim().startsWith(key))
       const lineNumber = params.lines.indexOf(line!) + 1
       addError(
         onError,

src/content-linter/scripts/lint-content.ts

@@ -262,7 +262,7 @@ async function main() {
     }
 
     const fixableFiles = Object.entries(formattedResults)
-      .filter(([, results]) => results.some((result) => result.fixable))
+      .filter(([, fileResults]) => fileResults.some((flaw) => flaw.fixable))
       .map(([file]) => file)
     if (fixableFiles.length) {
       console.log('') // Just for some whitespace before the next message
@@ -302,7 +302,7 @@ function pluralize(things, word, pluralForm = null) {
 // (e.g., heading linters) so we need to separate the
 // list of data files from all other files to run
 // through markdownlint individually
-function getFilesToLint(paths) {
+function getFilesToLint(inputPaths) {
   const fileList = {
     length: 0,
     content: [],
@@ -316,7 +316,7 @@ function getFilesToLint(paths) {
   // The path passed to Markdownlint is what is displayed
   // in the error report, so we want to normalize it and
   // and make it relative if it's absolute.
-  for (const rawPath of paths) {
+  for (const rawPath of inputPaths) {
     const absPath = path.resolve(rawPath)
     if (fs.statSync(rawPath).isDirectory()) {
       if (isInDir(absPath, contentDir)) {
@@ -427,16 +427,16 @@ function reportSummaryByRule(results, config) {
   result. Results are sorted by severity per file, with errors
   listed first then warnings.
 */
-function getFormattedResults(allResults, isPrecommit) {
+function getFormattedResults(allResults, isInPrecommitMode) {
   const output = {}
   Object.entries(allResults)
     // Each result key always has an array value, but it may be empty
     .filter(([, results]) => results.length)
-    .forEach(([key, results]) => {
+    .forEach(([key, fileResults]) => {
       if (verbose) {
-        output[key] = [...results]
+        output[key] = [...fileResults]
       } else {
-        const formattedResults = results.map((flaw) => formatResult(flaw, isPrecommit))
+        const formattedResults = fileResults.map((flaw) => formatResult(flaw, isInPrecommitMode))
 
         // Only add the file to output if there are results after filtering
         if (formattedResults.length > 0) {
@@ -465,8 +465,8 @@ function getErrorCountByFile(results, fixed = false) {
   return getCountBySeverity(results, 'error', fixed)
 }
 function getCountBySeverity(results, severityLookup, fixed) {
-  return Object.values(results).filter((results) =>
-    results.some((result) => {
+  return Object.values(results).filter((fileResults) =>
+    fileResults.some((result) => {
       // If --fix was applied, we don't want to know about files that
       // no longer have errors or warnings.
       return result.severity === severityLookup && (!fixed || !result.fixable)
@@ -477,7 +477,7 @@ function getCountBySeverity(results, severityLookup, fixed) {
 // Removes null values and properties that are not relevant to content
 // writers, adds the severity to each result object, and transforms
 // some error and fix data into a more readable format.
-function formatResult(object, isPrecommit) {
+function formatResult(object, isInPrecommitMode) {
   const formattedResult = {}
 
   // Add severity to each result object
@@ -486,7 +486,8 @@ function formatResult(object, isPrecommit) {
     throw new Error(`Rule not found in allConfig: '${ruleName}'`)
   }
   formattedResult.severity =
-    allConfig[ruleName].severity || getSearchReplaceRuleSeverity(ruleName, object, isPrecommit)
+    allConfig[ruleName].severity ||
+    getSearchReplaceRuleSeverity(ruleName, object, isInPrecommitMode)
 
   formattedResult.context = allConfig[ruleName].context || ''
 
@@ -540,7 +541,7 @@ function listRules() {
   Rules that can't be run on partials have the property
   `partial-markdown-files` set to false.
 */
-function getMarkdownLintConfig(errorsOnly, runRules) {
+function getMarkdownLintConfig(filterErrorsOnly, runRules) {
   const config = {
     content: structuredClone(defaultConfig),
     data: structuredClone(defaultConfig),
@@ -559,7 +560,7 @@ function getMarkdownLintConfig(errorsOnly, runRules) {
     // search-replace is handled differently than other rules because
     // it has nested metadata and rules.
     if (
-      errorsOnly &&
+      filterErrorsOnly &&
       getRuleSeverity(ruleConfig, isPrecommit) !== 'error' &&
       ruleName !== 'search-replace'
     ) {
@@ -585,7 +586,7 @@ function getMarkdownLintConfig(errorsOnly, runRules) {
 
       for (const searchRule of ruleConfig.rules) {
         const searchRuleSeverity = getRuleSeverity(searchRule, isPrecommit)
-        if (errorsOnly && searchRuleSeverity !== 'error') continue
+        if (filterErrorsOnly && searchRuleSeverity !== 'error') continue
         // Add search-replace rules to frontmatter configuration for rules that make sense in frontmatter
         // This ensures rules like TODOCS detection work in frontmatter
         // Rules with applyToFrontmatter should ONLY run in the frontmatter pass (which lints the entire file)
@@ -640,14 +641,16 @@ function getMarkdownLintConfig(errorsOnly, runRules) {
 // Return the severity value of a rule but keep in mind it could be
 // running as a precommit hook, which means the severity could be
 // deliberately different.
-function getRuleSeverity(rule, isPrecommit) {
-  return isPrecommit ? rule.precommitSeverity || rule.severity : rule.severity
+function getRuleSeverity(ruleConfig, isInPrecommitMode) {
+  return isInPrecommitMode
+    ? ruleConfig.precommitSeverity || ruleConfig.severity
+    : ruleConfig.severity
 }
 
 // Gets a custom rule function from the name of the rule
 // in the configuration file
 function getCustomRule(ruleName) {
-  const rule = customRules.find((rule) => rule.names.includes(ruleName))
+  const rule = customRules.find((r) => r.names.includes(ruleName))
   if (!rule)
     throw new Error(
       `A content-lint rule ('${ruleName}') is configured in the markdownlint config file but does not have a corresponding rule function.`,
@@ -696,24 +699,24 @@ export function shouldIncludeRule(ruleName, runRules) {
     fixInfo: null
   }
 */
-function getSearchReplaceRuleSeverity(ruleName, object, isPrecommit) {
+function getSearchReplaceRuleSeverity(ruleName, object, isInPrecommitMode) {
   const pluginRuleName = object.errorDetail.split(':')[0].trim()
-  const rule = allConfig[ruleName].rules.find((rule) => rule.name === pluginRuleName)
-  return isPrecommit ? rule.precommitSeverity || rule.severity : rule.severity
+  const rule = allConfig[ruleName].rules.find((r) => r.name === pluginRuleName)
+  return isInPrecommitMode ? rule.precommitSeverity || rule.severity : rule.severity
 }
 
 function isOptionsValid() {
   // paths should only contain existing files and directories
-  const paths = program.opts().paths || []
-  for (const path of paths) {
+  const optionPaths = program.opts().paths || []
+  for (const filePath of optionPaths) {
     try {
-      fs.statSync(path)
+      fs.statSync(filePath)
     } catch {
-      if ('paths'.includes(path)) {
+      if ('paths'.includes(filePath)) {
         console.log('error: did you mean --paths')
       } else {
         console.log(
-          `error: invalid --paths (-p) option. The value '${path}' is not a valid file or directory`,
+          `error: invalid --paths (-p) option. The value '${filePath}' is not a valid file or directory`,
         )
       }
       return false
@@ -722,14 +725,14 @@ function isOptionsValid() {
 
   // rules should only contain existing, correctly spelled rules
   const allRulesList = [...allRules.map((rule) => rule.names).flat(), ...Object.keys(allConfig)]
-  const rules = program.opts().rules || []
-  for (const rule of rules) {
-    if (!allRulesList.includes(rule)) {
-      if ('rules'.includes(rule)) {
+  const optionRules = program.opts().rules || []
+  for (const ruleName of optionRules) {
+    if (!allRulesList.includes(ruleName)) {
+      if ('rules'.includes(ruleName)) {
         console.log('error: did you mean --rules')
       } else {
         console.log(
-          `error: invalid --rules (-r) option. The value '${rule}' is not a valid rule name.`,
+          `error: invalid --rules (-r) option. The value '${ruleName}' is not a valid rule name.`,
         )
       }
       return false