Migrate 6 JavaScript files to TypeScript (#57969)

Author: heiskr

src/content-linter/tests/unit/lint-report-exclusions.js renamed to src/content-linter/tests/unit/lint-report-exclusions.ts

@@ -2,9 +2,15 @@ import { describe, expect, test } from 'vitest'
 import { shouldIncludeResult } from '../../lib/helpers/should-include-result'
 import { reportingConfig } from '../../style/github-docs'
 
+interface LintFlaw {
+  severity: string
+  ruleNames: string[]
+  errorDetail?: string
+}
+
 describe('lint report exclusions', () => {
   // Helper function to simulate the reporting logic from lint-report.ts
-  function shouldIncludeInReport(flaw, filePath) {
+  function shouldIncludeInReport(flaw: LintFlaw, filePath: string): boolean {
     if (!flaw.ruleNames || !Array.isArray(flaw.ruleNames)) {
       return false
     }

src/content-linter/tests/unit/octicon-aria-labels.js renamed to src/content-linter/tests/unit/octicon-aria-labels.ts

@@ -1,18 +1,34 @@
 import { describe, expect, test } from 'vitest'
 import { octiconAriaLabels } from '../../lib/linting-rules/octicon-aria-labels'
 
+interface ErrorInfo {
+  lineNumber: number
+  detail?: string
+  context?: string
+  range?: [number, number]
+  fixInfo?: any // Matches RuleErrorCallback signature - fixInfo structure varies by rule
+}
+
 describe('octicon-aria-labels', () => {
   const rule = octiconAriaLabels
 
-  test('detects octicon without aria-label', () => {
-    const errors = []
-    const onError = (errorInfo) => {
+  // Helper to create onError callback that captures errors
+  function createErrorCollector() {
+    const errors: ErrorInfo[] = []
+    // Using any because the actual rule implementation calls onError with an object,
+    // not individual parameters as defined in RuleErrorCallback
+    const onError = (errorInfo: any) => {
       errors.push(errorInfo)
     }
+    return { errors, onError }
+  }
+
+  test('detects octicon without aria-label', () => {
+    const { errors, onError } = createErrorCollector()
 
     const content = ['This is a test with an octicon:', '{% octicon "alert" %}', 'Some more text.']
 
-    rule.function({ lines: content }, onError)
+    rule.function({ name: 'test.md', lines: content, frontMatterLines: [] }, onError)
 
     expect(errors.length).toBe(1)
     expect(errors[0].lineNumber).toBe(2)
@@ -21,27 +37,21 @@ describe('octicon-aria-labels', () => {
   })
 
   test('ignores octicons with aria-label', () => {
-    const errors = []
-    const onError = (errorInfo) => {
-      errors.push(errorInfo)
-    }
+    const { errors, onError } = createErrorCollector()
 
     const content = [
       'This is a test with a proper octicon:',
       '{% octicon "alert" aria-label="alert" %}',
       'Some more text.',
     ]
 
-    rule.function({ lines: content }, onError)
+    rule.function({ name: 'test.md', lines: content, frontMatterLines: [] }, onError)
 
     expect(errors.length).toBe(0)
   })
 
   test('detects multiple octicons without aria-label', () => {
-    const errors = []
-    const onError = (errorInfo) => {
-      errors.push(errorInfo)
-    }
+    const { errors, onError } = createErrorCollector()
 
     const content = [
       'This is a test with multiple octicons:',
@@ -51,7 +61,7 @@ describe('octicon-aria-labels', () => {
       'More text.',
     ]
 
-    rule.function({ lines: content }, onError)
+    rule.function({ name: 'test.md', lines: content, frontMatterLines: [] }, onError)
 
     expect(errors.length).toBe(2)
     expect(errors[0].lineNumber).toBe(2)
@@ -61,10 +71,7 @@ describe('octicon-aria-labels', () => {
   })
 
   test('ignores non-octicon liquid tags', () => {
-    const errors = []
-    const onError = (errorInfo) => {
-      errors.push(errorInfo)
-    }
+    const { errors, onError } = createErrorCollector()
 
     const content = [
       'This is a test with non-octicon tags:',
@@ -74,24 +81,21 @@ describe('octicon-aria-labels', () => {
       '{% endif %}',
     ]
 
-    rule.function({ lines: content }, onError)
+    rule.function({ name: 'test.md', lines: content, frontMatterLines: [] }, onError)
 
     expect(errors.length).toBe(0)
   })
 
   test('suggests correct fix for octicon with other attributes', () => {
-    const errors = []
-    const onError = (errorInfo) => {
-      errors.push(errorInfo)
-    }
+    const { errors, onError } = createErrorCollector()
 
     const content = [
       'This is a test with an octicon with other attributes:',
       '{% octicon "plus" aria-hidden="true" class="foo" %}',
       'Some more text.',
     ]
 
-    rule.function({ lines: content }, onError)
+    rule.function({ name: 'test.md', lines: content, frontMatterLines: [] }, onError)
 
     expect(errors.length).toBe(1)
     expect(errors[0].lineNumber).toBe(2)
@@ -101,29 +105,23 @@ describe('octicon-aria-labels', () => {
   })
 
   test('handles octicons with unusual spacing', () => {
-    const errors = []
-    const onError = (errorInfo) => {
-      errors.push(errorInfo)
-    }
+    const { errors, onError } = createErrorCollector()
 
     const content = [
       'This is a test with unusual spacing:',
       '{%  octicon   "x"    %}',
       'Some more text.',
     ]
 
-    rule.function({ lines: content }, onError)
+    rule.function({ name: 'test.md', lines: content, frontMatterLines: [] }, onError)
 
     expect(errors.length).toBe(1)
     expect(errors[0].lineNumber).toBe(2)
     expect(errors[0].detail).toContain('aria-label=x')
   })
 
   test('handles octicons split across multiple lines', () => {
-    const errors = []
-    const onError = (errorInfo) => {
-      errors.push(errorInfo)
-    }
+    const { errors, onError } = createErrorCollector()
 
     const content = [
       'This is a test with a multi-line octicon:',
@@ -133,25 +131,22 @@ describe('octicon-aria-labels', () => {
       'Some more text.',
     ]
 
-    rule.function({ lines: content }, onError)
+    rule.function({ name: 'test.md', lines: content, frontMatterLines: [] }, onError)
 
     expect(errors.length).toBe(1)
     expect(errors[0].detail).toContain('aria-label=chevron-down')
   })
 
   test('falls back to "icon" when octicon name cannot be determined', () => {
-    const errors = []
-    const onError = (errorInfo) => {
-      errors.push(errorInfo)
-    }
+    const { errors, onError } = createErrorCollector()
 
     const content = [
       'This is a test with a malformed octicon:',
       '{% octicon variable %}',
       'Some more text.',
     ]
 
-    rule.function({ lines: content }, onError)
+    rule.function({ name: 'test.md', lines: content, frontMatterLines: [] }, onError)
 
     expect(errors.length).toBe(1)
     expect(errors[0].detail).toContain('aria-label=icon')

src/content-linter/tests/unit/outdated-release-phase-terminology.js renamed to src/content-linter/tests/unit/outdated-release-phase-terminology.ts

@@ -1,12 +1,13 @@
 import { describe, expect, test, beforeEach, afterEach } from 'vitest'
 import { renderContent } from '@/content-render/index'
 import { TitleFromAutotitleError } from '@/content-render/unified/rewrite-local-links'
+import type { Context } from '@/types'
 
 describe('link error line numbers', () => {
-  let fs
-  let originalReadFileSync
-  let originalExistsSync
-  let mockContext
+  let fs: any // Dynamic import of fs module for mocking in tests
+  let originalReadFileSync: any // Storing original fs.readFileSync for restoration after test
+  let originalExistsSync: any // Storing original fs.existsSync for restoration after test
+  let mockContext: Context
 
   beforeEach(async () => {
     // Set up file system mocking
@@ -20,11 +21,11 @@ describe('link error line numbers', () => {
     mockContext = {
       currentLanguage: 'en',
       currentVersion: 'free-pro-team@latest',
-      pages: new Map(),
-      redirects: new Map(),
+      pages: {} as any,
+      redirects: {} as any,
       page: {
         fullPath: '/fake/test-file.md',
-      },
+      } as any,
     }
   })
 
@@ -60,14 +61,16 @@ More content here.`
       // The broken link is on line 10 in the original file
       // (3 lines of frontmatter + 1 blank line + 1 title + 1 blank + 1 content + 1 blank + 1 link line)
       // The error message should reference the correct line number
-      expect(error.message).toContain('/nonexistent/page')
-      expect(error.message).toContain('could not be resolved')
-      expect(error.message).toContain('(Line: 10)')
+      expect((error as TitleFromAutotitleError).message).toContain('/nonexistent/page')
+      expect((error as TitleFromAutotitleError).message).toContain('could not be resolved')
+      expect((error as TitleFromAutotitleError).message).toContain('(Line: 10)')
     }
   })
 
   test('reports correct line numbers with different frontmatter sizes', async () => {
-    mockContext.page.fullPath = '/fake/test-file-2.md'
+    mockContext.page = {
+      fullPath: '/fake/test-file-2.md',
+    } as any
 
     // Test with more extensive frontmatter
     const template = `---
@@ -96,13 +99,15 @@ Content with a [AUTOTITLE](/another/nonexistent/page) link.`
       expect.fail('Expected TitleFromAutotitleError to be thrown')
     } catch (error) {
       expect(error).toBeInstanceOf(TitleFromAutotitleError)
-      expect(error.message).toContain('/another/nonexistent/page')
-      expect(error.message).toContain('could not be resolved')
+      expect((error as TitleFromAutotitleError).message).toContain('/another/nonexistent/page')
+      expect((error as TitleFromAutotitleError).message).toContain('could not be resolved')
     }
   })
 
   test('handles files without frontmatter correctly', async () => {
-    mockContext.page.fullPath = '/fake/no-frontmatter.md'
+    mockContext.page = {
+      fullPath: '/fake/no-frontmatter.md',
+    } as any
 
     // Test content without frontmatter
     const template = `# Simple Title
@@ -118,13 +123,15 @@ Here is a broken link: [AUTOTITLE](/missing/page).`
       expect.fail('Expected TitleFromAutotitleError to be thrown')
     } catch (error) {
       expect(error).toBeInstanceOf(TitleFromAutotitleError)
-      expect(error.message).toContain('/missing/page')
-      expect(error.message).toContain('could not be resolved')
+      expect((error as TitleFromAutotitleError).message).toContain('/missing/page')
+      expect((error as TitleFromAutotitleError).message).toContain('could not be resolved')
     }
   })
 
   test('error message format is improved', async () => {
-    mockContext.page.fullPath = '/fake/message-test.md'
+    mockContext.page = {
+      fullPath: '/fake/message-test.md',
+    } as any
 
     const template = `---
 title: Message Test
@@ -142,13 +149,17 @@ title: Message Test
       expect(error).toBeInstanceOf(TitleFromAutotitleError)
 
       // Check that the new error message format is used
-      expect(error.message).toContain('could not be resolved in one or more versions')
-      expect(error.message).toContain('Make sure that this link can be reached from all versions')
-      expect(error.message).toContain('/test/broken/link')
+      expect((error as TitleFromAutotitleError).message).toContain(
+        'could not be resolved in one or more versions',
+      )
+      expect((error as TitleFromAutotitleError).message).toContain(
+        'Make sure that this link can be reached from all versions',
+      )
+      expect((error as TitleFromAutotitleError).message).toContain('/test/broken/link')
 
       // Check that the old error message format is NOT used
-      expect(error.message).not.toContain('Unable to find Page by')
-      expect(error.message).not.toContain('To fix it, look at')
+      expect((error as TitleFromAutotitleError).message).not.toContain('Unable to find Page by')
+      expect((error as TitleFromAutotitleError).message).not.toContain('To fix it, look at')
     }
   })
 })