@code-pushup/jsdocs-plugin 0.125.0 → 0.126.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/jsdocs-plugin",
-  "version": "0.125.0",
+  "version": "0.126.1",
   "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.125.0",
-    "@code-pushup/utils": "0.125.0",
+    "@code-pushup/models": "0.126.1",
+    "@code-pushup/utils": "0.126.1",
     "zod": "^4.2.1",
     "ts-morph": "^24.0.0"
   },

package/src/index.d.ts

@@ -1,3 +1,4 @@
 import { jsDocsPlugin } from './lib/jsdocs-plugin.js';
 export default jsDocsPlugin;
+export { jsDocsSetupBinding } from './lib/binding.js';
 export type { JsDocsPluginConfig } from './lib/config.js';

package/src/index.js

@@ -1,3 +1,4 @@
 import { jsDocsPlugin } from './lib/jsdocs-plugin.js';
 export default jsDocsPlugin;
+export { jsDocsSetupBinding } from './lib/binding.js';
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAEtD,eAAe,YAAY,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAEtD,eAAe,YAAY,CAAC;AAC5B,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC"}

package/src/lib/binding.d.ts

@@ -0,0 +1,38 @@
+import type { PluginAnswer } from '@code-pushup/models';
+export declare const jsDocsSetupBinding: {
+    slug: string;
+    title: string;
+    packageName: string;
+    prompts: () => Promise<({
+        key: string;
+        message: string;
+        type: "input";
+        default: string;
+    } | {
+        key: string;
+        message: string;
+        type: "confirm";
+        default: true;
+    })[]>;
+    generateConfig: (answers: Record<string, PluginAnswer>) => {
+        categories?: {
+            slug: string;
+            refs: {
+                slug: string;
+                weight: number;
+                type: "audit" | "group";
+                plugin: string;
+            }[];
+            title: string;
+            description?: string | undefined;
+            docsUrl?: string | undefined;
+            isSkipped?: boolean | undefined;
+            scoreTarget?: number | undefined;
+        }[] | undefined;
+        imports: {
+            moduleSpecifier: string;
+            defaultImport: string;
+        }[];
+        pluginInit: string[];
+    };
+};

package/src/lib/binding.js

@@ -0,0 +1,68 @@
+import { createRequire } from 'node:module';
+import { answerBoolean, answerNonEmptyArray, singleQuote, } from '@code-pushup/utils';
+import { PLUGIN_SLUG, PLUGIN_TITLE } from './constants.js';
+const { name: PACKAGE_NAME } = createRequire(import.meta.url)('../../package.json');
+const DEFAULT_PATTERNS = [
+    'src/**/*.ts',
+    'src/**/*.js',
+    '!**/node_modules',
+];
+const CATEGORY = {
+    slug: 'docs',
+    title: 'Documentation',
+    description: 'Measures how much of your code is **documented**.',
+    refs: [
+        {
+            type: 'group',
+            plugin: PLUGIN_SLUG,
+            slug: 'documentation-coverage',
+            weight: 1,
+        },
+    ],
+};
+export const jsDocsSetupBinding = {
+    slug: PLUGIN_SLUG,
+    title: PLUGIN_TITLE,
+    packageName: PACKAGE_NAME,
+    prompts: async () => [
+        {
+            key: 'jsdocs.patterns',
+            message: 'Source file patterns (comma-separated)',
+            type: 'input',
+            default: DEFAULT_PATTERNS.join(', '),
+        },
+        {
+            key: 'jsdocs.categories',
+            message: 'Add JSDocs categories?',
+            type: 'confirm',
+            default: true,
+        },
+    ],
+    generateConfig: (answers) => {
+        const options = parseAnswers(answers);
+        return {
+            imports: [
+                { moduleSpecifier: PACKAGE_NAME, defaultImport: 'jsDocsPlugin' },
+            ],
+            pluginInit: formatPluginInit(options.patterns),
+            ...(options.categories ? { categories: [CATEGORY] } : {}),
+        };
+    },
+};
+function parseAnswers(answers) {
+    return {
+        patterns: answerNonEmptyArray(answers, 'jsdocs.patterns', DEFAULT_PATTERNS[0]),
+        categories: answerBoolean(answers, 'jsdocs.categories'),
+    };
+}
+function formatPluginInit([first, ...rest]) {
+    if (rest.length === 0) {
+        return [`jsDocsPlugin(${singleQuote(first)}),`];
+    }
+    return [
+        'jsDocsPlugin([',
+        ...[first, ...rest].map(p => `  ${singleQuote(p)},`),
+        ']),',
+    ];
+}
+//# sourceMappingURL=binding.js.map

package/src/lib/binding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"binding.js","sourceRoot":"","sources":["../../../src/lib/binding.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAM5C,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,WAAW,GACZ,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE3D,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAC3D,oBAAoB,CACkB,CAAC;AAEzC,MAAM,gBAAgB,GAA0B;IAC9C,aAAa;IACb,aAAa;IACb,kBAAkB;CACnB,CAAC;AAEF,MAAM,QAAQ,GAAmB;IAC/B,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,eAAe;IACtB,WAAW,EAAE,mDAAmD;IAChE,IAAI,EAAE;QACJ;YACE,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,WAAW;YACnB,IAAI,EAAE,wBAAwB;YAC9B,MAAM,EAAE,CAAC;SACV;KACF;CACF,CAAC;AAOF,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,IAAI,EAAE,WAAW;IACjB,KAAK,EAAE,YAAY;IACnB,WAAW,EAAE,YAAY;IACzB,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC;QACnB;YACE,GAAG,EAAE,iBAAiB;YACtB,OAAO,EAAE,wCAAwC;YACjD,IAAI,EAAE,OAAO;YACb,OAAO,EAAE,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC;SACrC;QACD;YACE,GAAG,EAAE,mBAAmB;YACxB,OAAO,EAAE,wBAAwB;YACjC,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;SACd;KACF;IACD,cAAc,EAAE,CAAC,OAAqC,EAAE,EAAE;QACxD,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;QACtC,OAAO;YACL,OAAO,EAAE;gBACP,EAAE,eAAe,EAAE,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE;aACjE;YACD,UAAU,EAAE,gBAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC;YAC9C,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC1D,CAAC;IACJ,CAAC;CAC2B,CAAC;AAE/B,SAAS,YAAY,CAAC,OAAqC;IACzD,OAAO;QACL,QAAQ,EAAE,mBAAmB,CAC3B,OAAO,EACP,iBAAiB,EACjB,gBAAgB,CAAC,CAAC,CAAC,CACpB;QACD,UAAU,EAAE,aAAa,CAAC,OAAO,EAAE,mBAAmB,CAAC;KACxD,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,CAAC,KAAK,EAAE,GAAG,IAAI,CAAwB;IAC/D,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,CAAC,gBAAgB,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;IACD,OAAO;QACL,gBAAgB;QAChB,GAAG,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC;QACpD,KAAK;KACN,CAAC;AACJ,CAAC"}