@code-pushup/jsdocs-plugin 0.69.5 → 0.71.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.
Files changed (4) hide show
  1. package/package.json +4 -4
  2. package/src/lib/config.d.ts +6 -22
  3. package/src/lib/config.js +3 -3
  4. package/src/lib/config.js.map +1 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@code-pushup/jsdocs-plugin",
3
- "version": "0.69.5",
3
+ "version": "0.71.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,9 +35,9 @@
35
35
  },
36
36
  "type": "module",
37
37
  "dependencies": {
38
- "@code-pushup/models": "0.69.5",
39
- "@code-pushup/utils": "0.69.5",
40
- "zod": "^3.22.4",
38
+ "@code-pushup/models": "0.71.0",
39
+ "@code-pushup/utils": "0.71.0",
40
+ "zod": "^4.0.5",
41
41
  "ts-morph": "^24.0.0"
42
42
  },
43
43
  "module": "./src/index.js",
package/src/lib/config.d.ts CHANGED
@@ -1,25 +1,9 @@
1
1
  import { z } from 'zod';
2
- export declare const jsDocsPluginConfigSchema: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>, z.ZodEffects<z.ZodObject<{
3
- skipAudits: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
4
- onlyAudits: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
5
- patterns: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
6
- }, "strip", z.ZodTypeAny, {
7
- patterns: string | string[];
8
- skipAudits?: string[] | undefined;
9
- onlyAudits?: string[] | undefined;
10
- }, {
11
- patterns: string | string[];
12
- skipAudits?: string[] | undefined;
13
- onlyAudits?: string[] | undefined;
14
- }>, {
15
- patterns: string | string[];
16
- skipAudits?: string[] | undefined;
17
- onlyAudits?: string[] | undefined;
18
- }, {
19
- patterns: string | string[];
20
- skipAudits?: string[] | undefined;
21
- onlyAudits?: string[] | undefined;
22
- }>]>, {
2
+ export declare const jsDocsPluginConfigSchema: z.ZodPipe<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodObject<{
3
+ skipAudits: z.ZodOptional<z.ZodArray<z.ZodString>>;
4
+ onlyAudits: z.ZodOptional<z.ZodArray<z.ZodString>>;
5
+ patterns: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
6
+ }, z.core.$strip>]>, z.ZodTransform<{
23
7
  patterns: string | string[];
24
8
  skipAudits?: string[] | undefined;
25
9
  onlyAudits?: string[] | undefined;
@@ -27,7 +11,7 @@ export declare const jsDocsPluginConfigSchema: z.ZodEffects<z.ZodUnion<[z.ZodUni
27
11
  patterns: string | string[];
28
12
  skipAudits?: string[] | undefined;
29
13
  onlyAudits?: string[] | undefined;
30
- }>;
14
+ }>>;
31
15
  /** Type of the config that is passed to the plugin */
32
16
  export type JsDocsPluginConfig = z.input<typeof jsDocsPluginConfigSchema>;
33
17
  /** Same as JsDocsPluginConfig but processed so the config is already an object even if it was passed the array of patterns */
package/src/lib/config.js CHANGED
@@ -1,7 +1,7 @@
1
1
  import { z } from 'zod';
2
- const patternsSchema = z.union([z.string(), z.array(z.string()).min(1)], {
3
- description: 'Glob pattern to match source files to evaluate.',
4
- });
2
+ const patternsSchema = z
3
+ .union([z.string(), z.array(z.string()).min(1)])
4
+ .describe('Glob pattern to match source files to evaluate.');
5
5
  const jsDocsTargetObjectSchema = z
6
6
  .object({
7
7
  skipAudits: z
package/src/lib/config.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"config.js","sourceRoot":"","sources":["../../../../../packages/plugin-jsdocs/src/lib/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE;IACvE,WAAW,EAAE,iDAAiD;CAC/D,CAAC,CAAC;AAEH,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":["../../../../../packages/plugin-jsdocs/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"}