@code-pushup/jsdocs-plugin 0.78.0 → 0.79.1

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.
Files changed (6) hide show
  1. package/package.json +3 -3
  2. package/src/lib/config.d.ts +3 -0
  3. package/src/lib/config.js +2 -0
  4. package/src/lib/config.js.map +1 -1
  5. package/src/lib/jsdocs-plugin.js +2 -0
  6. package/src/lib/jsdocs-plugin.js.map +1 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@code-pushup/jsdocs-plugin",
3
- "version": "0.78.0",
3
+ "version": "0.79.1",
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.78.0",
39
- "@code-pushup/utils": "0.78.0",
38
+ "@code-pushup/models": "0.79.1",
39
+ "@code-pushup/utils": "0.79.1",
40
40
  "zod": "^4.0.5",
41
41
  "ts-morph": "^24.0.0"
42
42
  },
package/src/lib/config.d.ts CHANGED
@@ -3,14 +3,17 @@ export declare const jsDocsPluginConfigSchema: z.ZodPipe<z.ZodUnion<readonly [z.
3
3
  skipAudits: z.ZodOptional<z.ZodArray<z.ZodString>>;
4
4
  onlyAudits: z.ZodOptional<z.ZodArray<z.ZodString>>;
5
5
  patterns: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
6
+ scoreTargets: z.ZodOptional<z.ZodUnion<readonly [z.ZodOptional<z.ZodNumber>, z.ZodRecord<z.ZodString, z.ZodNonOptional<z.ZodOptional<z.ZodNumber>>>]>>;
6
7
  }, z.core.$strip>]>, z.ZodTransform<{
7
8
  patterns: string | string[];
8
9
  skipAudits?: string[] | undefined;
9
10
  onlyAudits?: string[] | undefined;
11
+ scoreTargets?: number | Record<string, number> | undefined;
10
12
  }, string | string[] | {
11
13
  patterns: string | string[];
12
14
  skipAudits?: string[] | undefined;
13
15
  onlyAudits?: string[] | undefined;
16
+ scoreTargets?: number | Record<string, number> | undefined;
14
17
  }>>;
15
18
  /** Type of the config that is passed to the plugin */
16
19
  export type JsDocsPluginConfig = z.input<typeof jsDocsPluginConfigSchema>;
package/src/lib/config.js CHANGED
@@ -1,4 +1,5 @@
1
1
  import { z } from 'zod';
2
+ import { pluginScoreTargetsSchema } from '@code-pushup/models';
2
3
  const patternsSchema = z
3
4
  .union([z.string(), z.array(z.string()).min(1)])
4
5
  .describe('Glob pattern to match source files to evaluate.');
@@ -13,6 +14,7 @@ const jsDocsTargetObjectSchema = z
13
14
  .optional()
14
15
  .describe('List of audit slugs to evaluate. When specified, only these audits will be evaluated.'),
15
16
  patterns: patternsSchema,
17
+ scoreTargets: pluginScoreTargetsSchema,
16
18
  })
17
19
  .refine(data => !(data.skipAudits && data.onlyAudits), {
18
20
  message: "You can't define 'skipAudits' and 'onlyAudits' simultaneously",
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;AAExB,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,QAAQ,CAAC,iDAAiD,CAAC,CAAC;AAE/D,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;CACzB,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,CAAC"}
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,QAAQ,CAAC,iDAAiD,CAAC,CAAC;AAE/D,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,CAAC"}
package/src/lib/jsdocs-plugin.js CHANGED
@@ -23,6 +23,7 @@ export const PLUGIN_DOCS_URL = 'https://www.npmjs.com/package/@code-pushup/jsdoc
23
23
  */
24
24
  export function jsDocsPlugin(config) {
25
25
  const jsDocsConfig = jsDocsPluginConfigSchema.parse(config);
26
+ const scoreTargets = jsDocsConfig.scoreTargets;
26
27
  return {
27
28
  slug: PLUGIN_SLUG,
28
29
  title: PLUGIN_TITLE,
@@ -32,6 +33,7 @@ export function jsDocsPlugin(config) {
32
33
  groups: filterGroupsByOnlyAudits(groups, jsDocsConfig),
33
34
  audits: filterAuditsByPluginConfig(jsDocsConfig),
34
35
  runner: createRunnerFunction(jsDocsConfig),
36
+ ...(scoreTargets && { scoreTargets }),
35
37
  };
36
38
  }
37
39
  //# sourceMappingURL=jsdocs-plugin.js.map
package/src/lib/jsdocs-plugin.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"jsdocs-plugin.js","sourceRoot":"","sources":["../../../src/lib/jsdocs-plugin.ts"],"names":[],"mappings":"AACA,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,wBAAwB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5D,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;KAC3C,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"jsdocs-plugin.js","sourceRoot":"","sources":["../../../src/lib/jsdocs-plugin.ts"],"names":[],"mappings":"AACA,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,wBAAwB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5D,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"}