Feat: useAbsolutePath for lcov reports

.prettierrc.js

@@ -0,0 +1,9 @@
+module.exports = {
+    arrowParens: 'avoid',
+    bracketSameLine: true,
+    bracketSpacing: true,
+    singleQuote: true,
+    trailingComma: 'none',
+    tabWidth: 4,
+    printWidth: 100
+};

README.md

@@ -53,6 +53,9 @@ schedule(istanbulCoverage({
   // What to do when the PR doesn't meet the minimum code coverage threshold
   reportMode: "message", // || "warn" || "fail"
 
+  // Required for lcov reports which uses relative path.
+  useAbsolutePath: true, // || false
+
   // Minimum coverage threshold percentages. Compared against the cumulative coverage of the reportFileSet.
   threshold: {
     statements: 100,
@@ -69,7 +72,7 @@ This plugin requires the 'json-summary' or 'lcov' report modes be enabled with I
 
 ### What test runners does this work with?
 
-Anything that integrates with [Istanbul](https://www.npmjs.com/package/istanbul), or produces output in the (lcov)[https://linux.die.net/man/1/lcov] format. Istanbul is test runner agnostic, and can be integrated with anything written in node. Some test runners already integrate Istanbul, for instance [Jest](https://jestjs.io/docs/en/cli.html#coverage)  bundles it internally. Helper integrations exists for [Jasmine](https://www.npmjs.com/package/jasmine-istanbul-reporter) and other libraries.
+Anything that integrates with [Istanbul](https://www.npmjs.com/package/istanbul), or produces output in the (lcov)[https://linux.die.net/man/1/lcov] format. Istanbul is test runner agnostic, and can be integrated with anything written in node. Some test runners already integrate Istanbul, for instance [Jest](https://jestjs.io/docs/en/cli.html#coverage) bundles it internally. Helper integrations exists for [Jasmine](https://www.npmjs.com/package/jasmine-istanbul-reporter) and other libraries.
 
 ### Why should my team see code coverage stats in their PRs?
 

src/config.model.test.ts

@@ -1,39 +1,40 @@
-import { makeCompleteConfiguration } from "./config.model"
+import { makeCompleteConfiguration } from './config.model';
 
-describe("makeCompleteConfiguration", () => {
-  const base = {
-    coveragePaths: ["./coverage/coverage-summary.json"],
-    reportFileSet: "all",
-    reportMode: "message",
-    entrySortMethod: "alphabetically",
-    numberOfEntries: 10,
-    threshold: {
-      statements: 100,
-      branches: 100,
-      functions: 100,
-      lines: 100,
-    },
-  }
+describe('makeCompleteConfiguration', () => {
+    const base = {
+        coveragePaths: ['./coverage/coverage-summary.json'],
+        reportFileSet: 'all',
+        reportMode: 'message',
+        entrySortMethod: 'alphabetically',
+        numberOfEntries: 10,
+        useAbsolutePath: true,
+        threshold: {
+            statements: 100,
+            branches: 100,
+            functions: 100,
+            lines: 100
+        }
+    };
 
-  it("returns a default configuration when sent undefined", () => {
-    const output = makeCompleteConfiguration()
-    expect(output).toEqual(base)
-  })
+    it('returns a default configuration when sent undefined', () => {
+        const output = makeCompleteConfiguration();
+        expect(output).toEqual(base);
+    });
 
-  it("overrides coveragePaths with the value from coveragePath", () => {
-    const output = makeCompleteConfiguration({
-      coveragePath: "some-other-path",
-    })
-    expect(output).toEqual({ ...base, coveragePaths: ["some-other-path"] })
-  })
+    it('overrides coveragePaths with the value from coveragePath', () => {
+        const output = makeCompleteConfiguration({
+            coveragePath: 'some-other-path'
+        });
+        expect(output).toEqual({ ...base, coveragePaths: ['some-other-path'] });
+    });
 
-  it("overrides a specific value from the default", () => {
-    const output = makeCompleteConfiguration({
-      reportMode: "warn",
-    })
-    expect(output).toEqual({
-      ...base,
-      reportMode: "warn",
-    })
-  })
-})
+    it('overrides a specific value from the default', () => {
+        const output = makeCompleteConfiguration({
+            reportMode: 'warn'
+        });
+        expect(output).toEqual({
+            ...base,
+            reportMode: 'warn'
+        });
+    });
+});

src/config.model.ts

@@ -1,37 +1,38 @@
-export type ReportFileSet = "created" | "modified" | "createdOrModified" | "all"
-export type ReportMode = "fail" | "warn" | "message"
+export type ReportFileSet = 'created' | 'modified' | 'createdOrModified' | 'all';
+export type ReportMode = 'fail' | 'warn' | 'message';
 export type SortMethod =
-  | "alphabetically"
-  | "least-coverage"
-  | "most-coverage"
-  | "largest-file-size"
-  | "smallest-file-size"
-  | "uncovered-lines"
+    | 'alphabetically'
+    | 'least-coverage'
+    | 'most-coverage'
+    | 'largest-file-size'
+    | 'smallest-file-size'
+    | 'uncovered-lines';
 
-export type SourceType = "json-summary" | "lcov"
+export type SourceType = 'json-summary' | 'lcov';
 export interface SourcePathExplicit {
-  path: string
-  type: SourceType
+    path: string;
+    type: SourceType;
 }
-export type SourcePath = string | SourcePathExplicit
+export type SourcePath = string | SourcePathExplicit;
 
 export interface CoverageThreshold {
-  statements: number
-  branches: number
-  functions: number
-  lines: number
+    statements: number;
+    branches: number;
+    functions: number;
+    lines: number;
 }
 
 export interface Config {
-  customSuccessMessage?: string
-  customFailureMessage?: string
-  numberOfEntries: number
-  entrySortMethod: SortMethod
-  coveragePath?: SourcePath
-  coveragePaths: SourcePath[]
-  reportFileSet: ReportFileSet
-  threshold: CoverageThreshold
-  reportMode: ReportMode
+    customSuccessMessage?: string;
+    customFailureMessage?: string;
+    numberOfEntries: number;
+    useAbsolutePath: boolean;
+    entrySortMethod: SortMethod;
+    coveragePath?: SourcePath;
+    coveragePaths: SourcePath[];
+    reportFileSet: ReportFileSet;
+    threshold: CoverageThreshold;
+    reportMode: ReportMode;
 }
 
 /**
@@ -40,23 +41,27 @@ export interface Config {
  * @returns A complete configuration
  */
 export function makeCompleteConfiguration(config?: Partial<Config>): Config {
-  const defaults: Config = {
-    coveragePaths: [],
-    reportFileSet: "all",
-    reportMode: "message",
-    entrySortMethod: "alphabetically",
-    numberOfEntries: 10,
-    threshold: {
-      statements: 100,
-      branches: 100,
-      functions: 100,
-      lines: 100,
-    },
-  }
+    const defaults: Config = {
+        coveragePaths: [],
+        reportFileSet: 'all',
+        reportMode: 'message',
+        entrySortMethod: 'alphabetically',
+        numberOfEntries: 10,
+        useAbsolutePath: true,
+        threshold: {
+            statements: 100,
+            branches: 100,
+            functions: 100,
+            lines: 100
+        }
+    };
 
-  const combined = config ? { ...defaults, ...config } : defaults
-  const coveragePath = combined.coveragePath ? combined.coveragePath : "./coverage/coverage-summary.json"
-  const coveragePaths = combined.coveragePaths.length === 0 ? [coveragePath] : combined.coveragePaths
-  delete combined.coveragePath
-  return { ...combined, coveragePaths }
+    const combined = config ? { ...defaults, ...config } : defaults;
+    const coveragePath = combined.coveragePath
+        ? combined.coveragePath
+        : './coverage/coverage-summary.json';
+    const coveragePaths =
+        combined.coveragePaths.length === 0 ? [coveragePath] : combined.coveragePaths;
+    delete combined.coveragePath;
+    return { ...combined, coveragePaths };
 }