Add current coverage alongside diff to file information in table (#8)

* Added total to file coverage table

* Updated README with current table view

* Removed unused imports

* Prettier fixes

* Jest config test environment node


Co-authored-by: alexandru.sirbu <alexandru.sirbu@hootsuite.com>

Author: alexsirbu

README.md

@@ -2,13 +2,13 @@
 
 ## What it does
 
-* Accepts base-summary.json and head-summary.json
-* Diffs the two jsons and outputs info about
-  * Percentage of changed coverage (in changed/added files)
-  * Formatted as markdown table
-* Fail if coverage decreases on a file (check on percentage) for any of the lines/func/statements/branches. Can
+- Accepts base-summary.json and head-summary.json
+- Diffs the two jsons and outputs info about
+  - Percentage of changed coverage (in changed/added files)
+  - Formatted as markdown table
+- Fail if coverage decreases on a file (check on percentage) for any of the lines/func/statements/branches. Can
    be configured to only check some criteria.
-* Written in Typescript
+- Written in Typescript
 
 ## Usage
 
@@ -27,10 +27,10 @@ console.log(diff.regression);
 
 Out:
 
-| File   | LinesΔ(%) | FunctionsΔ(%) | Ok  |
-| ------ | --------- | ------------- | --- |
-| file_1 | 80.2      | 80.2          | ✅  |
-| file_2 | -2        | -2            | 🔴  |
+| Ok  | File  | Lines         | Branches      | Functions    | Statements    |
+| --- | ----- | ------------- | ------------- | ------------ | ------------- |
+| 🔴  | file1 | 80%<br>(+10%) | 14%<br>(-30%) | 3%<br>(+20%) | 20%<br>(-10%) |
+| ✅  | file2 | 20%<br>(+10%) | 8%<br>(-30%)  | 2%<br>(-20%) | 5%<br>(-10%)  |
 
 API at https://flaviusone.github.io/coverage-diff/globals.html#diff
 

jest.config.js

@@ -7,5 +7,6 @@ module.exports = {
     '^.+\\.(js|ts)$': 'ts-jest'
   },
   testMatch: ['**/?(*.)test.(js|ts)'],
+  testEnvironment: 'node',
   moduleFileExtensions: ['ts', 'js', 'json']
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "coverage-diff",
-  "version": "1.5.2",
+  "version": "1.6.0",
   "description": "Reports differences between two istanbul JSON code coverage summaries.",
   "main": "lib/index",
   "types": "lib/index",
@@ -31,14 +31,14 @@
   "devDependencies": {
     "@types/jest": "22.2.3",
     "@types/node": "9.6.2",
-    "eslint": "4.19.1",
+    "eslint": "6.7.2",
     "eslint-config-prettier": "2.9.0",
     "eslint-plugin-typescript": "0.11.0",
     "gh-pages": "1.1.0",
     "husky": "0.14.3",
     "jest": "22.4.3",
     "lint-staged": "7.0.4",
-    "prettier": "1.11.1",
+    "prettier": "1.19.1",
     "ts-jest": "22.4.3",
     "typedoc": "0.11.1",
     "typescript": "2.8.1",

src/__mocks__/diffChecker.ts

@@ -2,5 +2,5 @@ export const diffChecker = () => ({
   diff: 'mocked diff',
   regression: 'mockedRegression',
   files: 'mockedFiles',
-  totals: { deltas: 'mockedTotals' }
+  totals: { deltas: 'mockedTotals', pcts: 'mockedPcts' }
 });

src/__snapshots__/diffChecker.test.ts.snap

@@ -65,6 +65,12 @@ Object {
         "lines": -50,
         "statements": -50,
       },
+      "pcts": Object {
+        "branches": 50,
+        "functions": 50,
+        "lines": 50,
+        "statements": 50,
+      },
     },
   },
   "regression": false,
@@ -76,6 +82,12 @@ Object {
       "lines": -50,
       "statements": -50,
     },
+    "pcts": Object {
+      "branches": 50,
+      "functions": 50,
+      "lines": 50,
+      "statements": 50,
+    },
   },
 }
 `;
@@ -145,6 +157,12 @@ Object {
         "lines": -100,
         "statements": -100,
       },
+      "pcts": Object {
+        "branches": 0,
+        "functions": 0,
+        "lines": 0,
+        "statements": 0,
+      },
     },
   },
   "regression": true,
@@ -156,6 +174,12 @@ Object {
       "lines": -100,
       "statements": -100,
     },
+    "pcts": Object {
+      "branches": 0,
+      "functions": 0,
+      "lines": 0,
+      "statements": 0,
+    },
   },
 }
 `;
