chore(plugin-jsdocs): rename plugin

Author: aramirezj

code-pushup.config.ts

@@ -1,6 +1,12 @@
 import 'dotenv/config';
 import { z } from 'zod';
-import { docCoverageCoreConfig } from './code-pushup.preset.js';
+import {
+  coverageCoreConfigNx,
+  eslintCoreConfigNx,
+  jsDocsCoreConfig,
+  jsPackagesCoreConfig,
+  lighthouseCoreConfig,
+} from './code-pushup.preset.js';
 import type { CoreConfig } from './packages/models/src/index.js';
 import { mergeConfigs } from './packages/utils/src/index.js';
 
@@ -28,13 +34,13 @@ const config: CoreConfig = {
 
 export default mergeConfigs(
   config,
-  // await coverageCoreConfigNx(),
-  // await jsPackagesCoreConfig(),
-  // await lighthouseCoreConfig(
-  //   'https://github.com/code-pushup/cli?tab=readme-ov-file#code-pushup-cli/',
-  // ),
-  // await eslintCoreConfigNx(),
-  docCoverageCoreConfig([
+  await coverageCoreConfigNx(),
+  await jsPackagesCoreConfig(),
+  await lighthouseCoreConfig(
+    'https://github.com/code-pushup/cli?tab=readme-ov-file#code-pushup-cli/',
+  ),
+  await eslintCoreConfigNx(),
+  jsDocsCoreConfig([
     'packages/**/src/**/*.ts',
     '!packages/**/node_modules',
     '!packages/**/{mocks,mock}',

code-pushup.preset.ts

@@ -5,19 +5,19 @@ 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,
 } from './packages/plugin-eslint/src/index.js';
 import jsPackagesPlugin from './packages/plugin-js-packages/src/index.js';
+import jsDocsPlugin, {
+  JsDocsPluginConfig,
+} from './packages/plugin-jsdocs/src/index.js';
+import {
+  PLUGIN_SLUG,
+  groups,
+} from './packages/plugin-jsdocs/src/lib/constants.js';
+import { filterGroupsByOnlyAudits } from './packages/plugin-jsdocs/src/lib/utils.js';
 import lighthousePlugin, {
   lighthouseGroupRef,
 } from './packages/plugin-lighthouse/src/index.js';
@@ -90,8 +90,8 @@ export const eslintCategories: CategoryConfig[] = [
   },
 ];
 
-export function getDocCoverageCategories(
-  config: DocCoveragePluginConfig,
+export function getJsDocsCategories(
+  config: JsDocsPluginConfig,
 ): CategoryConfig[] {
   return [
     {
@@ -140,14 +140,14 @@ export const lighthouseCoreConfig = async (
   };
 };
 
-export const docCoverageCoreConfig = (
-  config: DocCoveragePluginConfig | string[],
+export const jsDocsCoreConfig = (
+  config: JsDocsPluginConfig | string[],
 ): CoreConfig => {
   return {
     plugins: [
-      docCoveragePlugin(Array.isArray(config) ? { patterns: config } : config),
+      jsDocsPlugin(Array.isArray(config) ? { patterns: config } : config),
     ],
-    categories: getDocCoverageCategories(
+    categories: getJsDocsCategories(
       Array.isArray(config) ? { patterns: config } : config,
     ),
   };

e2e/plugin-doc-coverage-e2e/project.json

@@ -3,6 +3,8 @@
   "$schema": "../../node_modules/nx/schemas/project-schema.json",
   "sourceRoot": "e2e/plugin-doc-coverage-e2e/src",
   "projectType": "application",
+  "tags": ["scope:plugin", "type:e2e"],
+  "implicitDependencies": ["cli", "plugin-jsdocs"],
   "targets": {
     "lint": {
       "executor": "@nx/linter:eslint",
@@ -17,7 +19,5 @@
         "configFile": "e2e/plugin-doc-coverage-e2e/vite.config.e2e.ts"
       }
     }
-  },
-  "implicitDependencies": ["cli", "plugin-doc-coverage"],
-  "tags": ["scope:plugin", "type:e2e"]
+  }
 }

packages/plugin-doc-coverage/project.json

@@ -1,8 +1,8 @@
-# @code-pushup/doc-coverage-plugin
+# @code-pushup/jsdocs-plugin
 
-[![npm](https://img.shields.io/npm/v/%40code-pushup%2Fdoc-coverage-plugin.svg)](https://www.npmjs.com/package/@code-pushup/doc-coverage-plugin)
-[![downloads](https://img.shields.io/npm/dm/%40code-pushup%2Fdoc-coverage-plugin)](https://npmtrends.com/@code-pushup/doc-coverage-plugin)
-[![dependencies](https://img.shields.io/librariesio/release/npm/%40code-pushup%2Fdoc-coverage-plugin)](https://www.npmjs.com/package/@code-pushup/doc-coverage-plugin?activeTab=dependencies)
+[![npm](https://img.shields.io/npm/v/%40code-pushup%2Fdoc-coverage-plugin.svg)](https://www.npmjs.com/package/@code-pushup/jsdocs-plugin)
+[![downloads](https://img.shields.io/npm/dm/%40code-pushup%2Fdoc-coverage-plugin)](https://npmtrends.com/@code-pushup/jsdocs-plugin)
+[![dependencies](https://img.shields.io/librariesio/release/npm/%40code-pushup%2Fdoc-coverage-plugin)](https://www.npmjs.com/package/@code-pushup/jsdocs-plugin?activeTab=dependencies)
 
 📚 **Code PushUp plugin for tracking documentation coverage.** 📝
 
@@ -24,27 +24,27 @@ Measured documentation types are mapped to Code PushUp audits in the following w
 2. Install as a dev dependency with your package manager:
 
    ```sh
-   npm install --save-dev @code-pushup/doc-coverage-plugin
+   npm install --save-dev @code-pushup/jsdocs-plugin
    ```
 
    ```sh
-   yarn add --dev @code-pushup/doc-coverage-plugin
+   yarn add --dev @code-pushup/jsdocs-plugin
    ```
 
    ```sh
-   pnpm add --save-dev @code-pushup/doc-coverage-plugin
+   pnpm add --save-dev @code-pushup/jsdocs-plugin
    ```
 
 3. Add this plugin to the `plugins` array in your Code PushUp CLI config file (e.g. `code-pushup.config.ts`).
 
    ```js
-   import docCoveragePlugin from '@code-pushup/doc-coverage-plugin';
+   import jsDocsPlugin from '@code-pushup/jsdocs-plugin';
 
    export default {
      // ...
      plugins: [
        // ...
-       docCoveragePlugin({
+       jsDocsPlugin({
          patterns: ['**/*.ts'],
        }),
      ],
@@ -105,7 +105,7 @@ The plugin accepts the following parameters:
 Required parameter. The `patterns` option accepts an array of strings that define patterns to include or exclude files. You can use glob patterns to match files and the `!` symbol to exclude specific patterns. Example:
 
 ```js
-docCoveragePlugin({
+jsDocsPlugin({
   patterns: [
     'src/**/*.ts',              // include all TypeScript files in src
     '!src/**/*.{spec,test}.ts', // exclude test files
@@ -119,7 +119,7 @@ docCoveragePlugin({
 Optional parameter. The `onlyAudits` option allows you to specify which documentation types you want to measure. Only the specified audits will be included in the results. Example:
 
 ```js
-docCoveragePlugin({
+jsDocsPlugin({
   patterns: ['src/**/*.ts'],
   onlyAudits: [
     'classes-coverage',
@@ -133,7 +133,7 @@ docCoveragePlugin({
 Optional parameter. The `skipAudits` option allows you to exclude specific documentation types from measurement. All other types will be included in the results.
 
 ```js
-docCoveragePlugin({
+jsDocsPlugin({
   patterns: ['src/**/*.ts'],
   skipAudits: [
     'variables-coverage',
@@ -204,7 +204,7 @@ For instance, this is an example of the plugin output:
 
 ```json
 {
-  "packageName": "@code-pushup/doc-coverage-plugin",
+  "packageName": "@code-pushup/jsdocs-plugin",
   "version": "0.57.0",
   "title": "Documentation coverage",
   "slug": "doc-coverage",
@@ -225,7 +225,7 @@ For instance, this is an example of the plugin output:
     }
   ],
   "description": "Official Code PushUp documentation coverage plugin.",
-  "docsUrl": "https://www.npmjs.com/package/@code-pushup/doc-coverage-plugin/",
+  "docsUrl": "https://www.npmjs.com/package/@code-pushup/jsdocs-plugin/",
   "groups": [
     {
       "slug": "doc-coverage",