fix: expand tsconfig.json include lists

package.json

@@ -11,6 +11,7 @@
         "commander": "^8.0.0",
         "enquirer": "^2.3.6",
         "glob": "^7.1.7",
+        "minimatch": "^5.1.0",
         "mz": "^2.7.0",
         "strip-ansi": "^6.0.0",
         "tsutils": "^3.21.0",
@@ -25,6 +26,7 @@
         "@babel/preset-typescript": "7.14.5",
         "@types/glob": "7.1.3",
         "@types/jest": "26.0.23",
+        "@types/minimatch": "^3.0.5",
         "@types/mz": "2.7.3",
         "@types/node": "16.0.0",
         "@types/prop-types": "15.7.3",

src/index.ts

@@ -70,7 +70,7 @@ export const typeStat = async (argv: TypeStatArgv, output: ProcessOutput): Promi
         if (typeof fileNames !== "object") {
             return {
                 error: new Error(
-                    `Could not run options at index ${i + 1}: ${fileNames ?? `No files included by the 'include' setting were found.`}`,
+                    `Could not run options object ${i + 1}: ${fileNames ?? `No files included by the 'include' setting were found.`}`,
                 ),
                 status: ResultStatus.Failed,
             };

src/options/fillOutRawOptions.ts

@@ -1,9 +1,8 @@
-import * as ts from "typescript";
-
 import { TypeStatArgv } from "../index";
 import { ProcessOutput } from "../output/types";
 import { collectOptionals } from "../shared/arrays";
 import { ReactPropTypesHint, ReactPropTypesOptionality } from "./enums";
+import { ParsedCompilerOptions } from "./parseRawCompilerOptions";
 
 import { collectAddedMutators } from "./parsing/collectAddedMutators";
 import { collectFileOptions } from "./parsing/collectFileOptions";
@@ -15,7 +14,7 @@ import { PendingTypeStatOptions, RawTypeStatOptions } from "./types";
 
 export interface OptionsFromRawOptionsSettings {
     argv: TypeStatArgv;
-    compilerOptions: Readonly<ts.CompilerOptions>;
+    compilerOptions: Readonly<ParsedCompilerOptions>;
     cwd: string;
     output: ProcessOutput;
     projectPath: string;
@@ -71,7 +70,7 @@ export const fillOutRawOptions = ({
                 propTypesOptionality: rawOptions.hints?.react?.propTypesOptionality ?? ReactPropTypesOptionality.AsWritten,
             },
         },
-        include: rawOptions.include,
+        include: rawOptions.include ?? compilerOptions.include,
         mutators: collectAddedMutators(rawOptions, packageOptions.directory, output),
         output,
         package: packageOptions,

src/options/loadPendingOptions.ts

@@ -36,7 +36,7 @@ export const loadPendingOptions = async (argv: TypeStatArgv, output: ProcessOutp
     for (let i = 0; i < allRawOptions.length; i += 1) {
         const rawOptions = allRawOptions[i];
         const projectPath = getProjectPath(cwd, filePath, rawOptions);
-        const compilerOptions = await parseRawCompilerOptions(projectPath);
+        const compilerOptions = await parseRawCompilerOptions(cwd, projectPath);
 
         const filledOutOptions = fillOutRawOptions({ argv, compilerOptions, cwd, output, projectPath, rawOptions });
         const complaint = findComplaintForOptions(filledOutOptions);

src/options/parseRawCompilerOptions.ts

@@ -1,12 +1,44 @@
+import minimatch from "minimatch";
 import * as fs from "mz/fs";
+import * as path from "path";
 import * as ts from "typescript";
 
-export const parseRawCompilerOptions = async (projectPath: string): Promise<ts.CompilerOptions> => {
+export interface ParsedCompilerOptions extends ts.CompilerOptions {
+    include?: string[];
+}
+
+export const parseRawCompilerOptions = async (cwd: string, projectPath: string): Promise<ts.CompilerOptions> => {
     const configRaw = (await fs.readFile(projectPath)).toString();
     const compilerOptions = ts.parseConfigFileTextToJson(projectPath, configRaw);
     if (compilerOptions.error !== undefined) {
         throw new Error(`Could not parse compiler options from '${projectPath}': ${compilerOptions.error}`);
     }
 
-    return compilerOptions.config as ts.CompilerOptions;
+    const config = compilerOptions.config as ParsedCompilerOptions;
+
+    // TSConfig includes often come in a glob form like ["src"]
+    if (config.include) {
+        config.include = ts.parseJsonConfigFileContent(
+            compilerOptions.config,
+            {
+                useCaseSensitiveFileNames: true,
+                readDirectory: (rootDir, extensions, excludes, includes) =>
+                    includes
+                        .flatMap((include) =>
+                            fs.readdirSync(path.join(rootDir, include)).map((fileName) => path.join(rootDir, include, fileName)),
+                        )
+                        .filter(
+                            (filePath) =>
+                                !excludes?.some((exclude) => minimatch(filePath, exclude)) &&
+                                extensions.some((extension) => filePath.endsWith(extension)),
+                        )
+                        .map((filePath) => path.relative(rootDir, filePath)),
+                fileExists: (filePath) => fs.statSync(filePath).isFile(),
+                readFile: (filePath) => fs.readFileSync(filePath).toString(),
+            },
+            cwd,
+        ).fileNames;
+    }
+
+    return config;
 };

src/services/parseJsonConfigFileContent.ts

@@ -0,0 +1,28 @@
+import minimatch from "minimatch";
+import * as fs from "mz/fs";
+import * as path from "path";
+import * as ts from "typescript";
+
+export const parseJsonConfigFileContent = (config: unknown, cwd: string, existingOptions?: ts.CompilerOptions) => {
+    return ts.parseJsonConfigFileContent(
+        config,
+        {
+            useCaseSensitiveFileNames: true,
+            readDirectory: (rootDir, extensions, excludes, includes) =>
+                includes
+                    .flatMap((include) =>
+                        fs.readdirSync(path.join(rootDir, include)).map((fileName) => path.join(rootDir, include, fileName)),
+                    )
+                    .filter(
+                        (filePath) =>
+                            !excludes?.some((exclude) => minimatch(filePath, exclude)) &&
+                            extensions.some((extension) => filePath.endsWith(extension)),
+                    )
+                    .map((filePath) => path.relative(rootDir, filePath)),
+            fileExists: (filePath) => fs.statSync(filePath).isFile(),
+            readFile: (filePath) => fs.readFileSync(filePath).toString(),
+        },
+        cwd,
+        existingOptions,
+    );
+};

src/shared/glob.ts

@@ -14,6 +14,6 @@ export const globAsync = async (include: string, options: glob.IOptions = {}): P
 
 export const globAllAsync = async (includes: ReadonlyArray<string>, options: glob.IOptions = {}) =>
     (await Promise.all(includes.map(async (include: string) => globAsync(include, options)))).reduce(
-        (allResults: ReadonlyArray<string>, nextResults: ReadonlyArray<string>) => allResults.concat(nextResults),
+        (allResults: string[], nextResults: ReadonlyArray<string>) => allResults.concat(nextResults),
         [],
     );

test/cases/include/asterisk/expected.ts

@@ -0,0 +1,7 @@
+/* foo */ /* foo */ (function() {
+    console.log("Hello, world!");
+
+    function ignoreChanges(): string {
+        return undefined;
+    }
+})();

test/cases/include/asterisk/original.ts

@@ -0,0 +1,7 @@
+(function() {
+    console.log("Hello, world!");
+
+    function ignoreChanges(): string {
+        return undefined;
+    }
+})();

test/cases/include/asterisk/sampleMutator.js

@@ -0,0 +1,15 @@
+const prefix = "/* foo */ ";
+
+module.exports.fileMutator = (request) => {
+    return request.sourceFile.getText().indexOf(prefix) === -1
+        ? [
+              {
+                  insertion: prefix,
+                  range: {
+                      begin: 0,
+                  },
+                  type: "text-insert",
+              },
+          ]
+        : [];
+};

test/cases/include/asterisk/tsconfig.json

@@ -0,0 +1,3 @@
+{
+    "include": ["*"]
+}

test/cases/include/asterisk/typestat.json

@@ -0,0 +1,3 @@
+{
+    "mutators": ["./sampleMutator.js"]
+}

test/cases/include/directory/expected.ts

@@ -0,0 +1,7 @@
+/* foo */ /* foo */ (function() {
+    console.log("Hello, world!");
+
+    function ignoreChanges(): string {
+        return undefined;
+    }
+})();

test/cases/include/directory/original.ts

@@ -0,0 +1,7 @@
+(function() {
+    console.log("Hello, world!");
+
+    function ignoreChanges(): string {
+        return undefined;
+    }
+})();

test/cases/include/directory/sampleMutator.js

@@ -0,0 +1,15 @@
+const prefix = "/* foo */ ";
+
+module.exports.fileMutator = (request) => {
+    return request.sourceFile.getText().indexOf(prefix) === -1
+        ? [
+              {
+                  insertion: prefix,
+                  range: {
+                      begin: 0,
+                  },
+                  type: "text-insert",
+              },
+          ]
+        : [];
+};

test/cases/include/directory/tsconfig.json

@@ -0,0 +1,3 @@
+{
+    "include": ["."]
+}

test/cases/include/directory/typestat.json

@@ -0,0 +1,3 @@
+{
+    "mutators": ["./sampleMutator.js"]
+}

tsconfig.json

@@ -1,7 +1,7 @@
 {
     "compilerOptions": {
         "esModuleInterop": true,
-        "lib": ["es2015"],
+        "lib": ["es2020"],
         "module": "commonjs",
         "moduleResolution": "node",
         "noFallthroughCasesInSwitch": true,
@@ -14,7 +14,7 @@
         "resolveJsonModule": true,
         "sourceMap": true,
         "strict": true,
-        "target": "es2015"
+        "target": "es2020"
     },
     "exclude": ["test/**/*.ts"],
     "include": ["src/**/*.ts"]