Convert allowed-topics.js to TypeScript (#58011)

Co-authored-by: Copilot <[email protected]>

Author: heiskr

content/README.md

@@ -288,7 +288,7 @@ journeyTracks:
 - Optional.
 
 ### `topics`
-- Purpose: Indicate the topics covered by the article. Refer to the content models for more details about adding topics. A full list of existing topics is located in the [allowed topics file](/data/allowed-topics.js). If topics in article frontmatter and the allow-topics list become out of sync, the [topics CI test](/src/search/tests/topics.js) will fail.
+- Purpose: Indicate the topics covered by the article. Refer to the content models for more details about adding topics. A full list of existing topics is located in the [allowed topics file](/data/allowed-topics.ts). If topics in article frontmatter and the allow-topics list become out of sync, the [topics CI test](/src/search/tests/topics.ts) will fail.
 - Type: Array of `String`s
 - Optional: Topics are preferred for each article, but, there may be cases where existing articles don't yet have topics, or adding a topic to a new article may not add value.
 

content/contributing/style-guide-and-content-model/about-topics.md

@@ -20,7 +20,7 @@ topics:
 ---
 ```
 
-For more information on adding topics to an article see, [AUTOTITLE](/contributing/writing-for-github-docs/using-yaml-frontmatter#topics). For a list of all allowed topics, see [`allowed-topics`](https://github.com/github/docs/blob/main/data/allowed-topics.js).
+For more information on adding topics to an article see, [AUTOTITLE](/contributing/writing-for-github-docs/using-yaml-frontmatter#topics). For a list of all allowed topics, see [`allowed-topics`](https://github.com/github/docs/blob/main/data/allowed-topics.ts).
 
 ## Topics for all content types
 

content/contributing/writing-for-github-docs/templates.md

@@ -73,7 +73,7 @@ intro: 'Article intro. See tips for a great intro below.'
 product: "{{ optional product callout }}"
 type: reference
 topics:
-  - <topic> # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.js
+  - <topic> # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.ts
 versions:
   - <version>
 ---
@@ -125,7 +125,7 @@ intro: 'Article intro. See tips for a great intro below.'
 product: "{{ optional product callout }}"
 type: how_to
 topics:
-  - <topic> # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.js
+  - <topic> # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.ts
 versions:
   - <version>
 ---
@@ -176,7 +176,7 @@ shortTitle: <subject> # Max 31 characters
 intro: 'Article intro. Highlight that the guide is quick and to the point.'
 type: quick_start
 topics:
-  - <topic> # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.js
+  - <topic> # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.ts
 versions:
   - <version>
 ---
@@ -245,7 +245,7 @@ intro: 'Article intro. See tips for a great intro below'
 product: "{{ optional product callout }}"
 type: tutorial
 topics:
-  - <topic> # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.js
+  - <topic> # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.ts
 versions:
   - <version>
 ---
@@ -320,7 +320,7 @@ intro: 'Article intro. See tips for a great intro below'
 product: "{{ optional product callout }}"
 type: tutorial
 topics:
-  - <topic> # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.js
+  - <topic> # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.ts
 versions:
   - <version>
 ---

content/contributing/writing-for-github-docs/using-yaml-frontmatter.md

@@ -288,7 +288,7 @@ journeyTracks:
 
 ### `topics`
 
-* Purpose: Indicate the topics covered by the article. Refer to the content models for more details about adding topics. A full list of existing topics is located in the [allowed topics file](https://github.com/github/docs/blob/main/data/allowed-topics.js). If topics in article frontmatter and the allow-topics list become out of sync, the [topics CI test](https://github.com/github/docs/blob/main/src/search/tests/topics.ts) will fail.
+* Purpose: Indicate the topics covered by the article. Refer to the content models for more details about adding topics. A full list of existing topics is located in the [allowed topics file](https://github.com/github/docs/blob/main/data/allowed-topics.ts). If topics in article frontmatter and the allow-topics list become out of sync, the [topics CI test](https://github.com/github/docs/blob/main/src/search/tests/topics.ts) will fail.
 * Type: Array of `String`s
 * Optional: Topics are preferred for each article, but, there may be cases where existing articles don't yet have topics, or adding a topic to a new article may not add value.
 

data/allowed-topics.js data/allowed-topics.tsdata/allowed-topics.js renamed to data/allowed-topics.ts

@@ -10,7 +10,7 @@
 // content model, add the entry to this list, and ensure you loop in the
 // content and/or content strategy team for review.
 
-export default [
+const allowedTopics = [
   '2FA',
   'Access management',
   'Accounts',
@@ -170,4 +170,6 @@ export default [
   'Xamarin.iOS',
   'Xamarin',
   'Xcode',
-]
+] as const
+
+export default allowedTopics

src/search/tests/topics.ts

@@ -28,7 +28,7 @@ const topics: string[] = walk(contentDir, { includeBasePath: true })
 const allUsedTopics: string[] = Array.from(new Set(topics)).sort()
 
 describe('Check for allowed frontmatter topics', () => {
-  test('all used topics are allowed in /data/allowed-topics.js', () => {
+  test('all used topics are allowed in /data/allowed-topics.ts', () => {
     expect(allUsedTopics.length).toBeGreaterThan(0)
 
     const unusedTopics: string[] = difference(allUsedTopics, allowedTopics)