@codechecks/type-coverage-watcher/lib/__tests__/index.spec.js

Track missing type coverage in TypeScript projects to ensure type safety

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const index_1 = require("../index");
const client_1 = require("@codechecks/client");
describe("type-coverage", () => {
    const codechecksMock = require("../__mocks__/@codechecks/client").codechecks;
    const typeCoverageMock = require("../__mocks__/type-coverage-core").lint;
    beforeEach(() => jest.resetAllMocks());
    it("should work not in PR context", async () => {
        codechecksMock.isPr.mockReturnValue(false);
        typeCoverageMock.mockReturnValue({
            correctCount: 2,
            totalCount: 2,
            anys: [],
            program: undefined,
        });
        await index_1.typeCoverageWatcher({ tsconfigPath: "./tsconfig.json" });
        expect(client_1.codechecks.report).toBeCalledTimes(0);
        expect(client_1.codechecks.saveValue).toMatchInlineSnapshot(`
[MockFunction] {
  "calls": Array [
    Array [
      "type-coverage:Type Coverage",
      Object {
        "allUntypedSymbols": Array [],
        "totalSymbols": 2,
        "typedSymbols": 2,
      },
    ],
  ],
  "results": Array [
    Object {
      "isThrow": false,
      "value": undefined,
    },
  ],
}
`);
    });
    it("should work in PR context", async () => {
        codechecksMock.isPr.mockReturnValue(true);
        codechecksMock.getValue.mockReturnValue({
            typedSymbols: 2,
            totalSymbols: 4,
            allUntypedSymbols: [
                { filename: "index.ts", character: 1, line: 10, symbol: "app" },
                { filename: "index.ts", character: 1, line: 15, symbol: "res" },
                { filename: "index.ts", character: 2, line: 15, symbol: "key" },
            ],
        });
        typeCoverageMock.mockReturnValue({
            correctCount: 3,
            totalCount: 4,
            anys: [
                { file: "index.ts", character: 1, line: 15, text: "res" },
                { file: "index.ts", character: 3, line: 16, text: "key" },
            ],
            program: undefined,
        });
        await index_1.typeCoverageWatcher({ tsconfigPath: "./tsconfig.json" });
        expect(client_1.codechecks.report).toMatchInlineSnapshot(`
[MockFunction] {
  "calls": Array [
    Array [
      Object {
        "longDescription": "New untyped symbols: 0",
        "name": "Type Coverage",
        "shortDescription": "Change: +25.00% Total: 75.00% New untyped symbols: 0",
        "status": "success",
      },
    ],
  ],
  "results": Array [
    Object {
      "isThrow": false,
      "value": undefined,
    },
  ],
}
`);
    });
    it("should work in PR context 2", async () => {
        codechecksMock.isPr.mockReturnValue(true);
        codechecksMock.getValue.mockReturnValue({
            typedSymbols: 4,
            totalSymbols: 5,
            allUntypedSymbols: [],
        });
        typeCoverageMock.mockReturnValue({
            correctCount: 3,
            totalCount: 4,
            anys: [{ file: "index.ts", character: 1, line: 15, text: "res" }],
            program: undefined,
        });
        await index_1.typeCoverageWatcher({ tsconfigPath: "./tsconfig.json" });
        expect(client_1.codechecks.report).toMatchInlineSnapshot(`
[MockFunction] {
  "calls": Array [
    Array [
      Object {
        "longDescription": "New untyped symbols: 1

| File | line:character | Symbol |
|:-----:|:-----:|:-----:|
| index.ts | 15:1 | res |",
        "name": "Type Coverage",
        "shortDescription": "Change: -5.00% Total: 75.00% New untyped symbols: 1",
        "status": "success",
      },
    ],
  ],
  "results": Array [
    Object {
      "isThrow": false,
      "value": undefined,
    },
  ],
}
`);
    });
    it("should work in PR context without baseline", async () => {
        codechecksMock.isPr.mockReturnValue(true);
        typeCoverageMock.mockReturnValue({
            correctCount: 2,
            totalCount: 2,
            anys: [],
            program: undefined,
        });
        await index_1.typeCoverageWatcher({ tsconfigPath: "./tsconfig.json" });
        expect(client_1.codechecks.report).toMatchInlineSnapshot(`
[MockFunction] {
  "calls": Array [
    Array [
      Object {
        "longDescription": "New untyped symbols: 0",
        "name": "Type Coverage",
        "shortDescription": "Change: +100.00% Total: 100.00% New untyped symbols: 0",
        "status": "success",
      },
    ],
  ],
  "results": Array [
    Object {
      "isThrow": false,
      "value": undefined,
    },
  ],
}
`);
    });
    it("should handle atLeast option", async () => {
        codechecksMock.isPr.mockReturnValue(true);
        typeCoverageMock.mockReturnValue({
            correctCount: 4,
            totalCount: 10,
            anys: [],
            program: undefined,
        });
        await index_1.typeCoverageWatcher({ tsconfigPath: "./tsconfig.json", atLeast: 50 });
        expect(client_1.codechecks.report).toMatchInlineSnapshot(`
[MockFunction] {
  "calls": Array [
    Array [
      Object {
        "longDescription": "New untyped symbols: 0",
        "name": "Type Coverage",
        "shortDescription": "Change: +40.00% Total: 40.00% (min. 50.00%) New untyped symbols: 0",
        "status": "failure",
      },
    ],
  ],
  "results": Array [
    Object {
      "isThrow": false,
      "value": undefined,
    },
  ],
}
`);
    });
});
//# sourceMappingURL=index.spec.js.map