@@ -225,6 +249,12 @@ Object {
         "lines": 100,
         "statements": 100,
       },
+      "pcts": Object {
+        "branches": 100,
+        "functions": 100,
+        "lines": 100,
+        "statements": 100,
+      },
     },
   },
   "regression": false,
@@ -236,6 +266,12 @@ Object {
       "lines": 100,
       "statements": 100,
     },
+    "pcts": Object {
+      "branches": 100,
+      "functions": 100,
+      "lines": 100,
+      "statements": 100,
+    },
   },
 }
 `;
@@ -305,6 +341,12 @@ Object {
         "lines": 50,
         "statements": 0,
       },
+      "pcts": Object {
+        "branches": 50,
+        "functions": 50,
+        "lines": 100,
+        "statements": 50,
+      },
     },
   },
   "regression": false,
@@ -316,6 +358,12 @@ Object {
       "lines": 0,
       "statements": 0,
     },
+    "pcts": Object {
+      "branches": 0,
+      "functions": 0,
+      "lines": 0,
+      "statements": 0,
+    },
   },
 }
 `;
@@ -386,6 +434,12 @@ Object {
       "lines": 0,
       "statements": 0,
     },
+    "pcts": Object {
+      "branches": 0,
+      "functions": 0,
+      "lines": 0,
+      "statements": 0,
+    },
   },
 }
 `;

src/__snapshots__/resultFormatter.test.ts.snap

@@ -1,10 +1,10 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`resultFormatter should format files results as markdown table 1`] = `
-"| Ok  | File  | LinesΔ | BranchesΔ | FunctionsΔ | StatementsΔ |
-| --- | ----- | ------ | --------- | ---------- | ----------- |
-| 🔴  | file1 | +10%   | -30%      | +20%       | -10%        |
-| ✅   | file2 | +10%   | +30%      | +20%       | +10%        |
+"| Ok  | File  | Lines         | Branches      | Functions    | Statements    |
+| --- | ----- | ------------- | ------------- | ------------ | ------------- |
+| 🔴  | file1 | 80%<br>(+10%) | 14%<br>(-30%) | 3%<br>(+20%) | 20%<br>(-10%) |
+| ✅   | file2 | 20%<br>(+10%) | 8%<br>(+30%)  | 2%<br>(+20%) | 5%<br>(+10%)  |
 
 Total:
 

src/common.ts

@@ -49,15 +49,14 @@ export interface IFilesResults {
 }
 
 export interface IFileResultFormat {
-  deltas: {
-    lines: number;
-    functions: number;
-    statements: number;
-    branches: number;
-  };
+  deltas: IFileResultFields;
+  pcts: IFileResultFields;
   decreased: boolean;
 }
 
-export interface ITotalResultFormat extends IFileResultFormat {
-  totals: ICoverageSummary;
+export interface IFileResultFields {
+  lines: number;
+  functions: number;
+  statements: number;
+  branches: number;
 }

src/diffChecker.ts

@@ -56,6 +56,7 @@ export const diffChecker = (
         deltas: {
           ...diffPercentages
         },
+        pcts: getSummaryPercentages(head[k]),
         decreased
       });
     }
@@ -66,6 +67,7 @@ export const diffChecker = (
   if (!totals) {
     totals = {
       deltas: { lines: 0, functions: 0, statements: 0, branches: 0 },
+      pcts: { lines: 0, functions: 0, statements: 0, branches: 0 },
       decreased: false
     };
   }

src/helpers.test.ts

@@ -3,8 +3,10 @@ import { objectToMap, mapToObject } from './helpers';
 const myObject = {
   foo: 'bar'
 };
-
-const myMap = new Map([['foo', 'bar'], ['bar', 'foo']]);
+const myMap = new Map([
+  ['foo', 'bar'],
+  ['bar', 'foo']
+]);
 
 describe('helpers', () => {
   describe('objectToMap', () => {

src/index.test.ts

@@ -30,8 +30,8 @@ describe('diff', () => {
 
     it('should call the resultFormatter module', () => {
       expect(resultFormatterSpy).toHaveBeenCalledWith('mockedFiles', {
-        totals: fileFullCovered.total,
-        deltas: 'mockedTotals'
+        deltas: 'mockedTotals',
+        pcts: 'mockedPcts'
       });
     });