@code-pushup/jsdocs-plugin 0.82.0 → 0.84.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@code-pushup/jsdocs-plugin",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.84.0",
|
|
4
4
|
"description": "Code PushUp plugin for tracking documentation coverage 📚",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://github.com/code-pushup/cli/tree/main/packages/plugin-jsdocs#readme",
|
|
@@ -35,8 +35,8 @@
|
|
|
35
35
|
},
|
|
36
36
|
"type": "module",
|
|
37
37
|
"dependencies": {
|
|
38
|
-
"@code-pushup/models": "0.
|
|
39
|
-
"@code-pushup/utils": "0.
|
|
38
|
+
"@code-pushup/models": "0.84.0",
|
|
39
|
+
"@code-pushup/utils": "0.84.0",
|
|
40
40
|
"zod": "^4.0.5",
|
|
41
41
|
"ts-morph": "^24.0.0"
|
|
42
42
|
},
|
package/src/lib/config.js
CHANGED
|
@@ -2,7 +2,7 @@ import { z } from 'zod';
|
|
|
2
2
|
import { pluginScoreTargetsSchema } from '@code-pushup/models';
|
|
3
3
|
const patternsSchema = z
|
|
4
4
|
.union([z.string(), z.array(z.string()).min(1)])
|
|
5
|
-
.
|
|
5
|
+
.meta({ description: 'Glob pattern to match source files to evaluate.' });
|
|
6
6
|
const jsDocsTargetObjectSchema = z
|
|
7
7
|
.object({
|
|
8
8
|
skipAudits: z
|
|
@@ -24,5 +24,6 @@ export const jsDocsPluginConfigSchema = z
|
|
|
24
24
|
.union([patternsSchema, jsDocsTargetObjectSchema])
|
|
25
25
|
.transform(target => typeof target === 'string' || Array.isArray(target)
|
|
26
26
|
? { patterns: target }
|
|
27
|
-
: target)
|
|
27
|
+
: target)
|
|
28
|
+
.meta({ title: 'JsDocsPluginConfig' });
|
|
28
29
|
//# sourceMappingURL=config.js.map
|
package/src/lib/config.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/lib/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAE/D,MAAM,cAAc,GAAG,CAAC;KACrB,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;KAC/C,
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/lib/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAE/D,MAAM,cAAc,GAAG,CAAC;KACrB,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;KAC/C,IAAI,CAAC,EAAE,WAAW,EAAE,iDAAiD,EAAE,CAAC,CAAC;AAE5E,MAAM,wBAAwB,GAAG,CAAC;KAC/B,MAAM,CAAC;IACN,UAAU,EAAE,CAAC;SACV,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,QAAQ,EAAE;SACV,QAAQ,CACP,4GAA4G,CAC7G;IACH,UAAU,EAAE,CAAC;SACV,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,QAAQ,EAAE;SACV,QAAQ,CACP,uFAAuF,CACxF;IACH,QAAQ,EAAE,cAAc;IACxB,YAAY,EAAE,wBAAwB;CACvC,CAAC;KACD,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE;IACrD,OAAO,EAAE,+DAA+D;IACxE,IAAI,EAAE,CAAC,YAAY,EAAE,YAAY,CAAC;CACnC,CAAC,CAAC;AAEL,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC;KACtC,KAAK,CAAC,CAAC,cAAc,EAAE,wBAAwB,CAAC,CAAC;KACjD,SAAS,CAAC,MAAM,CAAC,EAAE,CAClB,OAAO,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;IACjD,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE;IACtB,CAAC,CAAC,MAAM,CACX;KACA,IAAI,CAAC,EAAE,KAAK,EAAE,oBAAoB,EAAE,CAAC,CAAC"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type
|
|
1
|
+
import { type PluginConfig } from '@code-pushup/models';
|
|
2
2
|
import { type JsDocsPluginConfig } from './config.js';
|
|
3
3
|
export declare const PLUGIN_TITLE = "JSDoc coverage";
|
|
4
4
|
export declare const PLUGIN_DESCRIPTION = "Official Code PushUp JSDoc coverage plugin.";
|
package/src/lib/jsdocs-plugin.js
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { validate } from '@code-pushup/models';
|
|
1
2
|
import { jsDocsPluginConfigSchema } from './config.js';
|
|
2
3
|
import { PLUGIN_SLUG, groups } from './constants.js';
|
|
3
4
|
import { createRunnerFunction } from './runner/runner.js';
|
|
@@ -22,7 +23,7 @@ export const PLUGIN_DOCS_URL = 'https://www.npmjs.com/package/@code-pushup/jsdoc
|
|
|
22
23
|
* @returns Plugin configuration.
|
|
23
24
|
*/
|
|
24
25
|
export function jsDocsPlugin(config) {
|
|
25
|
-
const jsDocsConfig = jsDocsPluginConfigSchema
|
|
26
|
+
const jsDocsConfig = validate(jsDocsPluginConfigSchema, config);
|
|
26
27
|
const scoreTargets = jsDocsConfig.scoreTargets;
|
|
27
28
|
return {
|
|
28
29
|
slug: PLUGIN_SLUG,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"jsdocs-plugin.js","sourceRoot":"","sources":["../../../src/lib/jsdocs-plugin.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"jsdocs-plugin.js","sourceRoot":"","sources":["../../../src/lib/jsdocs-plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,EAA2B,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAChF,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EACL,0BAA0B,EAC1B,wBAAwB,GACzB,MAAM,YAAY,CAAC;AAEpB,MAAM,CAAC,MAAM,YAAY,GAAG,gBAAgB,CAAC;AAE7C,MAAM,CAAC,MAAM,kBAAkB,GAAG,6CAA6C,CAAC;AAEhF,MAAM,CAAC,MAAM,eAAe,GAC1B,2DAA2D,CAAC;AAE9D;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,YAAY,CAAC,MAA0B;IACrD,MAAM,YAAY,GAAG,QAAQ,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;IAChE,MAAM,YAAY,GAAG,YAAY,CAAC,YAAY,CAAC;IAE/C,OAAO;QACL,IAAI,EAAE,WAAW;QACjB,KAAK,EAAE,YAAY;QACnB,IAAI,EAAE,aAAa;QACnB,WAAW,EAAE,kBAAkB;QAC/B,OAAO,EAAE,eAAe;QACxB,MAAM,EAAE,wBAAwB,CAAC,MAAM,EAAE,YAAY,CAAC;QACtD,MAAM,EAAE,0BAA0B,CAAC,YAAY,CAAC;QAChD,MAAM,EAAE,oBAAoB,CAAC,YAAY,CAAC;QAC1C,GAAG,CAAC,YAAY,IAAI,EAAE,YAAY,EAAE,CAAC;KACtC,CAAC;AACJ,CAAC"}
|