chore(plugin-doc-coverage): fix linter problems

Author: aramirezj

…oc-coverage/mocks/component-mock.spec.ts …verage/mocks/component-mock.unit.test.tspackages/plugin-doc-coverage/mocks/component-mock.spec.ts renamed to packages/plugin-doc-coverage/mocks/component-mock.unit.test.ts packages/plugin-doc-coverage/mocks/component-mock.spec.ts renamed to packages/plugin-doc-coverage/mocks/component-mock.unit.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest';
-import { DUMMY_FUNCTION, DUMMY_FUNCTION_2 } from './component-mock';
+import { DUMMY_FUNCTION, DUMMY_FUNCTION_2 } from './component-mock.js';
 
 export function shouldnotBeHere() {
   return 'Hello World';

packages/plugin-doc-coverage/package.json

@@ -35,8 +35,6 @@
   "type": "module",
   "dependencies": {
     "@code-pushup/models": "0.57.0",
-    "@code-pushup/utils": "0.57.0",
-    "ansis": "^3.3.0",
     "zod": "^3.22.4",
     "ts-morph": "^24.0.0"
   },

packages/plugin-doc-coverage/src/bin.ts

@@ -1,5 +1,5 @@
 import type { Audit, Group } from '@code-pushup/models';
-import type { AuditSlug } from './models';
+import type { AuditSlug } from './models.js';
 
 export const PLUGIN_SLUG = 'doc-coverage';
 
@@ -51,18 +51,15 @@ export const groups: Group[] = [
     slug: 'documentation-coverage',
     title: 'Documentation coverage',
     description: 'Documentation coverage',
-    refs: Object.keys(AUDITS_MAP).map(slug => {
-      switch (slug as AuditSlug) {
-        case 'classes-coverage':
-        case 'functions-coverage':
-        case 'methods-coverage':
-          return { slug, weight: 2 };
-        case 'interfaces-coverage':
-        case 'properties-coverage':
-        case 'types-coverage':
-        default:
-          return { slug, weight: 1 };
-      }
-    }),
+    refs: Object.keys(AUDITS_MAP).map(slug => ({
+      slug,
+      weight: [
+        'classes-coverage',
+        'functions-coverage',
+        'methods-coverage',
+      ].includes(slug)
+        ? 2
+        : 1,
+    })),
   },
 ];

packages/plugin-doc-coverage/src/lib/constants.ts

@@ -1,3 +1,3 @@
-import type { CoverageType } from './runner/models';
+import type { CoverageType } from './runner/models.js';
 
 export type AuditSlug = `${CoverageType}-coverage`;

packages/plugin-doc-coverage/src/lib/models.ts

