Merge pull request #8 from ShellyDCMS/add-jest-coverage

add jest coverage

.github/workflows/npm-publish.yml

@@ -23,6 +23,8 @@ jobs:
       - run: npm run build
       - run: npm run test
       - run: npm run cy:run
+      - name: Update Coverage Badge
+        uses: we-cli/coverage-badge-action@main
       - name: Build the Docs
         run: |
           npm run generate-md-docs          

README.md

@@ -1,6 +1,7 @@
 # ts-stubber
 
 ![ts-stubber](https://github.com/ShellyDCMS/ts-stubber/actions/workflows/npm-publish.yml/badge.svg)
+[![cov](https://ShellyDCMS.github.io/ts-stubber/badges/coverage.svg)](https://github.com/ShellyDCMS/ts-stubber/actions)
 
 A generic stubbed instance creator to lazy stub any interface/class, while completely avoiding calling class's constructor.
 Thus, enabling both avoiding side effects that may occur while class constructor is activated and mocking Classes with no default constructor.

jest.config.ts

@@ -1,7 +1,12 @@
 import type { JestConfigWithTsJest } from "ts-jest";
 
 const jestConfig: JestConfigWithTsJest = {
-  // [...]
+  coverageReporters: [
+    "clover",
+    "json-summary",
+    "lcov",
+    ["text", { skipFull: false }]
+  ],
   transform: {
     // '^.+\\.[tj]sx?$' to process js/ts with `ts-jest`
     // '^.+\\.m?[tj]sx?$' to process js/ts/mjs/mts with `ts-jest`

package.json

@@ -27,7 +27,7 @@
     "build": "rollup --configPlugin @rollup/plugin-typescript --config rollup.config.ts ",
     "cy:run": "cypress run",
     "cy:open": "cypress open",
-    "test": "jest",
+    "test": "jest --coverage",
     "generate-md-docs": "typedoc --includeVersion --plugin typedoc-plugin-markdown --plugin typedoc-plugin-merge-modules --options typedoc.md.json",
     "generate-docs": "typedoc --includeVersion --plugin typedoc-plugin-merge-modules --options typedoc.html.json",
     "deploy": "gh-pages -d docs"

src/stub-builder.cy.ts

@@ -290,6 +290,7 @@ describe("Cypress stub builder tests with Sinon Stubs", () => {
     });
 
     it("should stub class function", () => {
+      // creating a stubbed instance using sinon
       const mockMyClass = StubbedInstanceCreator<MyClass, SinonStub>(() =>
         sinon.stub()
       ).createStubbedInstance();

src/stub-builder.test.ts

@@ -291,6 +291,7 @@ describe("Jest stub builder tests with Jest Mocks", () => {
     });
 
     it("should have own property given property is set", () => {
+      // creating a stubbed instance using jest
       const mockMyClass = StubbedInstanceCreator<MyClass, jest.Mock>(() =>
         jest.fn()
       ).createStubbedInstance();