Convert tools directory JavaScript files to TypeScript (#55552)

Author: heiskr

src/content-render/liquid/tool.js

@@ -1,5 +1,5 @@
-import { allTools } from '#src/tools/lib/all-tools.js'
-import { allPlatforms } from '#src/tools/lib/all-platforms.js'
+import { allTools } from '#src/tools/lib/all-tools.ts'
+import { allPlatforms } from '#src/tools/lib/all-platforms.ts'
 
 export const tags = Object.keys(allTools).concat(allPlatforms).concat(['rowheaders'])
 

src/frame/lib/frontmatter.js

@@ -1,6 +1,6 @@
 import parse from './read-frontmatter.js'
 import { allVersions } from '#src/versions/lib/all-versions.js'
-import { allTools } from '#src/tools/lib/all-tools.js'
+import { allTools } from '#src/tools/lib/all-tools.ts'
 import { getDeepDataByLanguage } from '#src/data-directory/lib/get-data.js'
 
 const layoutNames = [

src/frame/lib/page.js

@@ -14,10 +14,10 @@ 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.ts'
-import { allTools } from '#src/tools/lib/all-tools.js'
+import { allTools } from '#src/tools/lib/all-tools.ts'
 import { renderContentWithFallback } from '#src/languages/lib/render-with-fallback.js'
 import { deprecated, supported } from '#src/versions/lib/enterprise-server-releases.js'
-import { allPlatforms } from '#src/tools/lib/all-platforms.js'
+import { allPlatforms } from '#src/tools/lib/all-platforms.ts'
 
 // We're going to check a lot of pages' "ID" (the first part of
 // the relativePath) against `productMap` to make sure it's valid.

src/shielding/middleware/handle-invalid-query-string-values.ts

@@ -19,7 +19,7 @@ const STATSD_KEY = 'middleware.handle_invalid_querystring_values'
 // that the values of `?platform=...` should be none when the path is
 // something like `/en/search`.
 const RECOGNIZED_VALUES = {
-  platform: allPlatforms,
+  platform: allPlatforms as string[],
   tool: Object.keys(allTools),
 }
 // So we can look up if a key in the object is actually present

src/tools/lib/all-platforms.js

@@ -0,0 +1,9 @@
+/**
+ * All platforms available for the Platform Picker
+ */
+export type Platform = 'mac' | 'windows' | 'linux'
+
+/**
+ * Array of all supported platforms in the Platform Picker
+ */
+export const allPlatforms: Platform[] = ['mac', 'windows', 'linux']

src/tools/lib/all-platforms.ts

@@ -1,5 +1,14 @@
-// all the tools available for the Tool Picker
-export const allTools = {
+/**
+ * Interface defining the mapping between tool identifiers and their display names
+ */
+export interface ToolsMapping {
+  [key: string]: string
+}
+
+/**
+ * All the tools available for the Tool Picker
+ */
+export const allTools: ToolsMapping = {
   agents: 'Agents',
   api: 'API',
   azure_data_studio: 'Azure Data Studio',