@@ -1,4 +1,4 @@
-import { processDocCoverage } from './doc-processer';
+import { processDocCoverage } from './doc-processer.js';
 
 describe('processDocCoverage', () => {
   it('should succesfully get the right number of ts files', () => {

packages/plugin-doc-coverage/src/lib/runner/doc-processer.integration.test.ts

@@ -29,37 +29,48 @@ export function processDocCoverage(
  * @param sourceFiles - The source files to process
  * @returns {UnprocessedCoverageResult} The unprocessed coverage report
  */
-export function getUnprocessedCoverageReport(sourceFiles: SourceFile[]) {
+export function getUnprocessedCoverageReport(
+  sourceFiles: SourceFile[],
+): CoverageResult {
   const unprocessedCoverageReport = sourceFiles.reduce(
     (coverageReportOfAllFiles, sourceFile) => {
-      // Info of the file
       const filePath = sourceFile.getFilePath();
       const classes = sourceFile.getClasses();
 
-      // All nodes of the file
       const allNodesFromFile = [
         ...sourceFile.getFunctions(),
         ...classes,
         ...getClassNodes(classes),
         ...sourceFile.getTypeAliases(),
         ...sourceFile.getEnums(),
         ...sourceFile.getInterfaces(),
-        // ...sourceFile.getVariableStatements().flatMap(statement => statement.getDeclarations())
       ];
 
       const coverageReportOfCurrentFile = allNodesFromFile.reduce(
         (acc, node) => {
           const nodeType = getCoverageTypeFromKind(node.getKind());
-          acc[nodeType].nodesCount++;
-          if (node.getJsDocs().length === 0) {
-            acc[nodeType].issues.push({
-              file: filePath,
-              type: nodeType,
-              name: node.getName() || '',
-              line: node.getStartLineNumber(),
-            });
-          }
-          return acc;
+          const currentTypeReport = acc[nodeType];
+
+          const updatedIssues =
+            node.getJsDocs().length === 0
+              ? [
+                  ...currentTypeReport.issues,
+                  {
+                    file: filePath,
+                    type: nodeType,
+                    name: node.getName() || '',
+                    line: node.getStartLineNumber(),
+                  },
+                ]
+              : currentTypeReport.issues;
+
+          return {
+            ...acc,
+            [nodeType]: {
+              nodesCount: currentTypeReport.nodesCount + 1,
+              issues: updatedIssues,
+            },
+          };
         },
         createEmptyUnprocessedCoverageReport(),
       );
@@ -84,22 +95,20 @@ export function getUnprocessedCoverageReport(sourceFiles: SourceFile[]) {
 export function mergeCoverageResults(
   results: UnprocessedCoverageResult,
   current: Partial<UnprocessedCoverageResult>,
-) {
-  return {
-    ...Object.fromEntries(
-      Object.entries(results).map(([key, value]) => {
-        const node = value as CoverageResult[CoverageType];
-        const type = key as CoverageType;
-        return [
-          type,
-          {
-            nodesCount: node.nodesCount + (current[type]?.nodesCount ?? 0),
-            issues: [...node.issues, ...(current[type]?.issues ?? [])],
-          },
-        ];
-      }),
-    ),
-  } as UnprocessedCoverageResult;
+): UnprocessedCoverageResult {
+  return Object.fromEntries(
+    Object.entries(results).map(([key, value]) => {
+      const node = value as CoverageResult[CoverageType];
+      const type = key as CoverageType;
+      return [
+        type,
+        {
+          nodesCount: node.nodesCount + (current[type]?.nodesCount ?? 0),
+          issues: [...node.issues, ...(current[type]?.issues ?? [])],
+        },
+      ];
+    }),
+  ) as UnprocessedCoverageResult;
 }
 
 /**

packages/plugin-doc-coverage/src/lib/runner/doc-processer.ts

@@ -1,11 +1,11 @@
 import type { ClassDeclaration } from 'ts-morph';
-import { nodeMock, sourceFileMock } from './../../../mocks/source-files.mock';
+import { nodeMock, sourceFileMock } from '../../../mocks/source-files.mock';
 import {
   getClassNodes,
   getUnprocessedCoverageReport,
   mergeCoverageResults,
-} from './doc-processer';
-import type { UnprocessedCoverageResult } from './models';
+} from './doc-processer.js';
+import type { UnprocessedCoverageResult } from './models.js';
 
 describe('getUnprocessedCoverageReport', () => {
   it('should produce a full report', () => {
@@ -43,7 +43,7 @@ describe('getUnprocessedCoverageReport', () => {
       sourceFileMock('test.ts', { functions: { 1: true, 2: false, 3: false } }),
     ]);
 
-    expect(results.functions.issues.length).toBe(2);
+    expect(results.functions.issues).toHaveLength(2);
   });
 
   it('should collect valid issues', () => {

packages/plugin-doc-coverage/src/lib/runner/doc-processer.unit.test.ts

@@ -1,7 +1,7 @@
 import type { AuditOutputs, RunnerFunction } from '@code-pushup/models';
-import type { DocCoveragePluginConfig } from '../config';
-import { processDocCoverage } from './doc-processer';
-import type { CoverageResult, CoverageType } from './models';
+import type { DocCoveragePluginConfig } from '../config.js';
+import { processDocCoverage } from './doc-processer.js';
+import type { CoverageResult, CoverageType } from './models.js';
 
 export function createRunnerFunction(
   config: DocCoveragePluginConfig,

packages/plugin-doc-coverage/src/lib/runner/runner.ts

@@ -1,5 +1,5 @@
-import type { CoverageResult } from './models';
-import { trasformCoverageReportToAudits } from './runner';
+import type { CoverageResult } from './models.js';
+import { trasformCoverageReportToAudits } from './runner.js';
 
 describe('trasformCoverageReportToAudits', () => {
   const mockCoverageResult = {