feat(plugin-doc-coverage): add doc-coverage-plugin to analyze documentation in ts/js projects

code-pushup.config.ts

@@ -2,6 +2,7 @@ import 'dotenv/config';
 import { z } from 'zod';
 import {
   coverageCoreConfigNx,
+  docCoverageCoreConfig,
   eslintCoreConfigNx,
   jsPackagesCoreConfig,
   lighthouseCoreConfig,
@@ -39,4 +40,14 @@ export default mergeConfigs(
     'https://github.com/code-pushup/cli?tab=readme-ov-file#code-pushup-cli/',
   ),
   await eslintCoreConfigNx(),
+  await docCoverageCoreConfig({
+    sourceGlob: [
+      'packages/**/src/**/*.ts',
+      '!**/*.spec.ts',
+      '!**/*.test.ts',
+      '!**/implementation/**',
+      '!**/internal/**',
+    ],
+    skipAudits: ['methods-coverage'],
+  }),
 );

code-pushup.preset.ts

@@ -5,6 +5,14 @@ import type {
 import coveragePlugin, {
   getNxCoveragePaths,
 } from './packages/plugin-coverage/src/index.js';
+import docCoveragePlugin, {
+  DocCoveragePluginConfig,
+} from './packages/plugin-doc-coverage/src/index.js';
+import {
+  PLUGIN_SLUG,
+  groups,
+} from './packages/plugin-doc-coverage/src/lib/constants.js';
+import { filterGroupsByOnlyAudits } from './packages/plugin-doc-coverage/src/lib/utils.js';
 import eslintPlugin, {
   eslintConfigFromAllNxProjects,
   eslintConfigFromNxProject,
@@ -82,6 +90,24 @@ export const eslintCategories: CategoryConfig[] = [
   },
 ];
 
+export function getDocCoverageCategories(
+  config: DocCoveragePluginConfig,
+): CategoryConfig[] {
+  return [
+    {
+      slug: 'doc-coverage-cat',
+      title: 'Documentation coverage',
+      description: 'Measures how much of your code is **documented**.',
+      refs: filterGroupsByOnlyAudits(groups, config).map(group => ({
+        weight: 1,
+        type: 'group',
+        plugin: PLUGIN_SLUG,
+        slug: group.slug,
+      })),
+    },
+  ];
+}
+
 export const coverageCategories: CategoryConfig[] = [
   {
     slug: 'code-coverage',
@@ -114,6 +140,15 @@ export const lighthouseCoreConfig = async (
   };
 };
 
+export const docCoverageCoreConfig = async (
+  config: DocCoveragePluginConfig,
+): Promise<CoreConfig> => {
+  return {
+    plugins: [await docCoveragePlugin(config)],
+    categories: getDocCoverageCategories(config),
+  };
+};
+
 export const eslintCoreConfigNx = async (
   projectName?: string,
 ): Promise<CoreConfig> => {

package.json

@@ -40,6 +40,7 @@
     "parse-lcov": "^1.0.4",
     "semver": "^7.6.3",
     "simple-git": "^3.26.0",
+    "ts-morph": "^24.0.0",
     "tslib": "^2.6.2",
     "vscode-material-icons": "^0.1.1",
     "yaml": "^2.5.1",