feat: allow project path option

Author: tomardern

README.md

@@ -87,6 +87,7 @@ The CLI accepts a list of arguments:
 | `-s, --strict [boolean]`        | Run the check in strict mode.                                                          | false         |
 | `-d, --debug [boolean]`         | Show debug information.                                                                | false         |
 | `-c, --cache [boolean]`         | Save and reuse type check result from cache.                                           | false         |
+| `-p, --project [string]`        | File path to tsconfig file, eg: --project "./app/tsconfig.app.json"                    | .             |
 | `-i, --ignore-files [boolean]`  | Ignore specified files, eg: --ignore-files "demo1/\*.ts" --ignore-files "demo2/foo.ts" | false         |
 | `-u, --ignore-unread [boolean]` | Allow writes to variables with implicit any types                                      | false         |
 

package.json

@@ -28,6 +28,7 @@
     "type-coverage": "node ./dist/bin/typescript-coverage-report",
     "docs": "yarn type-coverage --outputDir docs",
     "prepublish": "yarn lint && yarn build",
+    "test": "jest",
     "release": "gren release"
   },
   "devDependencies": {

src/bin/typescript-coverage-report.ts

@@ -31,6 +31,7 @@ const {
   strict = false,
   debug = false,
   cache = false,
+  project = ".",
   ignoreFiles = false,
   ignoreCatch = false,
   ignoreUnread = false
@@ -57,6 +58,11 @@ program
     "save and reuse type check result from cache.",
     cache
   )
+  .option(
+    "-p, --project [string]",
+    'file path to tsconfig file, eg: --project "./app/tsconfig.app.json"',
+    project
+  )
   .option(
     "-i, --ignore-files [string[]]",
     'ignore specified files, eg: --ignore-files "demo1/*.ts" --ignore-files "demo2/foo.ts"',
@@ -78,6 +84,7 @@ const options = {
   /* camelCase keys matching "long" flags in options above */
   outputDir: program.outputDir,
   threshold: program.threshold,
+  tsProjectFile: program.project,
   strict: program.strict,
   debug: program.debug,
   cache: program.cache,

src/lib/__tests__/__snapshots__/getCoverage.test.ts.snap

@@ -1,5 +1,55 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`getCoverage function accepts a tsProjectFile option 1`] = `
+Object {
+  "anys": Array [],
+  "covered": 100,
+  "fileCounts": Map {
+    "index.html" => Object {
+      "correctCount": 100,
+      "totalCount": 100,
+    },
+  },
+  "percentage": 100,
+  "total": 100,
+  "uncovered": 0,
+}
+`;
+
+exports[`getCoverage function accepts a tsProjectFile option 2`] = `
+Array [
+  Array [
+    "./app/tsconfig.json",
+    Object {
+      "debug": undefined,
+      "enableCache": undefined,
+      "fileCounts": true,
+      "ignoreCatch": undefined,
+      "ignoreFiles": undefined,
+      "ignoreUnreadAnys": undefined,
+      "strict": undefined,
+    },
+  ],
+]
+`;
+
+exports[`getCoverage function defaults to root project when tsProjectFile is not passed 1`] = `
+Array [
+  Array [
+    ".",
+    Object {
+      "debug": undefined,
+      "enableCache": undefined,
+      "fileCounts": true,
+      "ignoreCatch": undefined,
+      "ignoreFiles": undefined,
+      "ignoreUnreadAnys": undefined,
+      "strict": undefined,
+    },
+  ],
+]
+`;
+
 exports[`getCoverage function returns calculated data from type-coverage-core 1`] = `
 Object {
   "anys": Array [],

src/lib/__tests__/getCoverage.test.ts

@@ -1,11 +1,39 @@
+import typeCoverageCore from "type-coverage-core";
 import getCoverage from "../getCoverage";
 
 describe("getCoverage function", () => {
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
   it("returns calculated data from type-coverage-core", async (done) => {
     const data = await getCoverage();
 
     expect(data).toMatchSnapshot();
 
     done();
   });
+
+  it("accepts a tsProjectFile option", async (done) => {
+    typeCoverageCore.lint = jest.fn().mockImplementation(typeCoverageCore.lint);
+
+    const data = await getCoverage({
+      tsProjectFile: "./app/tsconfig.json"
+    });
+
+    expect(data).toMatchSnapshot();
+    // @ts-expect-error
+    expect(typeCoverageCore.lint.mock.calls).toMatchSnapshot();
+    done();
+  });
+
+  it("defaults to root project when tsProjectFile is not passed", async (done) => {
+    typeCoverageCore.lint = jest.fn().mockImplementation(typeCoverageCore.lint);
+
+    await getCoverage();
+
+    // @ts-expect-error
+    expect(typeCoverageCore.lint.mock.calls).toMatchSnapshot();
+    done();
+  });
 });

src/lib/getCoverage.ts

@@ -20,14 +20,18 @@ export type CoverageData = {
 };
 
 export type Options = Partial<
-  Pick<LintOptions, "strict" | "debug" | "ignoreFiles" | "ignoreCatch"> & {
+  Pick<
+    LintOptions,
+    "strict" | "debug" | "ignoreFiles" | "ignoreCatch" | "tsProjectFile"
+  > & {
     cache: LintOptions["enableCache"];
     ignoreUnread: LintOptions["ignoreUnreadAnys"];
   }
 >;
 
 const getCoverage = async (options?: Options): Promise<CoverageData> => {
   const {
+    tsProjectFile = ".",
     strict,
     debug,
     ignoreFiles,
@@ -36,15 +40,18 @@ const getCoverage = async (options?: Options): Promise<CoverageData> => {
     ignoreUnread: ignoreUnreadAnys
   } = options || {};
 
-  const { anys, fileCounts, totalCount, correctCount } = await lint(".", {
-    strict,
-    debug,
-    ignoreFiles,
-    ignoreCatch,
-    enableCache,
-    ignoreUnreadAnys,
-    fileCounts: true
-  });
+  const { anys, fileCounts, totalCount, correctCount } = await lint(
+    tsProjectFile,
+    {
+      strict,
+      debug,
+      ignoreFiles,
+      ignoreCatch,
+      enableCache,
+      ignoreUnreadAnys,
+      fileCounts: true
+    }
+  );
   const percentage = totalCount === 0 ? 100 : (correctCount * 100) / totalCount;
 
   return {

src/lib/index.ts

@@ -22,6 +22,7 @@ export default async function generateCoverageReport(
   const dirPath = path.join(process.cwd(), options.outputDir);
 
   const data = await getCoverage({
+    tsProjectFile: options.tsProjectFile,
     strict: options.strict,
     debug: options.debug,
     ignoreFiles: options.ignoreFiles,