fix(ARCH-373): typescript rule checks should include base config

src/checks/requiredTypeScript.test.ts

@@ -14,13 +14,16 @@ import requiredTypeScript, {
   measureTsAdoption,
   missingTsConfigSettings,
 } from './requiredTypeScript'
+import { getTypescriptConfigOptions } from './utils'
 
 const mockGithub = mocked(github, true)
 const mockGlob = mocked(glob, true)
 const mockReadFile = mocked(readFile, true)
+const mockGetTypescriptConfigOptions = mocked(getTypescriptConfigOptions, true)
 
 jest.mock('../infrastructure/github')
 jest.mock('../infrastructure/fs')
+jest.mock('./utils')
 
 describe('Required TypeScript check', () => {
   describe('pull_request event', () => {
@@ -68,14 +71,12 @@ describe('Required TypeScript check', () => {
         { filename: 'workflows/test.yaml' },
       ] as PullRequestFiles)
       mockGlob.mockResolvedValue(['tsconfig.json'])
-      mockReadFile.mockReturnValue(
-        JSON.stringify({
-          compilerOptions: {
-            allowUnreachableCode: false,
-            noImplicitAny: true,
-          },
-        })
-      )
+      mockGetTypescriptConfigOptions.mockReturnValue({
+        compilerOptions: {
+          allowUnreachableCode: false,
+          noImplicitAny: true,
+        },
+      })
 
       await expect(requiredTypeScript.run()).resolves.toBeTruthy()
     })
@@ -86,14 +87,12 @@ describe('Required TypeScript check', () => {
         { filename: 'filename.js', additions: 100, deletions: 20 },
       ] as PullRequestFiles)
       mockGlob.mockResolvedValue(['tsconfig.json'])
-      mockReadFile.mockReturnValue(
-        JSON.stringify({
-          compilerOptions: {
-            allowUnreachableCode: false,
-            noImplicitAny: true,
-          },
-        })
-      )
+      mockGetTypescriptConfigOptions.mockReturnValue({
+        compilerOptions: {
+          allowUnreachableCode: false,
+          noImplicitAny: true,
+        },
+      })
 
       await expect(requiredTypeScript.run()).rejects.toThrow()
     })
@@ -122,14 +121,12 @@ describe('Required TypeScript check', () => {
         { filename: 'filename.js', additions: 100, deletions: 100 },
       ] as PullRequestFiles)
       mockGlob.mockResolvedValue(['tsconfig.json'])
-      mockReadFile.mockReturnValue(
-        JSON.stringify({
-          compilerOptions: {
-            allowUnreachableCode: false,
-            noImplicitAny: true,
-          },
-        })
-      )
+      mockGetTypescriptConfigOptions.mockReturnValue({
+        compilerOptions: {
+          allowUnreachableCode: false,
+          noImplicitAny: true,
+        },
+      })
 
       await expect(requiredTypeScript.run()).resolves.toBeTruthy()
     })
@@ -140,13 +137,11 @@ describe('Required TypeScript check', () => {
         { filename: 'filename.ts' },
       ] as PullRequestFiles)
       mockGlob.mockResolvedValue(['tsconfig.json'])
-      mockReadFile.mockReturnValue(
-        JSON.stringify({
-          compilerOptions: {
-            noImplicitAny: false,
-          },
-        })
-      )
+      mockGetTypescriptConfigOptions.mockReturnValue({
+        compilerOptions: {
+          noImplicitAny: false,
+        },
+      })
 
       await expect(requiredTypeScript.run()).rejects.toThrow()
     })
@@ -157,13 +152,11 @@ describe('Required TypeScript check', () => {
         { filename: 'filename.js', additions: 100, deletions: 20 },
       ] as PullRequestFiles)
       mockGlob.mockResolvedValue(['tsconfig.json'])
-      mockReadFile.mockReturnValue(
-        JSON.stringify({
-          compilerOptions: {
-            noImplicitAny: false,
-          },
-        })
-      )
+      mockGetTypescriptConfigOptions.mockReturnValue({
+        compilerOptions: {
+          noImplicitAny: false,
+        },
+      })
 
       await expect(requiredTypeScript.run()).rejects.toThrow()
     })
@@ -189,15 +182,16 @@ describe('Required TypeScript check', () => {
         }
         return []
       })
