Convert JavaScript files to TypeScript in multiple directories (#55550)

Author: heiskr

src/article-api/tests/pageinfo.js src/article-api/tests/pageinfo.tssrc/article-api/tests/pageinfo.js renamed to src/article-api/tests/pageinfo.ts

@@ -4,7 +4,18 @@ import { get } from '#src/tests/helpers/e2etest.js'
 import { SURROGATE_ENUMS } from '#src/frame/middleware/set-fastly-surrogate-key.js'
 import { latest } from '#src/versions/lib/enterprise-server-releases.js'
 
-const makeURL = (pathname) => `/api/article/meta?${new URLSearchParams({ pathname })}`
+const makeURL = (pathname: string): string =>
+  `/api/article/meta?${new URLSearchParams({ pathname })}`
+
+interface PageMetadata {
+  product: string
+  title: string
+  intro: string
+}
+
+interface ErrorResponse {
+  error: string
+}
 
 describe('pageinfo api', () => {
   beforeAll(() => {
@@ -27,7 +38,7 @@ describe('pageinfo api', () => {
   test('happy path', async () => {
     const res = await get(makeURL('/en/get-started/start-your-journey'))
     expect(res.statusCode).toBe(200)
-    const meta = JSON.parse(res.body)
+    const meta = JSON.parse(res.body) as PageMetadata
     expect(meta.product).toBe('Get started')
     expect(meta.title).toBe('Start your journey')
     expect(meta.intro).toBe(
@@ -45,28 +56,28 @@ describe('pageinfo api', () => {
   test('a pathname that does not exist', async () => {
     const res = await get(makeURL('/en/never/heard/of'))
     expect(res.statusCode).toBe(404)
-    const { error } = JSON.parse(res.body)
+    const { error } = JSON.parse(res.body) as ErrorResponse
     expect(error).toBe("No page found for '/en/never/heard/of'")
   })
 
   test("no 'pathname' query string at all", async () => {
     const res = await get('/api/article/meta')
     expect(res.statusCode).toBe(400)
-    const { error } = JSON.parse(res.body)
+    const { error } = JSON.parse(res.body) as ErrorResponse
     expect(error).toBe("No 'pathname' query")
   })
 
   test("empty 'pathname' query string", async () => {
     const res = await get('/api/article/meta?pathname=%20')
     expect(res.statusCode).toBe(400)
-    const { error } = JSON.parse(res.body)
+    const { error } = JSON.parse(res.body) as ErrorResponse
     expect(error).toBe("'pathname' query empty")
   })
 
   test('repeated pathname query string key', async () => {
     const res = await get('/api/article/meta?pathname=a&pathname=b')
     expect(res.statusCode).toBe(400)
-    const { error } = JSON.parse(res.body)
+    const { error } = JSON.parse(res.body) as ErrorResponse
     expect(error).toBe("Multiple 'pathname' keys")
   })
 
@@ -75,28 +86,28 @@ describe('pageinfo api', () => {
     {
       const res = await get(makeURL('/en/olden-days'))
       expect(res.statusCode).toBe(200)
-      const meta = JSON.parse(res.body)
+      const meta = JSON.parse(res.body) as PageMetadata
       expect(meta.title).toBe('HubGit.com Fixture Documentation')
     }
     // Trailing slashes are always removed
     {
       const res = await get(makeURL('/en/olden-days/'))
       expect(res.statusCode).toBe(200)
-      const meta = JSON.parse(res.body)
+      const meta = JSON.parse(res.body) as PageMetadata
       expect(meta.title).toBe('HubGit.com Fixture Documentation')
     }
     // Short code for latest version
     {
       const res = await get(makeURL('/en/enterprise-server@latest/get-started/liquid/ifversion'))
       expect(res.statusCode).toBe(200)
-      const meta = JSON.parse(res.body)
+      const meta = JSON.parse(res.body) as PageMetadata
       expect(meta.intro).toMatch(/\(not on fpt\)/)
     }
     // A URL that doesn't have fpt as an available version
     {
       const res = await get(makeURL('/en/get-started/versioning/only-ghec-and-ghes'))
       expect(res.statusCode).toBe(200)
-      const meta = JSON.parse(res.body)
+      const meta = JSON.parse(res.body) as PageMetadata
       expect(meta.title).toBe('Only in Enterprise Cloud and Enterprise Server')
     }
   })
@@ -108,14 +119,14 @@ describe('pageinfo api', () => {
     {
       const res = await get(makeURL('/en/get-started/liquid/ifversion'))
       expect(res.statusCode).toBe(200)
-      const meta = JSON.parse(res.body)
+      const meta = JSON.parse(res.body) as PageMetadata
       expect(meta.intro).toMatch(/\(on fpt\)/)
     }
     // Second on any other version
     {
       const res = await get(makeURL('/en/enterprise-server@latest/get-started/liquid/ifversion'))
       expect(res.statusCode).toBe(200)
-      const meta = JSON.parse(res.body)
+      const meta = JSON.parse(res.body) as PageMetadata
       expect(meta.intro).toMatch(/\(not on fpt\)/)
     }
   })
@@ -125,7 +136,7 @@ describe('pageinfo api', () => {
     {
       const res = await get(makeURL('/en'))
       expect(res.statusCode).toBe(200)
-      const meta = JSON.parse(res.body)
+      const meta = JSON.parse(res.body) as PageMetadata
       expect(meta.title).toMatch('HubGit.com Fixture Documentation')
     }
     // enterprise-server with language specified
@@ -137,7 +148,7 @@ describe('pageinfo api', () => {
     {
       const res = await get(makeURL(`/en/enterprise-server@${latest}`))
       expect(res.statusCode).toBe(200)
-      const meta = JSON.parse(res.body)
+      const meta = JSON.parse(res.body) as PageMetadata
       expect(meta.title).toMatch('HubGit Enterprise Server Fixture Documentation')
     }
   })
@@ -147,14 +158,14 @@ describe('pageinfo api', () => {
     {
       const res = await get(makeURL('/'))
       expect(res.statusCode).toBe(200)
-      const meta = JSON.parse(res.body)
+      const meta = JSON.parse(res.body) as PageMetadata
       expect(meta.title).toMatch('HubGit.com Fixture Documentation')
     }
     // enterprise-server without language specified
     {
       const res = await get(makeURL('/enterprise-server@latest'))
       expect(res.statusCode).toBe(200)
-      const meta = JSON.parse(res.body)
+      const meta = JSON.parse(res.body) as PageMetadata
       expect(meta.title).toMatch('HubGit Enterprise Server Fixture Documentation')
     }
   })
@@ -169,38 +180,38 @@ describe('pageinfo api', () => {
     {
       const res = await get(makeURL('/en/[email protected]'))
       expect(res.statusCode).toBe(200)
-      const meta = JSON.parse(res.body)
+      const meta = JSON.parse(res.body) as PageMetadata
       expect(meta.title).toMatch('GitHub Enterprise Server 3.2 Help Documentation')
     }
 
     // The oldest known archived version that we proxy
     {
       const res = await get(makeURL('/en/enterprise/11.10.340'))
       expect(res.statusCode).toBe(200)
-      const meta = JSON.parse(res.body)
+      const meta = JSON.parse(res.body) as PageMetadata
       expect(meta.title).toMatch('GitHub Enterprise Server 11.10.340 Help Documentation')
     }
   })
 
   test('pathname has to start with /', async () => {
     const res = await get(makeURL('ip'))
     expect(res.statusCode).toBe(400)
-    const { error } = JSON.parse(res.body)
+    const { error } = JSON.parse(res.body) as ErrorResponse
     expect(error).toBe("'pathname' has to start with /")
   })
 
   test("pathname can't contain spaces /", async () => {
     const res = await get(makeURL('/en foo bar'))
     expect(res.statusCode).toBe(400)
-    const { error } = JSON.parse(res.body)
+    const { error } = JSON.parse(res.body) as ErrorResponse
     expect(error).toBe("'pathname' cannot contain whitespace")
   })
 
   describe('translations', () => {
     test('Japanese page', async () => {
       const res = await get(makeURL('/ja/get-started/start-your-journey/hello-world'))
       expect(res.statusCode).toBe(200)
-      const meta = JSON.parse(res.body)
+      const meta = JSON.parse(res.body) as PageMetadata
       expect(meta.product).toBe('はじめに')
       expect(meta.title).toBe('こんにちは World')
       expect(meta.intro).toBe('この Hello World 演習に従って、HubGit の使用を開始します。')
@@ -213,8 +224,8 @@ describe('pageinfo api', () => {
       // even exist on disk. So it'll fall back to English.
       const translationRes = await get(makeURL('/ja/get-started/start-your-journey'))
       expect(translationRes.statusCode).toBe(200)
-      const en = JSON.parse(enRes.body)
-      const translation = JSON.parse(translationRes.body)
+      const en = JSON.parse(enRes.body) as PageMetadata
+      const translation = JSON.parse(translationRes.body) as PageMetadata
       expect(en.title).toBe(translation.title)
       expect(en.intro).toBe(translation.intro)
     })

src/assets/lib/image-density.js src/assets/lib/image-density.tssrc/assets/lib/image-density.js renamed to src/assets/lib/image-density.ts

@@ -1,8 +1,12 @@
 import fs from 'fs'
 
+interface ImageDensityMap {
+  [path: string]: string
+}
+
 const file = fs.readFileSync('./src/assets/lib/image-density.txt', 'utf8')
 
-export const IMAGE_DENSITY = Object.fromEntries(
+export const IMAGE_DENSITY: ImageDensityMap = Object.fromEntries(
   file.split('\n').map((line) => {
     const [path, density] = line.split(' ')
     return [path, density]

src/color-schemes/tests/use-theme.js src/color-schemes/tests/use-theme.tssrc/color-schemes/tests/use-theme.js renamed to src/color-schemes/tests/use-theme.ts

@@ -5,11 +5,23 @@ import {
   getCssTheme,
   defaultCSSTheme,
   defaultComponentTheme,
-} from '../components/useTheme.ts'
+} from '../components/useTheme'
+
+interface ThemeCookieValue {
+  color_mode?: string
+  light_theme?: {
+    name: string
+    color_mode: string
+  }
+  dark_theme?: {
+    name: string
+    color_mode: string
+  }
+}
 
 describe('getTheme basics', () => {
   test('always return an object with certain keys', () => {
-    const cookieValue = JSON.stringify({})
+    const cookieValue = JSON.stringify({} as ThemeCookieValue)
     expect(getCssTheme(cookieValue)).toEqual(defaultCSSTheme)
     expect(getComponentTheme(cookieValue)).toEqual(defaultComponentTheme)
   })
@@ -25,7 +37,7 @@ describe('getTheme basics', () => {
       color_mode: 'dark',
       light_theme: { name: 'light_colorblind', color_mode: 'light' },
       dark_theme: { name: 'dark_tritanopia', color_mode: 'dark' },
-    })
+    } as ThemeCookieValue)
 
     const cssTheme = getCssTheme(cookieValue)
     expect(cssTheme.colorMode).toBe('dark')

src/content-render/unified/rewrite-asset-img-tags.js

@@ -1,5 +1,5 @@
 import { visit, SKIP } from 'unist-util-visit'
-import { IMAGE_DENSITY } from '../../assets/lib/image-density.js'
+import { IMAGE_DENSITY } from '../../assets/lib/image-density.ts'
 
 // This number must match a width we're willing to accept in a dynamic
 // asset URL.

src/events/lib/get-document-type.js src/events/lib/get-document-type.tssrc/events/lib/get-document-type.js renamed to src/events/lib/get-document-type.ts

@@ -1,7 +1,14 @@
-// This function derives the document type from the *relative path* segment length,
-// where a relative path refers to the content path starting with the product dir.
-// For example: actions/index.md or github/getting-started-with-github/quickstart.md.
-export default function getDocumentType(relativePath) {
+/**
+ * Document types used by the system
+ */
+type DocumentType = 'homepage' | 'product' | 'category' | 'mapTopic' | 'article' | 'early-access'
+
+/**
+ * This function derives the document type from the *relative path* segment length,
+ * where a relative path refers to the content path starting with the product dir.
+ * For example: actions/index.md or github/getting-started-with-github/quickstart.md.
+ */
+export default function getDocumentType(relativePath: string): DocumentType {
   // A non-index file is ALWAYS considered an article in this approach,
   // even if it's at the category level (like actions/quickstart.md)
   if (!relativePath.endsWith('index.md')) {
@@ -13,9 +20,15 @@ export default function getDocumentType(relativePath) {
   // Early Access has an extra tree segment, so it has a different number of segments.
   const isEarlyAccess = relativePath.startsWith('early-access')
 
-  const publicDocs = ['homepage', 'product', 'category', 'mapTopic']
+  const publicDocs: DocumentType[] = ['homepage', 'product', 'category', 'mapTopic']
 
-  const earlyAccessDocs = ['homepage', 'early-access', 'product', 'category', 'mapTopic']
+  const earlyAccessDocs: DocumentType[] = [
+    'homepage',
+    'early-access',
+    'product',
+    'category',
+    'mapTopic',
+  ]
 
   // Anything beyond the largest depth is assumed to be a mapTopic
   return isEarlyAccess

src/frame/lib/page.js

@@ -13,7 +13,7 @@ import { productMap } from '#src/products/lib/all-products.js'
 import slash from 'slash'
 import readFileContents from './read-file-contents.js'
 import getLinkData from '#src/learning-track/lib/get-link-data.js'
-import getDocumentType from '#src/events/lib/get-document-type.js'
+import getDocumentType from '#src/events/lib/get-document-type.ts'
 import { allTools } from '#src/tools/lib/all-tools.js'
 import { renderContentWithFallback } from '#src/languages/lib/render-with-fallback.js'
 import { deprecated, supported } from '#src/versions/lib/enterprise-server-releases.js'

src/release-notes/tests/yaml.js src/release-notes/tests/yaml.tssrc/release-notes/tests/yaml.js renamed to src/release-notes/tests/yaml.ts

@@ -7,6 +7,14 @@ import yaml from 'js-yaml'
 
 import { liquid } from '#src/content-render/index.js'
 
+interface ReleaseNoteContent {
+  intro: string
+  sections: {
+    [key: string]: Array<string | { [prop: string]: string }>
+  }
+  currentWeek?: boolean
+}
+
 const ghesReleaseNoteRootPath = 'data/release-notes'
 const yamlWalkOptions = {
   globs: ['**/*.yml'],
@@ -18,17 +26,17 @@ const yamlFileList = walk(ghesReleaseNoteRootPath, yamlWalkOptions).sort()
 describe('lint enterprise release notes', () => {
   if (yamlFileList.length < 1) return
   describe.each(yamlFileList)('%s', (yamlAbsPath) => {
-    let yamlContent
+    let yamlContent: ReleaseNoteContent
     const relativePath = path.relative('', yamlAbsPath)
 
     beforeAll(async () => {
       const fileContents = await readFile(yamlAbsPath, 'utf8')
-      yamlContent = yaml.load(fileContents)
+      yamlContent = yaml.load(fileContents) as ReleaseNoteContent
     })
 
     test('contains valid liquid', () => {
       const { intro, sections } = yamlContent
-      let toLint = { intro }
+      let toLint: Record<string, string> = { intro }
       for (const key in sections) {
         const section = sections[key]
         const label = `sections.${key}`
@@ -37,7 +45,10 @@ describe('lint enterprise release notes', () => {
             toLint = { ...toLint, ...{ [label]: section.join('\n') } }
           } else {
             for (const prop in section) {
-              toLint = { ...toLint, ...{ [`${label}.${prop}`]: section[prop] } }
+              const value = section[prop]
+              if (typeof value === 'string') {
+                toLint = { ...toLint, ...{ [`${label}.${prop}`]: value } }
+              }
             }
           }
         })
@@ -49,7 +60,7 @@ describe('lint enterprise release notes', () => {
       }
     })
 
-    const currentWeeksFound = []
+    const currentWeeksFound: string[] = []
     test('does not have more than one yaml file with currentWeek set to true', () => {
       if (!yamlAbsPath.includes('data/release-notes/github-ae')) return
       if (yamlContent.currentWeek) currentWeeksFound.push(relativePath)