@code-pushup/jsdocs-plugin 0.67.0 → 0.68.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/jsdocs-plugin",
-  "version": "0.67.0",
+  "version": "0.68.0",
   "description": "Code PushUp plugin for tracking documentation coverage 📚",
   "license": "MIT",
   "homepage": "https://github.com/code-pushup/cli/tree/main/packages/plugin-jsdocs#readme",
@@ -35,8 +35,8 @@
   },
   "type": "module",
   "dependencies": {
-    "@code-pushup/models": "0.67.0",
-    "@code-pushup/utils": "0.67.0",
+    "@code-pushup/models": "0.68.0",
+    "@code-pushup/utils": "0.68.0",
     "zod": "^3.22.4",
     "ts-morph": "^24.0.0"
   },

package/src/lib/runner/doc-processor.d.ts

@@ -1,45 +1,37 @@
 import { ClassDeclaration, JSDoc, SourceFile, SyntaxKind, VariableStatement } from 'ts-morph';
+import { type FileCoverage } from '@code-pushup/utils';
 import type { JsDocsPluginTransformedConfig } from '../config.js';
-import type { DocumentationCoverageReport, DocumentationReport } from './models.js';
+import type { CoverageType } from './models.js';
+type Node = {
+    getKind: () => SyntaxKind;
+    getName: () => string | undefined;
+    getStartLineNumber: () => number;
+    getEndLineNumber: () => number;
+    getJsDocs: () => JSDoc[];
+};
 /**
  * Gets the variables information from the variable statements
  * @param variableStatements - The variable statements to process
  * @returns The variables information with the right methods to get the information
  */
-export declare function getVariablesInformation(variableStatements: VariableStatement[]): {
-    getName: () => string;
-    getKind: () => SyntaxKind;
-    getJsDocs: () => JSDoc[];
-    getStartLineNumber: () => number;
-}[];
+export declare function getVariablesInformation(variableStatements: VariableStatement[]): Node[];
 /**
  * Processes documentation coverage for TypeScript files in the specified path
  * @param config - The configuration object containing patterns to include for documentation analysis
  * @returns Object containing coverage statistics and undocumented items
  */
-export declare function processJsDocs(config: JsDocsPluginTransformedConfig): DocumentationCoverageReport;
-export declare function getAllNodesFromASourceFile(sourceFile: SourceFile): ({
-    getName: () => string;
-    getKind: () => SyntaxKind;
-    getJsDocs: () => JSDoc[];
-    getStartLineNumber: () => number;
-} | ClassDeclaration | import("ts-morph").FunctionDeclaration | import("ts-morph").MethodDeclaration | import("ts-morph").PropertyDeclaration | import("ts-morph").TypeAliasDeclaration | import("ts-morph").EnumDeclaration | import("ts-morph").InterfaceDeclaration)[];
+export declare function processJsDocs(config: JsDocsPluginTransformedConfig): Record<CoverageType, FileCoverage[]>;
+export declare function getAllNodesFromASourceFile(sourceFile: SourceFile): (Node | ClassDeclaration | import("ts-morph").FunctionDeclaration | import("ts-morph").MethodDeclaration | import("ts-morph").PropertyDeclaration | import("ts-morph").TypeAliasDeclaration | import("ts-morph").EnumDeclaration | import("ts-morph").InterfaceDeclaration)[];
 /**
  * Gets the documentation coverage report from the source files
  * @param sourceFiles - The source files to process
  * @returns The documentation coverage report
  */
-export declare function getDocumentationReport(sourceFiles: SourceFile[]): DocumentationCoverageReport;
-/**
- * Merges two documentation results
- * @param accumulatedReport - The first empty documentation result
- * @param currentFileReport - The second documentation result
- * @returns The merged documentation result
- */
-export declare function mergeDocumentationReports(accumulatedReport: DocumentationReport, currentFileReport: Partial<DocumentationReport>): DocumentationReport;
+export declare function getDocumentationReport(sourceFiles: SourceFile[]): Record<CoverageType, FileCoverage[]>;
 /**
  * Gets the nodes from a class
  * @param classNodes - The class nodes to process
  * @returns The nodes from the class
  */
 export declare function getClassNodes(classNodes: ClassDeclaration[]): (import("ts-morph").MethodDeclaration | import("ts-morph").PropertyDeclaration)[];
+export {};

