chore(plugin-coverage): make coverageTypes optional, improve branch issues, score precision

Author: Tlacenka

code-pushup.config.ts

@@ -46,7 +46,6 @@ const config: CoreConfig = {
   plugins: [
     await eslintPlugin(await eslintConfigFromNxProjects()),
     coveragePlugin({
-      coverageType: ['branch', 'function', 'line'],
       reports: [
         {
           resultsPath: 'coverage/cli/unit-tests/lcov.info',

e2e/cli-e2e/mocks/fixtures/code-pushup.config.coverage.ts

@@ -37,7 +37,7 @@ export default {
   ],
   plugins: [
     coveragePlugin({
-      coverageType: ['branch', 'function', 'line'],
+      coverageTypes: ['branch', 'function', 'line'],
       reports: [
         {
           resultsPath: join('e2e', 'cli-e2e', 'mocks', 'fixtures', 'lcov.info'),

e2e/cli-e2e/tests/__snapshots__/collect.e2e.test.ts.snap

@@ -33,11 +33,11 @@ exports[`CLI collect > should run Code coverage plugin and create report.json 1`
     {
       "audits": [
         {
-          "description": "branch coverage percentage on the project",
+          "description": "Branch coverage percentage on the project.",
           "details": {
             "issues": [
               {
-                "message": "Branch 1 is not taken in any test case.",
+                "message": "2nd branch is not taken in any test case.",
                 "severity": "error",
                 "source": {
                   "file": "packages/cli/src/lib/partly-covered/utils.ts",
@@ -47,7 +47,7 @@ exports[`CLI collect > should run Code coverage plugin and create report.json 1`
                 },
               },
               {
-                "message": "Branch 1 is not taken in any test case.",
+                "message": "2nd branch is not taken in any test case.",
                 "severity": "error",
                 "source": {
                   "file": "packages/cli/src/lib/partly-covered/utils.ts",
@@ -57,7 +57,7 @@ exports[`CLI collect > should run Code coverage plugin and create report.json 1`
                 },
               },
               {
-                "message": "Branch 0 is not taken in any test case.",
+                "message": "1st branch is not taken in any test case.",
                 "severity": "error",
                 "source": {
                   "file": "packages/cli/src/lib/not-covered/sorting.ts",
@@ -67,7 +67,7 @@ exports[`CLI collect > should run Code coverage plugin and create report.json 1`
                 },
               },
               {
-                "message": "Branch 1 is not taken in any test case.",
+                "message": "2nd branch is not taken in any test case.",
                 "severity": "error",
                 "source": {
                   "file": "packages/cli/src/lib/not-covered/sorting.ts",
@@ -79,13 +79,13 @@ exports[`CLI collect > should run Code coverage plugin and create report.json 1`
             ],
           },
           "displayValue": "76 %",
-          "score": 0.76,
+          "score": 0.7647,
           "slug": "branch-coverage",
-          "title": "branch coverage",
+          "title": "Branch coverage",
           "value": 76,
         },
         {
-          "description": "function coverage percentage on the project",
+          "description": "Function coverage percentage on the project.",
           "details": {
             "issues": [
               {
@@ -113,11 +113,11 @@ exports[`CLI collect > should run Code coverage plugin and create report.json 1`
           "displayValue": "60 %",
           "score": 0.6,
           "slug": "function-coverage",
-          "title": "function coverage",
+          "title": "Function coverage",
           "value": 60,
         },
         {
-          "description": "line coverage percentage on the project",
+          "description": "Line coverage percentage on the project.",
           "details": {
             "issues": [
               {
@@ -147,12 +147,12 @@ exports[`CLI collect > should run Code coverage plugin and create report.json 1`
           "displayValue": "68 %",
           "score": 0.68,
           "slug": "line-coverage",
-          "title": "line coverage",
+          "title": "Line coverage",
           "value": 68,
         },
       ],
-      "description": "Official Code PushUp code coverage plugin",
-      "docsUrl": "https://www.softwaretestinghelp.com/code-coverage-tutorial/",
+      "description": "Official Code PushUp code coverage plugin.",
+      "docsUrl": "https://www.npmjs.com/package/@code-pushup/coverage-plugin/",
       "icon": "folder-coverage-open",
       "packageName": "@code-pushup/coverage-plugin",
       "slug": "coverage",

packages/plugin-coverage/README.md

@@ -18,7 +18,8 @@ Measured coverage types are mapped to Code PushUp audits in the following way
 
 3. Add this plugin to the `plugins` array in your Code PushUp CLI config file (e.g. `code-pushup.config.js`).
 
-   Pass coverage types you wish to track (line, branch or function), paths to the code coverage results in LCOV format and optionally define your code coverage tool to be run first.
+   Pass paths to the code coverage results in LCOV format and optionally define your code coverage tool to be run first.
+   All coverage types are measured by default. If you wish to focus on a subset of offered types of coverage, define them in `coverageTypes`.
 
    📌 Please note that when you define the tool command, you still need to define the paths to all relevant coverage results.
 
@@ -32,7 +33,6 @@ Measured coverage types are mapped to Code PushUp audits in the following way
      plugins: [
        // ...
        await coveragePlugin({
-         coverageType: ['branch', 'function', 'line'],
          reports: [{ resultsPath: 'coverage/cli/lcov.info', pathToProject: 'packages/cli' }],
          coverageToolCommand: {
            command: 'npx',
@@ -121,7 +121,7 @@ It recognises the following entities:
 
 The plugin accepts the following parameters:
 
-- `coverageType`: An array of types of coverage that you wish to track. Supported values: `function`, `branch`, `line`.
+- `coverageTypes`: An array of types of coverage that you wish to track. Supported values: `function`, `branch`, `line`. Defaults to all available types.
 - `reports`: Array of information about files with code coverage results - paths to results, path to project root the results belong to. LCOV format is supported for now.
 - (optional) `coverageToolCommand`: If you wish to run your coverage tool to generate the results first, you may define it here.
 - (optional) `perfectScoreThreshold`: If your coverage goal is not 100%, you may define it here in range 0-1. Any score above the defined threshold will be given the perfect score. The value will stay unaffected.

packages/plugin-coverage/src/lib/config.ts

@@ -27,18 +27,25 @@ export const coveragePluginConfigSchema = z.object({
         .optional(),
     })
     .optional(),
-  coverageType: z.array(coverageTypeSchema).min(1),
+  coverageTypes: z
+    .array(coverageTypeSchema, {
+      description: 'Coverage types measured. Defaults to all available types.',
+    })
+    .min(1)
+    .default(['function', 'branch', 'line']),
   reports: z
     .array(coverageReportSchema, {
       description:
         'Path to all code coverage report files. Only LCOV format is supported for now.',
     })
     .min(1),
   perfectScoreThreshold: z
-    .number({ description: 'Score will be 100 for this coverage and above.' })
-    .min(1)
-    .max(100)
+    .number({
+      description:
+        'Score will be 1 (perfect) for this coverage and above. Score range is 0 - 1.',
+    })
+    .gt(0)
+    .max(1)
     .optional(),
 });
-
-export type CoveragePluginConfig = z.infer<typeof coveragePluginConfigSchema>;
+export type CoveragePluginConfig = z.input<typeof coveragePluginConfigSchema>;

packages/plugin-coverage/src/lib/config.unit.test.ts

@@ -1,11 +1,15 @@
 import { describe, expect, it } from 'vitest';
-import { CoveragePluginConfig, coveragePluginConfigSchema } from './config';
+import {
+  CoveragePluginConfig,
+  CoverageType,
+  coveragePluginConfigSchema,
+} from './config';
 
 describe('coveragePluginConfigSchema', () => {
   it('accepts a code coverage configuration with all entities', () => {
     expect(() =>
       coveragePluginConfigSchema.parse({
-        coverageType: ['branch', 'function'],
+        coverageTypes: ['branch', 'function'],
         reports: [
           {
             resultsPath: 'coverage/cli/lcov.info',
@@ -16,24 +20,37 @@ describe('coveragePluginConfigSchema', () => {
           command: 'npx nx run-many',
           args: ['-t', 'test', '--coverage'],
         },
-        perfectScoreThreshold: 85,
+        perfectScoreThreshold: 0.85,
       } satisfies CoveragePluginConfig),
     ).not.toThrow();
   });
 
   it('accepts a minimal code coverage configuration', () => {
     expect(() =>
       coveragePluginConfigSchema.parse({
-        coverageType: ['line'],
         reports: [{ resultsPath: 'coverage/cli/lcov.info' }],
       } satisfies CoveragePluginConfig),
     ).not.toThrow();
   });
 
-  it('throws for no coverage type', () => {
+  it('replaces undefined coverage with all available types', () => {
+    const config = {
+      reports: [{ resultsPath: 'coverage/cli/lcov.info' }],
+    } satisfies CoveragePluginConfig;
+    expect(() => coveragePluginConfigSchema.parse(config)).not.toThrow();
+
+    const { coverageTypes } = coveragePluginConfigSchema.parse(config);
+    expect(coverageTypes).toEqual([
+      'function',
+      'branch',
+      'line',
+    ] satisfies CoverageType[]);
+  });
+
+  it('throws for empty coverage type array', () => {
     expect(() =>
       coveragePluginConfigSchema.parse({
-        coverageType: [],
+        coverageTypes: [],
         reports: [{ resultsPath: 'coverage/cli/lcov.info' }],
       } satisfies CoveragePluginConfig),
     ).toThrow('too_small');
@@ -42,7 +59,7 @@ describe('coveragePluginConfigSchema', () => {
   it('throws for no report', () => {
     expect(() =>
       coveragePluginConfigSchema.parse({
-        coverageType: ['branch'],
+        coverageTypes: ['branch'],
         reports: [],
       } satisfies CoveragePluginConfig),
     ).toThrow('too_small');
@@ -51,7 +68,7 @@ describe('coveragePluginConfigSchema', () => {
   it('throws for unsupported report format', () => {
     expect(() =>
       coveragePluginConfigSchema.parse({
-        coverageType: ['line'],
+        coverageTypes: ['line'],
         reports: [{ resultsPath: 'coverage/cli/coverage-final.json' }],
       } satisfies CoveragePluginConfig),
     ).toThrow(/Invalid input: must include.+lcov/);
@@ -60,7 +77,7 @@ describe('coveragePluginConfigSchema', () => {
   it('throws for missing command', () => {
     expect(() =>
       coveragePluginConfigSchema.parse({
-        coverageType: ['line'],
+        coverageTypes: ['line'],
         reports: ['coverage/cli/lcov.info'],
         coverageToolCommand: {
           args: ['npx', 'nx', 'run-many', '-t', 'test', '--coverage'],
@@ -72,9 +89,9 @@ describe('coveragePluginConfigSchema', () => {
   it('throws for invalid score threshold', () => {
     expect(() =>
       coveragePluginConfigSchema.parse({
-        coverageType: ['line'],
+        coverageTypes: ['line'],
         reports: [{ resultsPath: 'coverage/cli/lcov.info' }],
-        perfectScoreThreshold: 110,
+        perfectScoreThreshold: 1.1,
       } satisfies CoveragePluginConfig),
     ).toThrow('too_big');
   });

packages/plugin-coverage/src/lib/coverage-plugin.integration.test.ts

@@ -3,7 +3,7 @@ import { describe, expect, it } from 'vitest';
 import { CoveragePluginConfig } from './config';
 import { coveragePlugin } from './coverage-plugin';
 
-describe('coveragePluginConfigSchema', () => {
+describe('coveragePlugin', () => {
   const LCOV_PATH = join(
     'packages',
     'plugin-coverage',
@@ -14,7 +14,7 @@ describe('coveragePluginConfigSchema', () => {
   it('should initialise a Code coverage plugin', () => {
     expect(
       coveragePlugin({
-        coverageType: ['function'],
+        coverageTypes: ['function'],
         reports: [{ resultsPath: LCOV_PATH }],
       }),
     ).toStrictEqual(
@@ -29,16 +29,16 @@ describe('coveragePluginConfigSchema', () => {
   it('should generate audits from coverage types', () => {
     expect(
       coveragePlugin({
-        coverageType: ['function', 'branch'],
+        coverageTypes: ['function', 'branch'],
         reports: [{ resultsPath: LCOV_PATH }],
       }),
     ).toStrictEqual(
       expect.objectContaining({
         audits: [
           {
             slug: 'function-coverage',
-            title: 'function coverage',
-            description: 'function coverage percentage on the project',
+            title: 'Function coverage',
+            description: expect.stringContaining('Function coverage'),
           },
           expect.objectContaining({ slug: 'branch-coverage' }),
         ],
@@ -49,7 +49,7 @@ describe('coveragePluginConfigSchema', () => {
   it('should assign RunnerConfig when a command is passed', () => {
     expect(
       coveragePlugin({
-        coverageType: ['line'],
+        coverageTypes: ['line'],
         reports: [{ resultsPath: LCOV_PATH }],
         coverageToolCommand: {
           command: 'npm run-many',
@@ -72,7 +72,7 @@ describe('coveragePluginConfigSchema', () => {
   it('should assign a RunnerFunction when only reports are passed', () => {
     expect(
       coveragePlugin({
-        coverageType: ['line'],
+        coverageTypes: ['line'],
         reports: [{ resultsPath: LCOV_PATH }],
       } satisfies CoveragePluginConfig),
     ).toStrictEqual(