Convert 28 JavaScript files to TypeScript (#57753)

Author: heiskr

src/content-linter/lib/helpers/print-annotations.js renamed to src/content-linter/lib/helpers/print-annotations.ts

@@ -6,11 +6,13 @@
  */
 
 export function printAnnotationResults(
-  results,
+  // Using 'any' type as results structure is dynamic and comes from various linting tools with different formats
+  results: any,
   { skippableRules = [], skippableFlawProperties = [] } = {},
 ) {
   for (const [file, flaws] of Object.entries(results)) {
-    for (const flaw of flaws) {
+    // Using 'any' type for flaws as they have varying structures depending on the linting rule
+    for (const flaw of flaws as any) {
       if (intersection(flaw.ruleNames, skippableRules)) {
         continue
       }
@@ -52,6 +54,7 @@ export function printAnnotationResults(
   }
 }
 
-function intersection(arr1, arr2) {
-  return arr1.some((item) => arr2.includes(item))
+// Using 'any' types for generic array intersection utility function
+function intersection(arr1: any[], arr2: any[]) {
+  return arr1.some((item: any) => arr2.includes(item))
 }

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

@@ -1,16 +1,18 @@
+// @ts-ignore - markdownlint-rule-helpers doesn't have TypeScript declarations
 import { addError } from 'markdownlint-rule-helpers'
 import { intersection } from 'lodash-es'
 
 import { getFrontmatter } from '../helpers/utils'
 import { formatAjvErrors } from '../helpers/schema-utils'
 import { frontmatter, deprecatedProperties } from '@/frame/lib/frontmatter'
 import readFrontmatter from '@/frame/lib/read-frontmatter'
+import type { RuleParams, RuleErrorCallback, Rule } from '../../types'
 
-export const frontmatterSchema = {
+export const frontmatterSchema: Rule = {
   names: ['GHD012', 'frontmatter-schema'],
   description: 'Frontmatter must conform to the schema',
   tags: ['frontmatter', 'schema'],
-  function: (params, onError) => {
+  function: (params: RuleParams, onError: RuleErrorCallback) => {
     const fm = getFrontmatter(params.lines)
     if (!fm) return
 
@@ -22,25 +24,25 @@ export const frontmatterSchema = {
     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) => line.trim().startsWith(key))
-      const lineNumber = params.lines.indexOf(line) + 1
+      const line = params.lines.find((line: string) => line.trim().startsWith(key))
+      const lineNumber = params.lines.indexOf(line!) + 1
       addError(
         onError,
         lineNumber,
         `The frontmatter property '${key}' is deprecated. Please remove the property from your article's frontmatter.`,
-        line,
-        [1, line.length],
+        line!,
+        [1, line!.length],
         null, // No fix possible
       )
     }
 
     // Check that the frontmatter matches the schema
     const { errors } = readFrontmatter(params.lines.join('\n'), { schema: frontmatter.schema })
-    const formattedErrors = formatAjvErrors(errors)
+    const formattedErrors = formatAjvErrors(errors as any)
     for (const error of formattedErrors) {
       // If the missing property is at the top level, we don't have a line
       // to point to. In that case, the error will be added to line 1.
-      const query = (line) => line.trim().startsWith(`${error.searchProperty}:`)
+      const query = (line: string) => line.trim().startsWith(`${error.searchProperty}:`)
       const line = error.searchProperty === '' ? null : params.lines.find(query)
       const lineNumber = line ? params.lines.indexOf(line) + 1 : 1
       addError(

src/content-linter/lib/linting-rules/image-alt-text-exclude-start-words.js renamed to src/content-linter/lib/linting-rules/image-alt-text-exclude-start-words.ts

@@ -1,28 +1,30 @@
+// @ts-ignore - markdownlint-rule-helpers doesn't have TypeScript declarations
 import { addError } from 'markdownlint-rule-helpers'
 
 import { forEachInlineChild, getRange } from '../helpers/utils'
+import type { RuleParams, RuleErrorCallback, MarkdownToken, Rule } from '../../types'
 
 const excludeStartWords = ['image', 'graphic']
 
 /*
   Images should have meaningful alternative text (alt text)
   and should not begin with words like "image" or "graphic".
  */
-export const imageAltTextExcludeStartWords = {
+export const imageAltTextExcludeStartWords: Rule = {
   names: ['GHD031', 'image-alt-text-exclude-words'],
   description: 'Alternate text for images should not begin with words like "image" or "graphic"',
   tags: ['accessibility', 'images'],
   parser: 'markdownit',
-  function: (params, onError) => {
-    forEachInlineChild(params, 'image', function forToken(token) {
-      const imageAltText = token.content.trim()
-
+  function: (params: RuleParams, onError: RuleErrorCallback) => {
+    forEachInlineChild(params, 'image', function forToken(token: MarkdownToken) {
       // If the alt text is empty, there is nothing to check and you can't
       // produce a valid range.
       // We can safely return early because the image-alt-text-length rule
       // will fail this one.
       if (!token.content) return
 
+      const imageAltText = token.content.trim()
+
       const range = getRange(token.line, imageAltText)
       if (
         excludeStartWords.some((excludeWord) => imageAltText.toLowerCase().startsWith(excludeWord))

src/content-linter/lib/linting-rules/internal-links-no-lang.js renamed to src/content-linter/lib/linting-rules/internal-links-no-lang.ts

@@ -1,15 +1,18 @@
+// @ts-ignore - markdownlint-rule-helpers doesn't have TypeScript declarations
 import { filterTokens } from 'markdownlint-rule-helpers'
 
 import { addFixErrorDetail, getRange } from '../helpers/utils'
 import { allLanguageKeys } from '@/languages/lib/languages'
+import type { RuleParams, RuleErrorCallback, Rule } from '../../types'
 
-export const internalLinksNoLang = {
+export const internalLinksNoLang: Rule = {
   names: ['GHD002', 'internal-links-no-lang'],
   description: 'Internal links must not have a hardcoded language code',
   tags: ['links', 'url'],
   parser: 'markdownit',
-  function: (params, onError) => {
-    filterTokens(params, 'inline', (token) => {
+  function: (params: RuleParams, onError: RuleErrorCallback) => {
+    // Using 'any' type for token as markdownlint-rule-helpers doesn't provide TypeScript types
+    filterTokens(params, 'inline', (token: any) => {
       for (const child of token.children) {
         if (child.type !== 'link_open') continue
 
@@ -18,14 +21,17 @@ export const internalLinksNoLang = {
         //  ['href', 'get-started'], ['target', '_blank'],
         //  ['rel', 'canonical'],
         // ]
+        // Attribute arrays are tuples of [attributeName, attributeValue] from markdownit parser
         const hrefsMissingSlashes = child.attrs
           // The attribute could also be `target` or `rel`
-          .filter((attr) => attr[0] === 'href')
-          .filter((attr) => attr[1].startsWith('/') || !attr[1].startsWith('//'))
+          .filter((attr: [string, string]) => attr[0] === 'href')
+          .filter((attr: [string, string]) => attr[1].startsWith('/') || !attr[1].startsWith('//'))
           // Filter out link paths that start with language code
-          .filter((attr) => allLanguageKeys.some((lang) => attr[1].split('/')[1] === lang))
+          .filter((attr: [string, string]) =>
+            allLanguageKeys.some((lang) => attr[1].split('/')[1] === lang),
+          )
           // Get the link path from the attribute
-          .map((attr) => attr[1])
+          .map((attr: [string, string]) => attr[1])
         // Create errors for each link path that includes a language code
         for (const linkPath of hrefsMissingSlashes) {
           const range = getRange(child.line, linkPath)

src/content-linter/lib/linting-rules/internal-links-slash.js renamed to src/content-linter/lib/linting-rules/internal-links-slash.ts

@@ -1,14 +1,17 @@
+// @ts-ignore - markdownlint-rule-helpers doesn't have TypeScript declarations
 import { filterTokens } from 'markdownlint-rule-helpers'
 
 import { addFixErrorDetail, getRange } from '../helpers/utils'
+import type { RuleParams, RuleErrorCallback, Rule } from '../../types'
 
-export const internalLinksSlash = {
+export const internalLinksSlash: Rule = {
   names: ['GHD003', 'internal-links-slash'],
   description: 'Internal links must start with a /',
   tags: ['links', 'url'],
   parser: 'markdownit',
-  function: (params, onError) => {
-    filterTokens(params, 'inline', (token) => {
+  function: (params: RuleParams, onError: RuleErrorCallback) => {
+    // Using 'any' type for token as markdownlint-rule-helpers doesn't provide TypeScript types
+    filterTokens(params, 'inline', (token: any) => {
       for (const child of token.children) {
         if (child.type !== 'link_open') continue
 
@@ -17,20 +20,21 @@ export const internalLinksSlash = {
         //  ['href', '/get-started'], ['target', '_blank'],
         //  ['rel', 'canonical'],
         // ]
+        // Attribute arrays are tuples of [attributeName, attributeValue] from markdownit parser
         const hrefsMissingSlashes = child.attrs
           // The attribute could also be `target` or `rel`
-          .filter((attr) => attr[0] === 'href')
+          .filter((attr: [string, string]) => attr[0] === 'href')
           // Filter out prefixes we don't want to check
           .filter(
-            (attr) =>
+            (attr: [string, string]) =>
               !['http', 'mailto', '#', '/'].some((ignorePrefix) =>
                 attr[1].startsWith(ignorePrefix),
               ),
           )
           // We can ignore empty links because MD042 from markdownlint catches empty links
-          .filter((attr) => attr[1] !== '')
+          .filter((attr: [string, string]) => attr[1] !== '')
           // Get the link path from the attribute
-          .map((attr) => attr[1])
+          .map((attr: [string, string]) => attr[1])
 
         // Create errors for each link path that doesn't start with a /
         for (const linkPath of hrefsMissingSlashes) {

src/content-linter/lib/linting-rules/link-punctuation.ts

@@ -1,15 +1,16 @@
 // @ts-ignore - markdownlint-rule-helpers doesn't have TypeScript declarations
 import { addError, filterTokens } from 'markdownlint-rule-helpers'
-import type { RuleParams, RuleErrorCallback } from '../../types'
+import type { RuleParams, RuleErrorCallback, Rule } from '../../types'
 
 import { doesStringEndWithPeriod, getRange, isStringQuoted } from '../helpers/utils'
 
-export const linkPunctuation = {
+export const linkPunctuation: Rule = {
   names: ['GHD001', 'link-punctuation'],
   description: 'Internal link titles must not contain punctuation',
   tags: ['links', 'url'],
   parser: 'markdownit',
   function: (params: RuleParams, onError: RuleErrorCallback) => {
+    // Using 'any' type for token as markdownlint-rule-helpers doesn't provide TypeScript types
     filterTokens(params, 'inline', (token: any) => {
       const { children, line } = token
       let inLink = false

src/content-linter/lib/linting-rules/liquid-quoted-conditional-arg.js renamed to src/content-linter/lib/linting-rules/liquid-quoted-conditional-arg.ts

@@ -1,8 +1,10 @@
 import { TokenKind } from 'liquidjs'
+// @ts-ignore - markdownlint-rule-helpers doesn't have TypeScript declarations
 import { addError } from 'markdownlint-rule-helpers'
 
 import { getLiquidTokens, conditionalTags, getPositionData } from '../helpers/liquid-utils'
 import { isStringQuoted } from '../helpers/utils'
+import type { RuleParams, RuleErrorCallback, Rule } from '../../types'
 
 /*
   Checks for instances where a Liquid conditional tag's argument is
@@ -12,18 +14,20 @@ import { isStringQuoted } from '../helpers/utils'
   {% if "foo" %}
   {% ifversion "bar" %}
 */
-export const liquidQuotedConditionalArg = {
+export const liquidQuotedConditionalArg: Rule = {
   names: ['GHD016', 'liquid-quoted-conditional-arg'],
   description: 'Liquid conditional tags should not quote the conditional argument',
   tags: ['liquid', 'format'],
-  function: (params, onError) => {
+  function: (params: RuleParams, onError: RuleErrorCallback) => {
     const content = params.lines.join('\n')
+    // Using 'any' type for tokens as getLiquidTokens returns tokens from liquid-utils.js which lacks type definitions
     const tokens = getLiquidTokens(content)
-      .filter((token) => token.kind === TokenKind.Tag)
-      .filter((token) => conditionalTags.includes(token.name))
-      .filter((token) => {
+      .filter((token: any) => token.kind === TokenKind.Tag)
+      .filter((token: any) => conditionalTags.includes(token.name))
+      .filter((token: any) => {
         const tokensArray = token.args.split(/\s+/g)
-        if (tokensArray.some((arg) => isStringQuoted(arg))) return true
+        // Using 'any' for args as they come from the untyped liquid token structure
+        if (tokensArray.some((arg: any) => isStringQuoted(arg))) return true
         return false
       })
 

src/content-linter/lib/linting-rules/octicon-aria-labels.js renamed to src/content-linter/lib/linting-rules/octicon-aria-labels.ts

@@ -1,6 +1,7 @@
 import { TokenKind } from 'liquidjs'
 import { getLiquidTokens, getPositionData } from '../helpers/liquid-utils'
 import { addFixErrorDetail } from '../helpers/utils'
+import type { RuleParams, RuleErrorCallback, Rule } from '../../types'
 /*
 Octicons should always have an aria-label attribute even if aria hidden. For example:
 
@@ -9,20 +10,21 @@ Octicons should always have an aria-label attribute even if aria hidden. For exa
   {% octicon "alert" aria-label="alert" aria-hidden="true" %}
   {% octicon "alert" aria-label="alert" aria-hidden="true" class="foo" %}
 
-  This is necessary for copilot to be able to recognize the svgs correctly when using our API. 
+  This is necessary for copilot to be able to recognize the svgs correctly when using our API.
 
 */
 
-export const octiconAriaLabels = {
+export const octiconAriaLabels: Rule = {
   names: ['GHD044', 'octicon-aria-labels'],
   description: 'Octicons should always have an aria-label attribute even if aria-hidden.',
   tags: ['accessibility', 'octicons'],
   parser: 'markdownit',
-  function: (params, onError) => {
+  function: (params: RuleParams, onError: RuleErrorCallback) => {
     const content = params.lines.join('\n')
+    // Using 'any' type for tokens as getLiquidTokens returns tokens from liquid-utils.js which lacks type definitions
     const tokens = getLiquidTokens(content)
-      .filter((token) => token.kind === TokenKind.Tag)
-      .filter((token) => token.name === 'octicon')
+      .filter((token: any) => token.kind === TokenKind.Tag)
+      .filter((token: any) => token.name === 'octicon')
 
     for (const token of tokens) {
       const { lineNumber, column, length } = getPositionData(token, params.lines)

src/content-linter/tests/unit/code-fence-line-length.js renamed to src/content-linter/tests/unit/code-fence-line-length.ts

@@ -41,7 +41,7 @@ describe(frontmatterEarlyAccessReferences.names.join(' - '), () => {
     expect(lineNumbers.includes(4)).toBe(false)
     expect(lineNumbers.includes(5)).toBe(false)
     expect(errors[0].errorRange).toEqual([8, 12])
-    expect(errors[1].errorRange).toEqual([15, 12], [28, 12])
+    expect(errors[1].errorRange).toEqual([15, 12])
   })
   test('early access file with early access references passes', async () => {
     const result = await runRule(frontmatterEarlyAccessReferences, {