package/src/lib/runner/doc-processor.js

@@ -1,6 +1,6 @@
 import { ClassDeclaration, JSDoc, Project, SourceFile, SyntaxKind, VariableStatement, } from 'ts-morph';
-import { objectFromEntries, objectToEntries } from '@code-pushup/utils';
-import { calculateCoverage, createEmptyCoverageData, getCoverageTypeFromKind, } from './utils.js';
+import { objectFromEntries, objectToEntries, } from '@code-pushup/utils';
+import { createInitialCoverageTypesRecord, getCoverageTypeFromKind, singularCoverageType, } from './utils.js';
 /**
  * Gets the variables information from the variable statements
  * @param variableStatements - The variable statements to process
@@ -13,6 +13,7 @@ export function getVariablesInformation(variableStatements) {
             getKind: () => variable.getKind(),
             getJsDocs: () => variable.getJsDocs(),
             getStartLineNumber: () => variable.getStartLineNumber(),
+            getEndLineNumber: () => variable.getEndLineNumber(),
         };
         // Map each declaration to combine parent info with declaration-specific info
         return variable.getDeclarations().map(declaration => ({
@@ -49,13 +50,15 @@ export function getAllNodesFromASourceFile(sourceFile) {
  * @returns The documentation coverage report
  */
 export function getDocumentationReport(sourceFiles) {
-    const unprocessedCoverageReport = sourceFiles.reduce((coverageReportOfAllFiles, sourceFile) => {
+    return sourceFiles.reduce((acc, sourceFile) => {
         const filePath = sourceFile.getFilePath();
-        const allNodesFromFile = getAllNodesFromASourceFile(sourceFile);
-        const coverageReportOfCurrentFile = getCoverageFromAllNodesOfFile(allNodesFromFile, filePath);
-        return mergeDocumentationReports(coverageReportOfAllFiles, coverageReportOfCurrentFile);
-    }, createEmptyCoverageData());
-    return calculateCoverage(unprocessedCoverageReport);
+        const nodes = getAllNodesFromASourceFile(sourceFile);
+        const coverageTypes = getCoverageFromAllNodesOfFile(nodes, filePath);
+        return objectFromEntries(objectToEntries(coverageTypes).map(([type, file]) => [
+            type,
+            [...acc[type], file],
+        ]));
+    }, createInitialCoverageTypesRecord([]));
 }
 /**
  * Gets the coverage from all nodes of a file
@@ -66,44 +69,34 @@ export function getDocumentationReport(sourceFiles) {
 function getCoverageFromAllNodesOfFile(nodes, filePath) {
     return nodes.reduce((acc, node) => {
         const nodeType = getCoverageTypeFromKind(node.getKind());
-        const currentTypeReport = acc[nodeType];
-        const updatedIssues = node.getJsDocs().length === 0
-            ? [
-                ...currentTypeReport.issues,
-                {
-                    file: filePath,
-                    type: nodeType,
-                    name: node.getName() || '',
-                    line: node.getStartLineNumber(),
-                },
-            ]
-            : currentTypeReport.issues;
+        const isCovered = node.getJsDocs().length > 0;
         return {
             ...acc,
             [nodeType]: {
-                nodesCount: currentTypeReport.nodesCount + 1,
-                issues: updatedIssues,
+                ...acc[nodeType],
+                total: acc[nodeType].total + 1,
+                ...(isCovered
+                    ? {
+                        covered: acc[nodeType].covered + 1,
+                    }
+                    : {
+                        missing: [
+                            ...acc[nodeType].missing,
+                            {
+                                kind: singularCoverageType(nodeType),
+                                name: node.getName(),
+                                startLine: node.getStartLineNumber(),
+                                endLine: node.getEndLineNumber(),
+                            },
+                        ],
+                    }),
             },
         };
-    }, createEmptyCoverageData());
-}
-/**
- * Merges two documentation results
- * @param accumulatedReport - The first empty documentation result
- * @param currentFileReport - The second documentation result
- * @returns The merged documentation result
- */
-export function mergeDocumentationReports(accumulatedReport, currentFileReport) {
-    return objectFromEntries(objectToEntries(accumulatedReport).map(([key, value]) => {
-        const node = value;
-        const type = key;
-        return [
-            type,
-            {
-                nodesCount: node.nodesCount + (currentFileReport[type]?.nodesCount ?? 0),
-                issues: [...node.issues, ...(currentFileReport[type]?.issues ?? [])],
-            },
-        ];
+    }, createInitialCoverageTypesRecord({
+        path: filePath,
+        covered: 0,
+        total: 0,
+        missing: [],
     }));
 }
 /**

package/src/lib/runner/doc-processor.js.map

@@ -1 +1 @@
-{"version":3,"file":"doc-processor.js","sourceRoot":"","sources":["../../../../../../packages/plugin-jsdocs/src/lib/runner/doc-processor.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,KAAK,EACL,OAAO,EACP,UAAU,EACV,UAAU,EACV,iBAAiB,GAClB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAMxE,OAAO,EACL,iBAAiB,EACjB,uBAAuB,EACvB,uBAAuB,GACxB,MAAM,YAAY,CAAC;AASpB;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CACrC,kBAAuC;IAEvC,OAAO,kBAAkB,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QAC3C,+BAA+B;QAC/B,MAAM,UAAU,GAAG;YACjB,OAAO,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,OAAO,EAAE;YACjC,SAAS,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,SAAS,EAAE;YACrC,kBAAkB,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,kBAAkB,EAAE;SACxD,CAAC;QAEF,6EAA6E;QAC7E,OAAO,QAAQ,CAAC,eAAe,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;YACpD,GAAG,UAAU;YACb,OAAO,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,OAAO,EAAE;SACrC,CAAC,CAAC,CAAC;IACN,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAC3B,MAAqC;IAErC,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;IAC9B,OAAO,CAAC,qBAAqB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC/C,OAAO,sBAAsB,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;AAC1D,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,UAAsB;IAC/D,MAAM,OAAO,GAAG,UAAU,CAAC,UAAU,EAAE,CAAC;IACxC,OAAO;QACL,GAAG,UAAU,CAAC,YAAY,EAAE;QAC5B,GAAG,OAAO;QACV,GAAG,aAAa,CAAC,OAAO,CAAC;QACzB,GAAG,UAAU,CAAC,cAAc,EAAE;QAC9B,GAAG,UAAU,CAAC,QAAQ,EAAE;QACxB,GAAG,UAAU,CAAC,aAAa,EAAE;QAC7B,GAAG,uBAAuB,CAAC,UAAU,CAAC,qBAAqB,EAAE,CAAC;KAC/D,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CACpC,WAAyB;IAEzB,MAAM,yBAAyB,GAAG,WAAW,CAAC,MAAM,CAClD,CAAC,wBAAwB,EAAE,UAAU,EAAE,EAAE;QACvC,MAAM,QAAQ,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC;QAC1C,MAAM,gBAAgB,GAAG,0BAA0B,CAAC,UAAU,CAAC,CAAC;QAEhE,MAAM,2BAA2B,GAAG,6BAA6B,CAC/D,gBAAgB,EAChB,QAAQ,CACT,CAAC;QAEF,OAAO,yBAAyB,CAC9B,wBAAwB,EACxB,2BAA2B,CAC5B,CAAC;IACJ,CAAC,EACD,uBAAuB,EAAE,CAC1B,CAAC;IAEF,OAAO,iBAAiB,CAAC,yBAAyB,CAAC,CAAC;AACtD,CAAC;AAED;;;;;GAKG;AACH,SAAS,6BAA6B,CAAC,KAAa,EAAE,QAAgB;IACpE,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,GAAwB,EAAE,IAAU,EAAE,EAAE;QAC3D,MAAM,QAAQ,GAAG,uBAAuB,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QACzD,MAAM,iBAAiB,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC;QACxC,MAAM,aAAa,GACjB,IAAI,CAAC,SAAS,EAAE,CAAC,MAAM,KAAK,CAAC;YAC3B,CAAC,CAAC;gBACE,GAAG,iBAAiB,CAAC,MAAM;gBAC3B;oBACE,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE;oBAC1B,IAAI,EAAE,IAAI,CAAC,kBAAkB,EAAE;iBAChC;aACF;YACH,CAAC,CAAC,iBAAiB,CAAC,MAAM,CAAC;QAE/B,OAAO;YACL,GAAG,GAAG;YACN,CAAC,QAAQ,CAAC,EAAE;gBACV,UAAU,EAAE,iBAAiB,CAAC,UAAU,GAAG,CAAC;gBAC5C,MAAM,EAAE,aAAa;aACtB;SACF,CAAC;IACJ,CAAC,EAAE,uBAAuB,EAAE,CAAC,CAAC;AAChC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB,CACvC,iBAAsC,EACtC,iBAA+C;IAE/C,OAAO,iBAAiB,CACtB,eAAe,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACtD,MAAM,IAAI,GAAG,KAAK,CAAC;QACnB,MAAM,IAAI,GAAG,GAAG,CAAC;QACjB,OAAO;YACL,IAAI;YACJ;gBACE,UAAU,EACR,IAAI,CAAC,UAAU,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,UAAU,IAAI,CAAC,CAAC;gBAC9D,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC;aACrE;SACF,CAAC;IACJ,CAAC,CAAC,CACH,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,UAA8B;IAC1D,OAAO,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;QACrC,GAAG,SAAS,CAAC,UAAU,EAAE;QACzB,GAAG,SAAS,CAAC,aAAa,EAAE;KAC7B,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"doc-processor.js","sourceRoot":"","sources":["../../../../../../packages/plugin-jsdocs/src/lib/runner/doc-processor.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,KAAK,EACL,OAAO,EACP,UAAU,EACV,UAAU,EACV,iBAAiB,GAClB,MAAM,UAAU,CAAC;AAClB,OAAO,EAEL,iBAAiB,EACjB,eAAe,GAChB,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EACL,gCAAgC,EAChC,uBAAuB,EACvB,oBAAoB,GACrB,MAAM,YAAY,CAAC;AAUpB;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CACrC,kBAAuC;IAEvC,OAAO,kBAAkB,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QAC3C,+BAA+B;QAC/B,MAAM,UAAU,GAAG;YACjB,OAAO,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,OAAO,EAAE;YACjC,SAAS,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,SAAS,EAAE;YACrC,kBAAkB,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,kBAAkB,EAAE;YACvD,gBAAgB,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,gBAAgB,EAAE;SACpD,CAAC;QAEF,6EAA6E;QAC7E,OAAO,QAAQ,CAAC,eAAe,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;YACpD,GAAG,UAAU;YACb,OAAO,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,OAAO,EAAE;SACrC,CAAC,CAAC,CAAC;IACN,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAC3B,MAAqC;IAErC,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;IAC9B,OAAO,CAAC,qBAAqB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC/C,OAAO,sBAAsB,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;AAC1D,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,UAAsB;IAC/D,MAAM,OAAO,GAAG,UAAU,CAAC,UAAU,EAAE,CAAC;IACxC,OAAO;QACL,GAAG,UAAU,CAAC,YAAY,EAAE;QAC5B,GAAG,OAAO;QACV,GAAG,aAAa,CAAC,OAAO,CAAC;QACzB,GAAG,UAAU,CAAC,cAAc,EAAE;QAC9B,GAAG,UAAU,CAAC,QAAQ,EAAE;QACxB,GAAG,UAAU,CAAC,aAAa,EAAE;QAC7B,GAAG,uBAAuB,CAAC,UAAU,CAAC,qBAAqB,EAAE,CAAC;KAC/D,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CACpC,WAAyB;IAEzB,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,UAAU,EAAE,EAAE;QAC5C,MAAM,QAAQ,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC;QAC1C,MAAM,KAAK,GAAG,0BAA0B,CAAC,UAAU,CAAC,CAAC;QACrD,MAAM,aAAa,GAAG,6BAA6B,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QACrE,OAAO,iBAAiB,CACtB,eAAe,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC;YACnD,IAAI;YACJ,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC;SACrB,CAAC,CACH,CAAC;IACJ,CAAC,EAAE,gCAAgC,CAAiB,EAAE,CAAC,CAAC,CAAC;AAC3D,CAAC;AAED;;;;;GAKG;AACH,SAAS,6BAA6B,CAAC,KAAa,EAAE,QAAgB;IACpE,OAAO,KAAK,CAAC,MAAM,CACjB,CAAC,GAAuC,EAAE,IAAU,EAAE,EAAE;QACtD,MAAM,QAAQ,GAAG,uBAAuB,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QACzD,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC;QAE9C,OAAO;YACL,GAAG,GAAG;YACN,CAAC,QAAQ,CAAC,EAAE;gBACV,GAAG,GAAG,CAAC,QAAQ,CAAC;gBAChB,KAAK,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,KAAK,GAAG,CAAC;gBAC9B,GAAG,CAAC,SAAS;oBACX,CAAC,CAAC;wBACE,OAAO,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,OAAO,GAAG,CAAC;qBACnC;oBACH,CAAC,CAAC;wBACE,OAAO,EAAE;4BACP,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC,OAAO;4BACxB;gCACE,IAAI,EAAE,oBAAoB,CAAC,QAAQ,CAAC;gCACpC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE;gCACpB,SAAS,EAAE,IAAI,CAAC,kBAAkB,EAAE;gCACpC,OAAO,EAAE,IAAI,CAAC,gBAAgB,EAAE;6BACjC;yBACF;qBACF,CAAC;aACP;SACF,CAAC;IACJ,CAAC,EACD,gCAAgC,CAAe;QAC7C,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,CAAC;QACV,KAAK,EAAE,CAAC;QACR,OAAO,EAAE,EAAE;KACZ,CAAC,CACH,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,UAA8B;IAC1D,OAAO,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;QACrC,GAAG,SAAS,CAAC,UAAU,EAAE;QACzB,GAAG,SAAS,CAAC,aAAa,EAAE;KAC7B,CAAC,CAAC;AACL,CAAC"}

package/src/lib/runner/models.d.ts

@@ -1,21 +1,2 @@
 /** The possible coverage types for documentation analysis */
 export type CoverageType = 'classes' | 'methods' | 'functions' | 'interfaces' | 'enums' | 'variables' | 'properties' | 'types';
-/** The undocumented node is the node that is not documented and has the information for the report. */
-export type UndocumentedNode = {
-    file: string;
-    type: CoverageType;
-    name: string;
-    line: number;
-    class?: string;
-};
-/** The documentation data has the issues and the total nodes count from a specific CoverageType. */
-export type DocumentationData = {
-    issues: UndocumentedNode[];
-    nodesCount: number;
-};
-/** The documentation report has all the documentation data for each coverage type. */
-export type DocumentationReport = Record<CoverageType, DocumentationData>;
-/** The processed documentation result has the documentation data for each coverage type and with coverage stats. */
-export type DocumentationCoverageReport = Record<CoverageType, DocumentationData & {
-    coverage: number;
-}>;

package/src/lib/runner/runner.d.ts

@@ -1,11 +1,13 @@
 import type { AuditOutputs, RunnerFunction } from '@code-pushup/models';
+import { type FileCoverage } from '@code-pushup/utils';
 import type { JsDocsPluginTransformedConfig } from '../config.js';
-import type { DocumentationCoverageReport } from './models.js';
+import type { CoverageType } from './models.js';
 export declare function createRunnerFunction(config: JsDocsPluginTransformedConfig): RunnerFunction;
 /**
  * Transforms the coverage report into audit outputs.
  * @param coverageResult - The coverage result containing undocumented items and coverage statistics
  * @param options - Configuration options specifying which audits to include and exclude
+ * @param gitRoot - Root directory in repo for relative file paths
  * @returns Audit outputs with coverage scores and details about undocumented items
  */
-export declare function trasformCoverageReportToAuditOutputs(coverageResult: DocumentationCoverageReport, options: Pick<JsDocsPluginTransformedConfig, 'onlyAudits' | 'skipAudits'>): AuditOutputs;
+export declare function trasformCoverageReportToAuditOutputs(coverageResult: Record<CoverageType, FileCoverage[]>, options: Pick<JsDocsPluginTransformedConfig, 'onlyAudits' | 'skipAudits'>, gitRoot: string): AuditOutputs;

package/src/lib/runner/runner.js

@@ -1,19 +1,22 @@
+import { filesCoverageToTree, getGitRoot, objectToEntries, toNumberPrecision, } from '@code-pushup/utils';
 import { processJsDocs } from './doc-processor.js';
 import { coverageTypeToAuditSlug } from './utils.js';
 export function createRunnerFunction(config) {
-    return () => {
+    return async () => {
         const coverageResult = processJsDocs(config);
-        return trasformCoverageReportToAuditOutputs(coverageResult, config);
+        const gitRoot = await getGitRoot();
+        return trasformCoverageReportToAuditOutputs(coverageResult, config, gitRoot);
     };
 }
 /**
  * Transforms the coverage report into audit outputs.
  * @param coverageResult - The coverage result containing undocumented items and coverage statistics
  * @param options - Configuration options specifying which audits to include and exclude
+ * @param gitRoot - Root directory in repo for relative file paths
  * @returns Audit outputs with coverage scores and details about undocumented items
  */
-export function trasformCoverageReportToAuditOutputs(coverageResult, options) {
-    return Object.entries(coverageResult)
+export function trasformCoverageReportToAuditOutputs(coverageResult, options, gitRoot) {
+    return objectToEntries(coverageResult)
         .filter(([type]) => {
         const auditSlug = coverageTypeToAuditSlug(type);
         if (options.onlyAudits?.length) {
@@ -24,19 +27,18 @@ export function trasformCoverageReportToAuditOutputs(coverageResult, options) {
         }
         return true;
     })
-        .map(([type, item]) => {
-        const { coverage, issues } = item;
+        .map(([type, files]) => {
+        const tree = filesCoverageToTree(files, gitRoot, `Documented ${type}`);
+        const coverage = tree.root.values.coverage;
+        const missingCount = files.reduce((acc, file) => acc + file.missing.length, 0);
+        const MAX_DECIMAL_PLACES = 4;
         return {
             slug: `${type}-coverage`,
-            value: issues.length,
-            score: coverage / 100,
-            displayValue: `${issues.length} undocumented ${type}`,
+            value: missingCount,
+            score: toNumberPrecision(coverage, MAX_DECIMAL_PLACES),
+            displayValue: `${missingCount} undocumented ${type}`,
             details: {
-                issues: item.issues.map(({ file, line, name }) => ({
-                    message: `Missing ${type} documentation for ${name}`,
-                    source: { file, position: { startLine: line } },
-                    severity: 'warning',
-                })),
+                trees: [tree],
             },
         };
     });

package/src/lib/runner/runner.js.map

@@ -1 +1 @@
-{"version":3,"file":"runner.js","sourceRoot":"","sources":["../../../../../../packages/plugin-jsdocs/src/lib/runner/runner.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AAErD,MAAM,UAAU,oBAAoB,CAClC,MAAqC;IAErC,OAAO,GAAiB,EAAE;QACxB,MAAM,cAAc,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;QAC7C,OAAO,oCAAoC,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;IACtE,CAAC,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oCAAoC,CAClD,cAA2C,EAC3C,OAAyE;IAEzE,OAAO,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC;SAClC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE;QACjB,MAAM,SAAS,GAAG,uBAAuB,CAAC,IAAoB,CAAC,CAAC;QAChE,IAAI,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;YAC/B,OAAO,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAChD,CAAC;QACD,IAAI,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;YAC/B,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACjD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;SACD,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;QACpB,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAElC,OAAO;YACL,IAAI,EAAE,GAAG,IAAI,WAAW;YACxB,KAAK,EAAE,MAAM,CAAC,MAAM;YACpB,KAAK,EAAE,QAAQ,GAAG,GAAG;YACrB,YAAY,EAAE,GAAG,MAAM,CAAC,MAAM,iBAAiB,IAAI,EAAE;YACrD,OAAO,EAAE;gBACP,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;oBACjD,OAAO,EAAE,WAAW,IAAI,sBAAsB,IAAI,EAAE;oBACpD,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;oBAC/C,QAAQ,EAAE,SAAS;iBACpB,CAAC,CAAC;aACJ;SACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACP,CAAC"}
+{"version":3,"file":"runner.js","sourceRoot":"","sources":["../../../../../../packages/plugin-jsdocs/src/lib/runner/runner.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,mBAAmB,EACnB,UAAU,EACV,eAAe,EACf,iBAAiB,GAClB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AAErD,MAAM,UAAU,oBAAoB,CAClC,MAAqC;IAErC,OAAO,KAAK,IAA2B,EAAE;QACvC,MAAM,cAAc,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;QAC7C,MAAM,OAAO,GAAG,MAAM,UAAU,EAAE,CAAC;QACnC,OAAO,oCAAoC,CACzC,cAAc,EACd,MAAM,EACN,OAAO,CACR,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,oCAAoC,CAClD,cAAoD,EACpD,OAAyE,EACzE,OAAe;IAEf,OAAO,eAAe,CAAC,cAAc,CAAC;SACnC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE;QACjB,MAAM,SAAS,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC;QAChD,IAAI,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;YAC/B,OAAO,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAChD,CAAC;QACD,IAAI,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;YAC/B,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACjD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;SACD,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE;QACrB,MAAM,IAAI,GAAG,mBAAmB,CAAC,KAAK,EAAE,OAAO,EAAE,cAAc,IAAI,EAAE,CAAC,CAAC;QACvE,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QAC3C,MAAM,YAAY,GAAG,KAAK,CAAC,MAAM,CAC/B,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EACxC,CAAC,CACF,CAAC;QACF,MAAM,kBAAkB,GAAG,CAAC,CAAC;QAE7B,OAAO;YACL,IAAI,EAAE,GAAG,IAAI,WAAW;YACxB,KAAK,EAAE,YAAY;YACnB,KAAK,EAAE,iBAAiB,CAAC,QAAQ,EAAE,kBAAkB,CAAC;YACtD,YAAY,EAAE,GAAG,YAAY,iBAAiB,IAAI,EAAE;YACpD,OAAO,EAAE;gBACP,KAAK,EAAE,CAAC,IAAI,CAAC;aACd;SACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACP,CAAC"}

package/src/lib/runner/utils.d.ts

@@ -1,25 +1,26 @@
 import { SyntaxKind } from 'ts-morph';
-import type { CoverageType, DocumentationCoverageReport, DocumentationReport } from './models.js';
+import type { CoverageType } from './models.js';
 /**
  * Creates an empty unprocessed coverage report.
+ * @param initialValue - Initial value for each coverage type
  * @returns The empty unprocessed coverage report.
  */
-export declare function createEmptyCoverageData(): DocumentationReport;
+export declare function createInitialCoverageTypesRecord<T>(initialValue: T): Record<CoverageType, T>;
 /**
  * Converts the coverage type to the audit slug.
  * @param type - The coverage type.
  * @returns The audit slug.
  */
 export declare function coverageTypeToAuditSlug(type: CoverageType): string;
-/**
- * Calculates the coverage percentage for each coverage type.
- * @param result - The unprocessed coverage result.
- * @returns The processed coverage result.
- */
-export declare function calculateCoverage(result: DocumentationReport): DocumentationCoverageReport;
 /**
  * Maps the SyntaxKind from the library ts-morph to the coverage type.
  * @param kind - The SyntaxKind from the library ts-morph.
  * @returns The coverage type.
  */
 export declare function getCoverageTypeFromKind(kind: SyntaxKind): CoverageType;
+/**
+ * Convert plural coverage type to singular form
+ * @param type Coverage type (plural)
+ * @returns Singular form of coverage type
+ */
+export declare function singularCoverageType(type: CoverageType): string;

package/src/lib/runner/utils.js

@@ -2,18 +2,19 @@ import { SyntaxKind } from 'ts-morph';
 import { SYNTAX_COVERAGE_MAP } from './constants.js';
 /**
  * Creates an empty unprocessed coverage report.
+ * @param initialValue - Initial value for each coverage type
  * @returns The empty unprocessed coverage report.
  */
-export function createEmptyCoverageData() {
+export function createInitialCoverageTypesRecord(initialValue) {
     return {
-        enums: { nodesCount: 0, issues: [] },
-        interfaces: { nodesCount: 0, issues: [] },
-        types: { nodesCount: 0, issues: [] },
-        functions: { nodesCount: 0, issues: [] },
-        variables: { nodesCount: 0, issues: [] },
-        classes: { nodesCount: 0, issues: [] },
-        methods: { nodesCount: 0, issues: [] },
-        properties: { nodesCount: 0, issues: [] },
+        enums: initialValue,
+        interfaces: initialValue,
+        types: initialValue,
+        functions: initialValue,
+        variables: initialValue,
+        classes: initialValue,
+        methods: initialValue,
+        properties: initialValue,
     };
 }
 /**
@@ -24,26 +25,6 @@ export function createEmptyCoverageData() {
 export function coverageTypeToAuditSlug(type) {
     return `${type}-coverage`;
 }
-/**
- * Calculates the coverage percentage for each coverage type.
- * @param result - The unprocessed coverage result.
- * @returns The processed coverage result.
- */
-export function calculateCoverage(result) {
-    return Object.fromEntries(Object.entries(result).map(([key, value]) => {
-        const type = key;
-        return [
-            type,
-            {
-                coverage: value.nodesCount === 0
-                    ? 100
-                    : Number(((1 - value.issues.length / value.nodesCount) * 100).toFixed(2)),
-                issues: value.issues,
-                nodesCount: value.nodesCount,
-            },
-        ];
-    }));
-}
 /**
  * Maps the SyntaxKind from the library ts-morph to the coverage type.
  * @param kind - The SyntaxKind from the library ts-morph.
@@ -56,4 +37,29 @@ export function getCoverageTypeFromKind(kind) {
     }
     return type;
 }
+/**
+ * Convert plural coverage type to singular form
+ * @param type Coverage type (plural)
+ * @returns Singular form of coverage type
+ */
+export function singularCoverageType(type) {
+    switch (type) {
+        case 'classes':
+            return 'class';
+        case 'enums':
+            return 'enum';
+        case 'functions':
+            return 'function';
+        case 'interfaces':
+            return 'interface';
+        case 'methods':
+            return 'method';
+        case 'properties':
+            return 'property';
+        case 'types':
+            return 'type';
+        case 'variables':
+            return 'variable';
+    }
+}
 //# sourceMappingURL=utils.js.map

package/src/lib/runner/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../../../packages/plugin-jsdocs/src/lib/runner/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAOrD;;;GAGG;AACH,MAAM,UAAU,uBAAuB;IACrC,OAAO;QACL,KAAK,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;QACpC,UAAU,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;QACzC,KAAK,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;QACpC,SAAS,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;QACxC,SAAS,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;QACxC,OAAO,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;QACtC,OAAO,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;QACtC,UAAU,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;KAC1C,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,IAAkB;IACxD,OAAO,GAAG,IAAI,WAAW,CAAC;AAC5B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAA2B;IAC3D,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC1C,MAAM,IAAI,GAAG,GAAmB,CAAC;QACjC,OAAO;YACL,IAAI;YACJ;gBACE,QAAQ,EACN,KAAK,CAAC,UAAU,KAAK,CAAC;oBACpB,CAAC,CAAC,GAAG;oBACL,CAAC,CAAC,MAAM,CACJ,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,CAAC,OAAO,CAC1D,CAAC,CACF,CACF;gBACP,MAAM,EAAE,KAAK,CAAC,MAAM;gBACpB,UAAU,EAAE,KAAK,CAAC,UAAU;aAC7B;SACF,CAAC;IACJ,CAAC,CAAC,CAC4B,CAAC;AACnC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,IAAgB;IACtD,MAAM,IAAI,GAAG,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAE3C,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,4BAA4B,IAAI,EAAE,CAAC,CAAC;IACtD,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../../../packages/plugin-jsdocs/src/lib/runner/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAGrD;;;;GAIG;AACH,MAAM,UAAU,gCAAgC,CAC9C,YAAe;IAEf,OAAO;QACL,KAAK,EAAE,YAAY;QACnB,UAAU,EAAE,YAAY;QACxB,KAAK,EAAE,YAAY;QACnB,SAAS,EAAE,YAAY;QACvB,SAAS,EAAE,YAAY;QACvB,OAAO,EAAE,YAAY;QACrB,OAAO,EAAE,YAAY;QACrB,UAAU,EAAE,YAAY;KACzB,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,IAAkB;IACxD,OAAO,GAAG,IAAI,WAAW,CAAC;AAC5B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,IAAgB;IACtD,MAAM,IAAI,GAAG,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAE3C,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,4BAA4B,IAAI,EAAE,CAAC,CAAC;IACtD,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAAkB;IACrD,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,SAAS;YACZ,OAAO,OAAO,CAAC;QACjB,KAAK,OAAO;YACV,OAAO,MAAM,CAAC;QAChB,KAAK,WAAW;YACd,OAAO,UAAU,CAAC;QACpB,KAAK,YAAY;YACf,OAAO,WAAW,CAAC;QACrB,KAAK,SAAS;YACZ,OAAO,QAAQ,CAAC;QAClB,KAAK,YAAY;YACf,OAAO,UAAU,CAAC;QACpB,KAAK,OAAO;YACV,OAAO,MAAM,CAAC;QAChB,KAAK,WAAW;YACd,OAAO,UAAU,CAAC;IACtB,CAAC;AACH,CAAC"}