Migrate 15 JavaScript files to TypeScript (#57875)

Author: heiskr

src/content-linter/scripts/disable-rules.js renamed to src/content-linter/scripts/disable-rules.ts

@@ -9,7 +9,7 @@
 import fs from 'fs'
 import { spawn } from 'child_process'
 
-const rule = process.argv[2]
+const rule: string | undefined = process.argv[2]
 if (!rule) {
   console.error('Please specify a rule to disable.')
   process.exit(1)
@@ -38,36 +38,40 @@ const childProcess = spawn('npm', [
   rule,
 ])
 
-childProcess.stdout.on('data', (data) => {
+childProcess.stdout.on('data', (data: Buffer) => {
   if (verbose) console.log(data.toString())
 })
 
-childProcess.stderr.on('data', function (data) {
+childProcess.stderr.on('data', function (data: Buffer) {
   if (verbose) console.log(data.toString())
 })
 
 let matchingRulesFound = 0
-childProcess.on('close', (code) => {
+childProcess.on('close', (code: number | null) => {
   if (code === 0) {
     console.log(`No violations for rule, "${rule}" found.`)
     process.exit(0)
   }
 
-  const markdownViolations = JSON.parse(fs.readFileSync('markdown-violations.json', 'utf8'))
+  const markdownViolations: Record<string, Array<{ lineNumber: number }>> = JSON.parse(
+    fs.readFileSync('markdown-violations.json', 'utf8'),
+  )
   console.log(`${Object.values(markdownViolations).flat().length} violations found.`)
 
-  Object.entries(markdownViolations).forEach(([fileName, results]) => {
-    console.log(fileName)
-    console.log(results)
-    const fileLines = fs.readFileSync(fileName, 'utf8').split('\n')
-    results.forEach((result) => {
-      matchingRulesFound++
-      const lineIndex = result.lineNumber - 1
-      const offendingLine = fileLines[lineIndex]
-      fileLines[lineIndex] = offendingLine.concat(` <!-- markdownlint-disable-line ${rule} -->`)
-    })
-    fs.writeFileSync(fileName, fileLines.join('\n'), 'utf8')
-  })
+  Object.entries(markdownViolations).forEach(
+    ([fileName, results]: [string, Array<{ lineNumber: number }>]) => {
+      console.log(fileName)
+      console.log(results)
+      const fileLines = fs.readFileSync(fileName, 'utf8').split('\n')
+      results.forEach((result) => {
+        matchingRulesFound++
+        const lineIndex = result.lineNumber - 1
+        const offendingLine = fileLines[lineIndex]
+        fileLines[lineIndex] = offendingLine.concat(` <!-- markdownlint-disable-line ${rule} -->`)
+      })
+      fs.writeFileSync(fileName, fileLines.join('\n'), 'utf8')
+    },
+  )
 
   console.log(`${matchingRulesFound} violations ignored.`)
 })

src/content-linter/tests/unit/liquid-data-tags.js renamed to src/content-linter/tests/unit/liquid-data-tags.ts

@@ -3,6 +3,7 @@ import path from 'path'
 import { afterAll, beforeAll, describe, expect, test } from 'vitest'
 
 import { runRule } from '../../lib/init-test'
+import type { Rule } from '@/content-linter/types'
 import {
   liquidDataReferencesDefined,
   liquidDataTagFormat,
@@ -31,7 +32,7 @@ describe(liquidDataReferencesDefined.names.join(' - '), () => {
       '{% data ui.nested.nested.not-there %}',
       '{% data some.random.path %}',
     ]
-    const result = await runRule(liquidDataReferencesDefined, {
+    const result = await runRule(liquidDataReferencesDefined as Rule, {
       strings: { markdown: markdown.join('\n') },
     })
     const errors = result.markdown
@@ -45,7 +46,7 @@ describe(liquidDataReferencesDefined.names.join(' - '), () => {
       '{% data variables.location.product_location %}',
       '{% data ui.header.notices.release_candidate %}',
     ].join('\n')
-    const result = await runRule(liquidDataReferencesDefined, { strings: { markdown } })
+    const result = await runRule(liquidDataReferencesDefined as Rule, { strings: { markdown } })
     const errors = result.markdown
     expect(errors.length).toBe(0)
   })
@@ -57,7 +58,7 @@ describe(liquidDataReferencesDefined.names.join(' - '), () => {
       '{% data %}',
       '{% indented_data_reference %}',
     ]
-    const result = await runRule(liquidDataTagFormat, {
+    const result = await runRule(liquidDataTagFormat as Rule, {
       strings: { markdown: markdown.join('\n') },
     })
     const errors = result.markdown
@@ -69,7 +70,7 @@ describe(liquidDataReferencesDefined.names.join(' - '), () => {
       '{% data  ui.header.notices.release_candidate  %}',
       '{% indented_data_reference ui.header.notices.release_candidate  spaces=3 %}',
     ]
-    const result = await runRule(liquidDataTagFormat, {
+    const result = await runRule(liquidDataTagFormat as Rule, {
       strings: { markdown: markdown.join('\n') },
     })
     const errors = result.markdown

src/content-linter/tests/unit/liquid-syntax.js renamed to src/content-linter/tests/unit/liquid-syntax.ts

@@ -4,6 +4,7 @@ import { execSync } from 'child_process'
 
 import { renderLiquid } from '@/content-render/liquid/index'
 import shortVersionsMiddleware from '@/versions/middleware/short-versions'
+import type { ExtendedRequest } from '@/types'
 
 const { loadPages } = await import('@/frame/lib/page-data.js')
 const { allVersions } = await import('@/versions/lib/all-versions.js')
@@ -32,20 +33,20 @@ for (const page of pages) {
   console.log(`---\nStart: Creating directories for: ${page.relativePath}`)
   const dirnames = page.relativePath.substring(0, page.relativePath.lastIndexOf('/'))
 
-  fs.mkdirSync(`${contentCopilotDir}/${dirnames}`, { recursive: true }, (err) => {
-    if (err) throw err
-  })
+  fs.mkdirSync(`${contentCopilotDir}/${dirnames}`, { recursive: true })
   // Context needed to render the content liquid
-  const req = { language: 'en' }
-  const contextualize = (req) => {
-    req.context.currentVersionObj = req.context.allVersions[req.context.currentVersion]
+  const req = { language: 'en' } as ExtendedRequest
+  const contextualize = (req: ExtendedRequest): void => {
+    if (!req.context) return
+    if (!req.context.currentVersion) return
+    req.context.currentVersionObj = req.context.allVersions?.[req.context.currentVersion]
     shortVersionsMiddleware(req, null, () => {})
   }
 
   req.context = {
     currentLanguage: 'en',
     currentVersion: 'free-pro-team@latest',
-    page: {},
+    page: {} as any, // Empty page object used only for context initialization
     allVersions,
   }
   contextualize(req)
@@ -77,7 +78,8 @@ for (const page of pages) {
       'utf8',
     )
     console.log(`Done: written file\n---`)
-  } catch (err) {
+  } catch (err: any) {
+    // Standard catch-all for error handling in scripts
     console.log(err)
   }
 }

src/content-linter/tests/unit/liquid-tag-whitespace.js renamed to src/content-linter/tests/unit/liquid-tag-whitespace.ts

@@ -4,9 +4,16 @@ Custom "Alerts", based on similar filter/styling in the monolith code.
 
 import { visit } from 'unist-util-visit'
 import { h } from 'hastscript'
+// @ts-ignore - no types available for @primer/octicons
 import octicons from '@primer/octicons'
+import type { Element } from 'hast'
 
-const alertTypes = {
+interface AlertType {
+  icon: string
+  color: string
+}
+
+const alertTypes: Record<string, AlertType> = {
   NOTE: { icon: 'info', color: 'accent' },
   IMPORTANT: { icon: 'report', color: 'done' },
   WARNING: { icon: 'alert', color: 'attention' },
@@ -17,14 +24,17 @@ const alertTypes = {
 // Must contain one of [!NOTE], [!IMPORTANT], ...
 const ALERT_REGEXP = new RegExp(`\\[!(${Object.keys(alertTypes).join('|')})\\]`, 'gi')
 
-const matcher = (node) =>
+// Using any due to conflicting unist/hast type definitions between dependencies
+const matcher = (node: any): boolean =>
   node.type === 'element' &&
   node.tagName === 'blockquote' &&
   ALERT_REGEXP.test(JSON.stringify(node.children))
 
-export default function alerts({ alertTitles = {} }) {
-  return (tree) => {
-    visit(tree, matcher, (node) => {
+export default function alerts({ alertTitles = {} }: { alertTitles?: Record<string, string> }) {
+  // Using any due to conflicting unist/hast type definitions between dependencies
+  return (tree: any) => {
+    // Using any due to conflicting unist/hast type definitions between dependencies
+    visit(tree, matcher, (node: any) => {
       const key = getAlertKey(node)
       if (!(key in alertTypes)) {
         console.warn(
@@ -48,13 +58,14 @@ export default function alerts({ alertTitles = {} }) {
   }
 }
 
-function getAlertKey(node) {
+function getAlertKey(node: Element): string {
   const body = JSON.stringify(node.children)
   const matches = body.match(ALERT_REGEXP)
-  return matches[0].slice(2, -1)
+  return matches![0].slice(2, -1)
 }
 
-function removeAlertSyntax(node) {
+// Using any to handle both array and object node types recursively
+function removeAlertSyntax(node: any): any {
   if (Array.isArray(node)) {
     return node.map(removeAlertSyntax)
   }
@@ -67,7 +78,7 @@ function removeAlertSyntax(node) {
   return node
 }
 
-function getOcticonSVG(name) {
+function getOcticonSVG(name: string): Element {
   return h(
     'svg',
     {
@@ -78,6 +89,6 @@ function getOcticonSVG(name) {
       className: 'octicon mr-2',
       ariaHidden: true,
     },
-    h('path', { d: octicons[name].heights[16].path.match(/d="(.*)"/)[1] }),
+    h('path', { d: octicons[name].heights[16].path.match(/d="(.*)"/)![1] }),
   )
 }

src/content-render/scripts/render-content-markdown.js renamed to src/content-render/scripts/render-content-markdown.ts

@@ -32,7 +32,7 @@ const section = {
       },
     },
   ],
-}
+} as const
 
 export default {
   type: 'object',
@@ -69,7 +69,10 @@ export default {
         'errata',
         'closing_down',
         'retired',
-      ].reduce((prev, curr) => ({ ...prev, [curr]: section }), {}),
+      ].reduce(
+        (prev: Record<string, typeof section>, curr: string) => ({ ...prev, [curr]: section }),
+        {},
+      ),
     },
   },
-}
+} as const

src/content-render/unified/alerts.js renamed to src/content-render/unified/alerts.ts

@@ -28,13 +28,20 @@ page.permalinks is an array of objects that looks like this:
 ]
 */
 class Permalink {
-  constructor(languageCode, pageVersion, relativePath, title) {
+  languageCode: string
+  pageVersion: string
+  relativePath: string
+  title: string
+  hrefWithoutLanguage: string
+  href: string
+
+  constructor(languageCode: string, pageVersion: string, relativePath: string, title: string) {
     this.languageCode = languageCode
     this.pageVersion = pageVersion
     this.relativePath = relativePath
     this.title = title
 
-    const permalinkSuffix = this.constructor.relativePathToSuffix(relativePath)
+    const permalinkSuffix = Permalink.relativePathToSuffix(relativePath)
 
     this.hrefWithoutLanguage = removeFPTFromPath(
       path.posix.join('/', pageVersion, permalinkSuffix),
@@ -46,18 +53,23 @@ class Permalink {
     return this
   }
 
-  static derive(languageCode, relativePath, title, applicableVersions) {
+  static derive(
+    languageCode: string,
+    relativePath: string,
+    title: string,
+    applicableVersions: string[],
+  ): Permalink[] {
     assert(relativePath, 'relativePath is required')
     assert(languageCode, 'languageCode is required')
 
-    const permalinks = applicableVersions.map((pageVersion) => {
+    const permalinks = applicableVersions.map((pageVersion: string) => {
       return new Permalink(languageCode, pageVersion, relativePath, title)
     })
 
     return permalinks
   }
 
-  static relativePathToSuffix(relativePath) {
+  static relativePathToSuffix(relativePath: string): string {
     if (relativePath === 'index.md') return '/'
     // When you turn `foo/bar.md`, which is a file path, into a URL pathname,
     // you just need to chop off the `.md` suffix.

src/data-directory/lib/data-schemas/release-notes.js renamed to src/data-directory/lib/data-schemas/release-notes.ts

@@ -2,15 +2,20 @@ import matter from '@gr2m/gray-matter'
 
 import { validateJson } from '@/tests/lib/validate-json-schema'
 
-function readFrontmatter(markdown, opts = {}) {
+interface ReadFrontmatterOptions {
+  schema?: Record<string, any> // Schema can have arbitrary properties for validation
+  filepath?: string | null
+}
+
+function readFrontmatter(markdown: string, opts: ReadFrontmatterOptions = {}) {
   const schema = opts.schema || { type: 'object', properties: {} }
   const filepath = opts.filepath || null
 
   let content, data
 
   try {
     ;({ content, data } = matter(markdown))
-  } catch (e) {
+  } catch (e: any) {
     const defaultReason = 'invalid frontmatter entry'
 
     const reason = e.reason
@@ -21,7 +26,7 @@ function readFrontmatter(markdown, opts = {}) {
         : e.reason
       : defaultReason
 
-    const error = {
+    const error: any = {
       reason,
       message: 'YML parsing error!',
     }
@@ -33,7 +38,7 @@ function readFrontmatter(markdown, opts = {}) {
     return { errors }
   }
 
-  const validate = validateJson(schema, data)
+  const validate: any = validateJson(schema, data)
 
   // Combine the AJV-supplied `instancePath` and `params` into a more user-friendly frontmatter path.
   // For example, given:
@@ -44,7 +49,7 @@ function readFrontmatter(markdown, opts = {}) {
   //
   // The purpose is to help users understand that the error is on the `fpt` key within the `versions` object.
   // Note if the error is on a top-level FM property like `title`, the `instancePath` will be empty.
-  const cleanPropertyPath = (params, instancePath) => {
+  const cleanPropertyPath = (params: Record<string, any>, instancePath: string) => {
     const mainProps = Object.values(params)[0]
     if (!instancePath) return mainProps
 
@@ -55,8 +60,8 @@ function readFrontmatter(markdown, opts = {}) {
   const errors = []
 
   if (!validate.isValid && filepath) {
-    const formattedErrors = validate.errors.map((error) => {
-      const userFriendly = {}
+    const formattedErrors = validate.errors.map((error: any) => {
+      const userFriendly: any = {}
       userFriendly.property = cleanPropertyPath(error.params, error.instancePath)
       userFriendly.message = error.message
       userFriendly.reason = error.keyword