+
+      mockGetTypescriptConfigOptions.mockReturnValue({
+        compilerOptions: {
+          allowUnreachableCode: false,
+          noImplicitAny: true,
+        },
+      })
+
       mockReadFile.mockImplementation((path) => {
         switch (path) {
-          case 'tsconfig.json':
-            return JSON.stringify({
-              compilerOptions: {
-                allowUnreachableCode: false,
-                noImplicitAny: true,
-              },
-            })
           case 'file.js':
             return 'this\nis a\njs\nfile'
           case 'file.ts':
@@ -230,12 +224,12 @@ describe('Required TypeScript check', () => {
         }
         return []
       })
+      mockGetTypescriptConfigOptions.mockReturnValue({
+        compilerOptions: {},
+      })
+
       mockReadFile.mockImplementation((path) => {
         switch (path) {
-          case 'tsconfig.json':
-            return JSON.stringify({
-              compilerOptions: {},
-            })
           case 'file.js':
             return 'this\nis a\njs\nfile'
           case 'file.ts':
@@ -298,15 +292,15 @@ describe('Required TypeScript check', () => {
         }
         return []
       })
+      mockGetTypescriptConfigOptions.mockReturnValue({
+        compilerOptions: {
+          allowUnreachableCode: false,
+          noImplicitAny: true,
+        },
+      })
+
       mockReadFile.mockImplementation((path) => {
         switch (path) {
-          case 'tsconfig.json':
-            return JSON.stringify({
-              compilerOptions: {
-                allowUnreachableCode: false,
-                noImplicitAny: true,
-              },
-            })
           case 'file.js':
             return 'this\nis a\njs\nfile'
           case 'file.ts':

src/checks/requiredTypeScript.ts

@@ -1,16 +1,15 @@
 import * as core from '@actions/core'
-import * as CommentedJSON from 'comment-json'
-
 import { WebhookEventMap } from '@octokit/webhooks-types'
+import ignore, { Ignore as IgnoredFileFilter } from 'ignore'
 
 import { github } from '../infrastructure/github'
 import * as fs from '../infrastructure/fs'
 import { isBot } from '../conditions/triggeredByBot'
 
 import Check from './check'
-import ignore, { Ignore as IgnoredFileFilter } from 'ignore'
+import { getTypescriptConfigOptions } from './utils'
 
-type TsConfig = {
+export type TsConfig = {
   compilerOptions?: {
     allowUnreachableCode?: boolean
     noImplicitAny?: boolean
@@ -159,23 +158,22 @@ export async function measureTsAdoption(
   return tsLines / (jsLines + tsLines)
 }
 
-async function checkTsConfig(files: string[]): Promise<Error[]> {
+export async function checkTsConfig(files: string[]): Promise<Error[]> {
   const errors: Error[] = []
 
   for (const filename of files) {
-    const content = fs.readFile(filename)
+    const content = getTypescriptConfigOptions(filename)
+
     let missingSettings: string[] = []
 
     if (!content) continue
 
     try {
-      const parsed = CommentedJSON.parse(content)
-
-      if (!parsed || typeof parsed !== 'object' || Array.isArray(parsed)) {
+      if (typeof content !== 'object' || Array.isArray(content)) {
         throw new Error('expected an object')
       }
 
-      missingSettings = missingTsConfigSettings(parsed as TsConfig)
+      missingSettings = missingTsConfigSettings(content)
     } catch (e) {
       errors.push({ file: filename, message: `Not valid JSON: "${e}"` })
       continue

src/checks/utils.test.ts

@@ -0,0 +1,19 @@
+import path from 'path'
+
+import { getTypescriptConfigOptions } from './utils'
+describe('Checks on Typescript config', () => {
+  it('include base config ', () => {
+    const tsconfig = path.resolve(
+      `${__dirname}/../../test/fixtures/tsconfig.extended.json`
+    )
+
+    const tsconfigParsed = getTypescriptConfigOptions(tsconfig)
+
+    expect(tsconfigParsed.compilerOptions).toEqual(
+      expect.objectContaining({
+        allowJs: true,
+        allowUnreachableCode: false,
+      })
+    )
+  })
+})

src/checks/utils.ts

@@ -0,0 +1,9 @@
+import { getParsedCommandLineOfConfigFile, sys } from 'typescript'
+
+import { TsConfig } from './requiredTypeScript'
+
+export function getTypescriptConfigOptions(filename: string): TsConfig {
+  //@ts-expect-error Argument of type 'System' is not assignable to parameter of type 'ParseConfigFileHost'.
+  const options = getParsedCommandLineOfConfigFile(filename, {}, sys)
+  return { compilerOptions: options?.options }
+}

test/fixtures/tsconfig.base.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "module": "commonjs",
+    "allowJs": true,
+    "skipLibCheck": true,
+    "noImplicitAny": true,
+    "allowUnreachableCode": false
+  }
+}

test/fixtures/tsconfig.extended.json

@@ -0,0 +1,3 @@
+{
+  "extends": "./tsconfig.base.json"
+}