Convert precompile.js to TypeScript (#56556)

Author: heiskr

src/ghes-releases/scripts/deprecate/archive-version.ts

@@ -19,6 +19,7 @@ import loadRedirects from '@/redirects/lib/precompile'
 import { loadPageMap, loadPages } from '@/frame/lib/page-data'
 import { languageKeys } from '@/languages/lib/languages'
 import { RewriteAssetPathsPlugin } from '@/ghes-releases/scripts/deprecate/rewrite-asset-paths'
+import type { Page } from '@/types'
 
 const port = '4001'
 const host = `http://localhost:${port}`
@@ -27,7 +28,7 @@ const GH_PAGES_URL = `https://github.github.com/docs-ghes-${version}`
 
 // Once page-data.js is converted to TS,
 // we can import the more comprehesive type
-type PageList = Array<Object>
+type PageList = Page[]
 type MapObj = { [key: string]: string }
 
 program

src/redirects/lib/exception-redirects.js src/redirects/lib/exception-redirects.tssrc/redirects/lib/exception-redirects.js renamed to src/redirects/lib/exception-redirects.ts

@@ -1,16 +1,18 @@
 import fs from 'fs'
 
+type Redirects = Record<string, string>
+
 // This function expects a .txt file in a specific format.
-export default function getExceptionRedirects(exceptionsTxtFile) {
-  const exceptions = {}
+export default function getExceptionRedirects(exceptionsTxtFile: string): Redirects {
+  const exceptions: Redirects = {}
   const exceptionRedirectsLines = fs
     .readFileSync(exceptionsTxtFile, 'utf-8')
     .split('\n')
     .filter(Boolean)
     .map((line) => line.trim())
     .filter((line) => !line.startsWith('#'))
 
-  let parent = null
+  let parent: string | null = null
   for (const line of exceptionRedirectsLines) {
     if (line.startsWith('-')) {
       if (!parent) {

src/redirects/lib/permalinks.js src/redirects/lib/permalinks.tssrc/redirects/lib/permalinks.js renamed to src/redirects/lib/permalinks.ts

@@ -1,8 +1,15 @@
 import nonEnterpriseDefaultVersion from '@/versions/lib/non-enterprise-default-version'
 import { getPathWithoutVersion } from '@/frame/lib/path-utils'
 
-export default function permalinkRedirects(permalinks, redirectFrom) {
-  const redirects = {}
+import type { Permalink } from '@/types'
+
+type Redirects = Record<string, string>
+
+export default function permalinkRedirects(
+  permalinks: Permalink[],
+  redirectFrom: string[],
+): Redirects {
+  const redirects: Redirects = {}
   if (!permalinks.length) return redirects
 
   // The following is handling for versionless redirect fallbacks!

src/redirects/lib/precompile.js src/redirects/lib/precompile.tssrc/redirects/lib/precompile.js renamed to src/redirects/lib/precompile.ts

@@ -2,14 +2,20 @@ import { readCompressedJsonFileFallback } from '@/frame/lib/read-json-file'
 import getExceptionRedirects from './exception-redirects'
 import { latest } from '@/versions/lib/enterprise-server-releases'
 
+import type { Page } from '@/types'
+
 const EXCEPTIONS_FILE = './src/redirects/lib/static/redirect-exceptions.txt'
 
+type Redirects = Record<string, string>
+
 // This function runs at server warmup and precompiles possible redirect routes.
 // It outputs them in key-value pairs within a neat JavaScript object: { oldPath: newPath }
-export async function precompileRedirects(pageList) {
-  const allRedirects = readCompressedJsonFileFallback('./src/redirects/lib/static/developer.json')
+export async function precompileRedirects(pageList: Page[]): Promise<Redirects> {
+  const allRedirects: Redirects = readCompressedJsonFileFallback(
+    './src/redirects/lib/static/developer.json',
+  )
 
-  const externalRedirects = readCompressedJsonFileFallback(
+  const externalRedirects: Redirects = readCompressedJsonFileFallback(
     './src/redirects/lib/external-sites.json',
   )
   Object.assign(allRedirects, externalRedirects)
@@ -37,7 +43,7 @@ export async function precompileRedirects(pageList) {
   // The advantage of the exception redirects file is that it's encoded in plain
   // text so it's possible to write comments and it's also possible to write 1
   // destination URL once for each N redirect origins.
-  const exceptions = getExceptionRedirects(EXCEPTIONS_FILE)
+  const exceptions = getExceptionRedirects(EXCEPTIONS_FILE) as Redirects
   Object.assign(allRedirects, exceptions)
 
   Object.entries(allRedirects).forEach(([fromURI, toURI]) => {

…redirects/scripts/get-new-dotcom-path.js …redirects/scripts/get-new-dotcom-path.tssrc/redirects/scripts/get-new-dotcom-path.js renamed to src/redirects/scripts/get-new-dotcom-path.ts src/redirects/scripts/get-new-dotcom-path.js renamed to src/redirects/scripts/get-new-dotcom-path.ts

@@ -15,13 +15,13 @@ const markdownRegex = new RegExp(`${markdownExtension}$`, 'm')
 
 const newDotcomDir = 'content/github'
 
-const oldPath = process.argv.slice(2)[0]
+const oldPath: string = process.argv.slice(2)[0]
 assert(oldPath, 'must provide old dotcom path like "foo" or "articles/foo"')
 
-let filename = oldPath
+let filename: string = oldPath
 
 // get last part of path
-if (filename.includes('/')) filename = last(filename.split('/'))
+if (filename.includes('/')) filename = last(filename.split('/')) as string
 
 // first check whether name is a category
 const categoryDir = `${newDotcomDir}/${filename.replace(markdownRegex, '')}`
@@ -35,7 +35,7 @@ if (fs.existsSync(categoryDir)) {
 if (!filename.endsWith(markdownExtension)) filename = filename + markdownExtension
 
 // run find command
-const newPath = execSync(`find ${newDotcomDir} -name ${filename}`).toString()
+const newPath: string = execSync(`find ${newDotcomDir} -name ${filename}`).toString()
 
 if (!newPath) {
   console.log(`Cannot find new path for "${oldPath}". Check the name and try again.\n`)

src/redirects/scripts/helpers/add-redirect-to-frontmatter.js

@@ -0,0 +1,17 @@
+// add a new redirect string to redirect_from frontmatter
+
+export default function addRedirectToFrontmatter(
+  redirectFromData: string | string[] | undefined,
+  newRedirectString: string,
+): string[] {
+  if (Array.isArray(redirectFromData) && !redirectFromData.includes(newRedirectString)) {
+    redirectFromData.push(newRedirectString)
+    return redirectFromData
+  } else if (typeof redirectFromData === 'string') {
+    const redirectArray = [redirectFromData]
+    redirectArray.push(newRedirectString)
+    return redirectArray
+  } else {
+    return [newRedirectString]
+  }
+}

src/redirects/scripts/helpers/add-redirect-to-frontmatter.ts

@@ -323,6 +323,7 @@ export type Permalink = {
   pageVersion: string
   title: string
   href: string
+  hrefWithoutLanguage: string
 }
 
 export type FrontmatterVersions = {
@@ -361,6 +362,7 @@ export type Page = {
   effectiveDate?: string
   fullTitle?: string
   render: (context: Context) => Promise<string>
+  buildRedirects: () => Record<string, string>
   octicon?: string
   category?: string[]
   complexity?: string[]