@code-pushup/models 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.
Files changed (50) hide show
  1. package/README.md +2 -2
  2. package/package.json +4 -3
  3. package/src/index.d.ts +1 -0
  4. package/src/index.js +1 -0
  5. package/src/index.js.map +1 -1
  6. package/src/lib/audit-output.js +22 -8
  7. package/src/lib/audit-output.js.map +1 -1
  8. package/src/lib/audit.js +7 -3
  9. package/src/lib/audit.js.map +1 -1
  10. package/src/lib/cache-config.js +14 -7
  11. package/src/lib/cache-config.js.map +1 -1
  12. package/src/lib/category-config.js +13 -7
  13. package/src/lib/category-config.js.map +1 -1
  14. package/src/lib/commit.js +10 -5
  15. package/src/lib/commit.js.map +1 -1
  16. package/src/lib/configuration.js +14 -7
  17. package/src/lib/configuration.js.map +1 -1
  18. package/src/lib/core-config.d.ts +3 -3
  19. package/src/lib/core-config.js +1 -1
  20. package/src/lib/core-config.js.map +1 -1
  21. package/src/lib/group.js +9 -4
  22. package/src/lib/group.js.map +1 -1
  23. package/src/lib/implementation/schemas.d.ts +1 -1
  24. package/src/lib/implementation/schemas.js +77 -47
  25. package/src/lib/implementation/schemas.js.map +1 -1
  26. package/src/lib/implementation/validate.d.ts +30 -0
  27. package/src/lib/implementation/validate.js +34 -0
  28. package/src/lib/implementation/validate.js.map +1 -0
  29. package/src/lib/issue.js +9 -5
  30. package/src/lib/issue.js.map +1 -1
  31. package/src/lib/persist-config.js +9 -5
  32. package/src/lib/persist-config.js.map +1 -1
  33. package/src/lib/plugin-config.d.ts +2 -2
  34. package/src/lib/plugin-config.js +20 -8
  35. package/src/lib/plugin-config.js.map +1 -1
  36. package/src/lib/report.d.ts +2 -2
  37. package/src/lib/report.js +14 -5
  38. package/src/lib/report.js.map +1 -1
  39. package/src/lib/reports-diff.js +34 -22
  40. package/src/lib/reports-diff.js.map +1 -1
  41. package/src/lib/runner-config.js +32 -12
  42. package/src/lib/runner-config.js.map +1 -1
  43. package/src/lib/source.js +7 -2
  44. package/src/lib/source.js.map +1 -1
  45. package/src/lib/table.js +26 -13
  46. package/src/lib/table.js.map +1 -1
  47. package/src/lib/tree.js +51 -30
  48. package/src/lib/tree.js.map +1 -1
  49. package/src/lib/upload-config.js +15 -9
  50. package/src/lib/upload-config.js.map +1 -1
package/README.md CHANGED
@@ -65,8 +65,8 @@ Import the type definitions if using TypeScript:
65
65
  If you need runtime validation, use the underlying Zod schemas:
66
66
 
67
67
  ```ts
68
- import { coreConfigSchema } from '@code-pushup/models';
68
+ import { coreConfigSchema, validate } from '@code-pushup/models';
69
69
 
70
70
  const json = JSON.parse(readFileSync('code-pushup.config.json'));
71
- const config = coreConfigSchema.parse(json); // throws ZodError if invalid
71
+ const config = validate(coreConfigSchema, json); // throws SchemaValidationError if invalid
72
72
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@code-pushup/models",
3
- "version": "0.82.0",
3
+ "version": "0.84.0",
4
4
  "license": "MIT",
5
5
  "description": "Model definitions and validators for the Code PushUp CLI",
6
6
  "homepage": "https://github.com/code-pushup/cli/tree/main/packages/models#readme",
@@ -27,8 +27,9 @@
27
27
  },
28
28
  "type": "module",
29
29
  "dependencies": {
30
- "zod": "^4.0.5",
31
- "vscode-material-icons": "^0.1.0"
30
+ "ansis": "^3.3.2",
31
+ "vscode-material-icons": "^0.1.0",
32
+ "zod": "^4.0.5"
32
33
  },
33
34
  "files": [
34
35
  "src",
package/src/index.d.ts CHANGED
@@ -13,6 +13,7 @@ export { DEFAULT_PERSIST_CONFIG, DEFAULT_PERSIST_FILENAME, DEFAULT_PERSIST_FORMA
13
13
  export { MAX_DESCRIPTION_LENGTH, MAX_ISSUE_MESSAGE_LENGTH, MAX_SLUG_LENGTH, MAX_TITLE_LENGTH, } from './lib/implementation/limits.js';
14
14
  export { fileNameSchema, filePathSchema, globPathSchema, materialIconSchema, scoreSchema, slugSchema, type MaterialIcon, } from './lib/implementation/schemas.js';
15
15
  export { exists } from './lib/implementation/utils.js';
16
+ export { SchemaValidationError, validate, validateAsync, } from './lib/implementation/validate.js';
16
17
  export { issueSchema, issueSeveritySchema, type Issue, type IssueSeverity, } from './lib/issue.js';
17
18
  export { formatSchema, persistConfigSchema, type Format, type PersistConfig, } from './lib/persist-config.js';
18
19
  export { pluginConfigSchema, pluginContextSchema, pluginMetaSchema, pluginScoreTargetsSchema, type PluginConfig, type PluginContext, type PluginMeta, type PluginScoreTargets, } from './lib/plugin-config.js';
package/src/index.js CHANGED
@@ -13,6 +13,7 @@ export { DEFAULT_PERSIST_CONFIG, DEFAULT_PERSIST_FILENAME, DEFAULT_PERSIST_FORMA
13
13
  export { MAX_DESCRIPTION_LENGTH, MAX_ISSUE_MESSAGE_LENGTH, MAX_SLUG_LENGTH, MAX_TITLE_LENGTH, } from './lib/implementation/limits.js';
14
14
  export { fileNameSchema, filePathSchema, globPathSchema, materialIconSchema, scoreSchema, slugSchema, } from './lib/implementation/schemas.js';
15
15
  export { exists } from './lib/implementation/utils.js';
16
+ export { SchemaValidationError, validate, validateAsync, } from './lib/implementation/validate.js';
16
17
  export { issueSchema, issueSeveritySchema, } from './lib/issue.js';
17
18
  export { formatSchema, persistConfigSchema, } from './lib/persist-config.js';
18
19
  export { pluginConfigSchema, pluginContextSchema, pluginMetaSchema, pluginScoreTargetsSchema, } from './lib/plugin-config.js';
package/src/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,GAErB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,wBAAwB,GAEzB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,GAInB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAc,MAAM,gBAAgB,CAAC;AACzD,OAAO,EACL,uBAAuB,EACvB,iBAAiB,EACjB,0BAA0B,GAI3B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,oBAAoB,EACpB,iBAAiB,GAGlB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,YAAY,EAAe,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EACL,+BAA+B,EAC/B,2BAA2B,GAE5B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,gBAAgB,EAAmB,MAAM,sBAAsB,CAAC;AACzE,OAAO,EACL,cAAc,EACd,WAAW,GAIZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,gBAAgB,EAChB,6BAA6B,GAC9B,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,sBAAsB,EACtB,0BAA0B,EAC1B,2BAA2B,GAC5B,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,eAAe,EACf,gBAAgB,GACjB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,cAAc,EACd,cAAc,EACd,cAAc,EACd,kBAAkB,EAClB,WAAW,EACX,UAAU,GAEX,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACvD,OAAO,EACL,WAAW,EACX,mBAAmB,GAGpB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,YAAY,EACZ,mBAAmB,GAGpB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,wBAAwB,GAKzB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,YAAY,GAIb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,eAAe,EACf,iBAAiB,EACjB,iBAAiB,GAQlB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,sBAAsB,EACtB,oBAAoB,GAKrB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,oBAAoB,EACpB,uBAAuB,EACvB,0BAA0B,EAC1B,oBAAoB,EACpB,uBAAuB,EACvB,WAAW,GAOZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,mBAAmB,EACnB,eAAe,EACf,4BAA4B,EAC5B,sBAAsB,EACtB,kBAAkB,EAClB,UAAU,GAOX,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,kBAAkB,EAAqB,MAAM,wBAAwB,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,GAErB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,wBAAwB,GAEzB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,GAInB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAc,MAAM,gBAAgB,CAAC;AACzD,OAAO,EACL,uBAAuB,EACvB,iBAAiB,EACjB,0BAA0B,GAI3B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,oBAAoB,EACpB,iBAAiB,GAGlB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,YAAY,EAAe,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EACL,+BAA+B,EAC/B,2BAA2B,GAE5B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,gBAAgB,EAAmB,MAAM,sBAAsB,CAAC;AACzE,OAAO,EACL,cAAc,EACd,WAAW,GAIZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,gBAAgB,EAChB,6BAA6B,GAC9B,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,sBAAsB,EACtB,0BAA0B,EAC1B,2BAA2B,GAC5B,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,eAAe,EACf,gBAAgB,GACjB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,cAAc,EACd,cAAc,EACd,cAAc,EACd,kBAAkB,EAClB,WAAW,EACX,UAAU,GAEX,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACvD,OAAO,EACL,qBAAqB,EACrB,QAAQ,EACR,aAAa,GACd,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,WAAW,EACX,mBAAmB,GAGpB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,YAAY,EACZ,mBAAmB,GAGpB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,wBAAwB,GAKzB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,YAAY,GAIb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,eAAe,EACf,iBAAiB,EACjB,iBAAiB,GAQlB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,sBAAsB,EACtB,oBAAoB,GAKrB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,oBAAoB,EACpB,uBAAuB,EACvB,0BAA0B,EAC1B,oBAAoB,EACpB,uBAAuB,EACvB,WAAW,GAOZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,mBAAmB,EACnB,eAAe,EACf,4BAA4B,EAC5B,sBAAsB,EACtB,kBAAkB,EAClB,UAAU,GAOX,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,kBAAkB,EAAqB,MAAM,wBAAwB,CAAC"}
@@ -4,33 +4,47 @@ import { nonnegativeNumberSchema, scoreSchema, scoreTargetSchema, slugSchema, }
4
4
  import { issueSchema } from './issue.js';
5
5
  import { tableSchema } from './table.js';
6
6
  import { treeSchema } from './tree.js';
7
- export const auditValueSchema = nonnegativeNumberSchema.describe('Raw numeric value');
7
+ export const auditValueSchema = nonnegativeNumberSchema.meta({
8
+ description: 'Raw numeric value',
9
+ });
8
10
  export const auditDisplayValueSchema = z
9
11
  .string()
10
12
  .optional()
11
- .describe("Formatted value (e.g. '0.9 s', '2.1 MB')");
13
+ .meta({ description: "Formatted value (e.g. '0.9 s', '2.1 MB')" });
12
14
  export const auditDetailsSchema = z
13
15
  .object({
14
- issues: z.array(issueSchema).describe('List of findings').optional(),
16
+ issues: z
17
+ .array(issueSchema)
18
+ .meta({ description: 'List of findings' })
19
+ .optional(),
15
20
  table: tableSchema('Table of related findings').optional(),
16
21
  trees: z
17
22
  .array(treeSchema)
18
- .describe('Findings in tree structure')
23
+ .meta({ description: 'Findings in tree structure' })
19
24
  .optional(),
20
25
  })
21
- .describe('Detailed information');
26
+ .meta({
27
+ title: 'AuditDetails',
28
+ description: 'Detailed information',
29
+ });
22
30
  export const auditOutputSchema = z
23
31
  .object({
24
- slug: slugSchema.describe('Reference to audit'),
32
+ slug: slugSchema.meta({ description: 'Reference to audit' }),
25
33
  displayValue: auditDisplayValueSchema,
26
34
  value: auditValueSchema,
27
35
  score: scoreSchema,
28
36
  scoreTarget: scoreTargetSchema,
29
37
  details: auditDetailsSchema.optional(),
30
38
  })
31
- .describe('Audit information');
39
+ .meta({
40
+ title: 'AuditOutput',
41
+ description: 'Audit information',
42
+ });
32
43
  export const auditOutputsSchema = z
33
44
  .array(auditOutputSchema)
34
45
  .check(createDuplicateSlugsCheck('Audit'))
35
- .describe('List of JSON formatted audit output emitted by the runner process of a plugin');
46
+ .meta({
47
+ title: 'AuditOutputs',
48
+ description: 'List of JSON formatted audit output emitted by the runner process of a plugin',
49
+ });
36
50
  //# sourceMappingURL=audit-output.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"audit-output.js","sourceRoot":"","sources":["../../../src/lib/audit-output.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AACvE,OAAO,EACL,uBAAuB,EACvB,WAAW,EACX,iBAAiB,EACjB,UAAU,GACX,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAEvC,MAAM,CAAC,MAAM,gBAAgB,GAC3B,uBAAuB,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;AACxD,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC;KACrC,MAAM,EAAE;KACR,QAAQ,EAAE;KACV,QAAQ,CAAC,0CAA0C,CAAC,CAAC;AAExD,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC;KAChC,MAAM,CAAC;IACN,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,QAAQ,EAAE;IACpE,KAAK,EAAE,WAAW,CAAC,2BAA2B,CAAC,CAAC,QAAQ,EAAE;IAC1D,KAAK,EAAE,CAAC;SACL,KAAK,CAAC,UAAU,CAAC;SACjB,QAAQ,CAAC,4BAA4B,CAAC;SACtC,QAAQ,EAAE;CACd,CAAC;KACD,QAAQ,CAAC,sBAAsB,CAAC,CAAC;AAGpC,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,MAAM,CAAC;IACN,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,oBAAoB,CAAC;IAC/C,YAAY,EAAE,uBAAuB;IACrC,KAAK,EAAE,gBAAgB;IACvB,KAAK,EAAE,WAAW;IAClB,WAAW,EAAE,iBAAiB;IAC9B,OAAO,EAAE,kBAAkB,CAAC,QAAQ,EAAE;CACvC,CAAC;KACD,QAAQ,CAAC,mBAAmB,CAAC,CAAC;AAIjC,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC;KAChC,KAAK,CAAC,iBAAiB,CAAC;KACxB,KAAK,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;KACzC,QAAQ,CACP,+EAA+E,CAChF,CAAC"}
1
+ {"version":3,"file":"audit-output.js","sourceRoot":"","sources":["../../../src/lib/audit-output.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AACvE,OAAO,EACL,uBAAuB,EACvB,WAAW,EACX,iBAAiB,EACjB,UAAU,GACX,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAEvC,MAAM,CAAC,MAAM,gBAAgB,GAAG,uBAAuB,CAAC,IAAI,CAAC;IAC3D,WAAW,EAAE,mBAAmB;CACjC,CAAC,CAAC;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC;KACrC,MAAM,EAAE;KACR,QAAQ,EAAE;KACV,IAAI,CAAC,EAAE,WAAW,EAAE,0CAA0C,EAAE,CAAC,CAAC;AAErE,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC;KAChC,MAAM,CAAC;IACN,MAAM,EAAE,CAAC;SACN,KAAK,CAAC,WAAW,CAAC;SAClB,IAAI,CAAC,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC;SACzC,QAAQ,EAAE;IACb,KAAK,EAAE,WAAW,CAAC,2BAA2B,CAAC,CAAC,QAAQ,EAAE;IAC1D,KAAK,EAAE,CAAC;SACL,KAAK,CAAC,UAAU,CAAC;SACjB,IAAI,CAAC,EAAE,WAAW,EAAE,4BAA4B,EAAE,CAAC;SACnD,QAAQ,EAAE;CACd,CAAC;KACD,IAAI,CAAC;IACJ,KAAK,EAAE,cAAc;IACrB,WAAW,EAAE,sBAAsB;CACpC,CAAC,CAAC;AAGL,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,MAAM,CAAC;IACN,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,oBAAoB,EAAE,CAAC;IAC5D,YAAY,EAAE,uBAAuB;IACrC,KAAK,EAAE,gBAAgB;IACvB,KAAK,EAAE,WAAW;IAClB,WAAW,EAAE,iBAAiB;IAC9B,OAAO,EAAE,kBAAkB,CAAC,QAAQ,EAAE;CACvC,CAAC;KACD,IAAI,CAAC;IACJ,KAAK,EAAE,aAAa;IACpB,WAAW,EAAE,mBAAmB;CACjC,CAAC,CAAC;AAIL,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC;KAChC,KAAK,CAAC,iBAAiB,CAAC;KACxB,KAAK,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;KACzC,IAAI,CAAC;IACJ,KAAK,EAAE,cAAc;IACrB,WAAW,EACT,+EAA+E;CAClF,CAAC,CAAC"}
package/src/lib/audit.js CHANGED
@@ -3,7 +3,7 @@ import { createDuplicateSlugsCheck } from './implementation/checks.js';
3
3
  import { metaSchema, slugSchema } from './implementation/schemas.js';
4
4
  export const auditSchema = z
5
5
  .object({
6
- slug: slugSchema.describe('ID (unique within plugin)'),
6
+ slug: slugSchema.meta({ description: 'ID (unique within plugin)' }),
7
7
  })
8
8
  .extend(metaSchema({
9
9
  titleDescription: 'Descriptive name',
@@ -11,10 +11,14 @@ export const auditSchema = z
11
11
  docsUrlDescription: 'Link to documentation (rationale)',
12
12
  description: 'List of scorable metrics for the given plugin',
13
13
  isSkippedDescription: 'Indicates whether the audit is skipped',
14
- }).shape);
14
+ }).shape)
15
+ .meta({ title: 'Audit' });
15
16
  export const pluginAuditsSchema = z
16
17
  .array(auditSchema)
17
18
  .min(1)
18
19
  .check(createDuplicateSlugsCheck('Audit'))
19
- .describe('List of audits maintained in a plugin');
20
+ .meta({
21
+ title: 'PluginAudits',
22
+ description: 'List of audits maintained in a plugin',
23
+ });
20
24
  //# sourceMappingURL=audit.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"audit.js","sourceRoot":"","sources":["../../../src/lib/audit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AACvE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAErE,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC;KACzB,MAAM,CAAC;IACN,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,2BAA2B,CAAC;CACvD,CAAC;KACD,MAAM,CACL,UAAU,CAAC;IACT,gBAAgB,EAAE,kBAAkB;IACpC,sBAAsB,EAAE,wBAAwB;IAChD,kBAAkB,EAAE,mCAAmC;IACvD,WAAW,EAAE,+CAA+C;IAC5D,oBAAoB,EAAE,wCAAwC;CAC/D,CAAC,CAAC,KAAK,CACT,CAAC;AAGJ,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC;KAChC,KAAK,CAAC,WAAW,CAAC;KAClB,GAAG,CAAC,CAAC,CAAC;KACN,KAAK,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;KACzC,QAAQ,CAAC,uCAAuC,CAAC,CAAC"}
1
+ {"version":3,"file":"audit.js","sourceRoot":"","sources":["../../../src/lib/audit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AACvE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAErE,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC;KACzB,MAAM,CAAC;IACN,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,2BAA2B,EAAE,CAAC;CACpE,CAAC;KACD,MAAM,CACL,UAAU,CAAC;IACT,gBAAgB,EAAE,kBAAkB;IACpC,sBAAsB,EAAE,wBAAwB;IAChD,kBAAkB,EAAE,mCAAmC;IACvD,WAAW,EAAE,+CAA+C;IAC5D,oBAAoB,EAAE,wCAAwC;CAC/D,CAAC,CAAC,KAAK,CACT;KACA,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;AAG5B,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC;KAChC,KAAK,CAAC,WAAW,CAAC;KAClB,GAAG,CAAC,CAAC,CAAC;KACN,KAAK,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;KACzC,IAAI,CAAC;IACJ,KAAK,EAAE,cAAc;IACrB,WAAW,EAAE,uCAAuC;CACrD,CAAC,CAAC"}
@@ -3,19 +3,26 @@ export const cacheConfigObjectSchema = z
3
3
  .object({
4
4
  read: z
5
5
  .boolean()
6
- .describe('Whether to read from cache if available')
6
+ .meta({ description: 'Whether to read from cache if available' })
7
7
  .default(false),
8
8
  write: z
9
9
  .boolean()
10
- .describe('Whether to write results to cache')
10
+ .meta({ description: 'Whether to write results to cache' })
11
11
  .default(false),
12
12
  })
13
- .describe('Cache configuration object for read and/or write operations');
14
- export const cacheConfigShorthandSchema = z
15
- .boolean()
16
- .describe('Cache configuration shorthand for both, read and write operations');
13
+ .meta({
14
+ title: 'CacheConfigObject',
15
+ description: 'Cache configuration object for read and/or write operations',
16
+ });
17
+ export const cacheConfigShorthandSchema = z.boolean().meta({
18
+ title: 'CacheConfigShorthand',
19
+ description: 'Cache configuration shorthand for both, read and write operations',
20
+ });
17
21
  export const cacheConfigSchema = z
18
22
  .union([cacheConfigShorthandSchema, cacheConfigObjectSchema])
19
- .describe('Cache configuration for read and write operations')
23
+ .meta({
24
+ title: 'CacheConfig',
25
+ description: 'Cache configuration for read and write operations',
26
+ })
20
27
  .default(false);
21
28
  //# sourceMappingURL=cache-config.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"cache-config.js","sourceRoot":"","sources":["../../../src/lib/cache-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC;KACrC,MAAM,CAAC;IACN,IAAI,EAAE,CAAC;SACJ,OAAO,EAAE;SACT,QAAQ,CAAC,yCAAyC,CAAC;SACnD,OAAO,CAAC,KAAK,CAAC;IACjB,KAAK,EAAE,CAAC;SACL,OAAO,EAAE;SACT,QAAQ,CAAC,mCAAmC,CAAC;SAC7C,OAAO,CAAC,KAAK,CAAC;CAClB,CAAC;KACD,QAAQ,CAAC,6DAA6D,CAAC,CAAC;AAG3E,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC;KACxC,OAAO,EAAE;KACT,QAAQ,CACP,mEAAmE,CACpE,CAAC;AAGJ,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,KAAK,CAAC,CAAC,0BAA0B,EAAE,uBAAuB,CAAC,CAAC;KAC5D,QAAQ,CAAC,mDAAmD,CAAC;KAC7D,OAAO,CAAC,KAAK,CAAC,CAAC"}
1
+ {"version":3,"file":"cache-config.js","sourceRoot":"","sources":["../../../src/lib/cache-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC;KACrC,MAAM,CAAC;IACN,IAAI,EAAE,CAAC;SACJ,OAAO,EAAE;SACT,IAAI,CAAC,EAAE,WAAW,EAAE,yCAAyC,EAAE,CAAC;SAChE,OAAO,CAAC,KAAK,CAAC;IACjB,KAAK,EAAE,CAAC;SACL,OAAO,EAAE;SACT,IAAI,CAAC,EAAE,WAAW,EAAE,mCAAmC,EAAE,CAAC;SAC1D,OAAO,CAAC,KAAK,CAAC;CAClB,CAAC;KACD,IAAI,CAAC;IACJ,KAAK,EAAE,mBAAmB;IAC1B,WAAW,EAAE,6DAA6D;CAC3E,CAAC,CAAC;AAGL,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC;IACzD,KAAK,EAAE,sBAAsB;IAC7B,WAAW,EACT,mEAAmE;CACtE,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,KAAK,CAAC,CAAC,0BAA0B,EAAE,uBAAuB,CAAC,CAAC;KAC5D,IAAI,CAAC;IACJ,KAAK,EAAE,aAAa;IACpB,WAAW,EAAE,mDAAmD;CACjE,CAAC;KACD,OAAO,CAAC,KAAK,CAAC,CAAC"}
@@ -2,12 +2,14 @@ import { z } from 'zod';
2
2
  import { createDuplicateSlugsCheck, createDuplicatesCheck, } from './implementation/checks.js';
3
3
  import { metaSchema, scorableSchema, scoreTargetSchema, slugSchema, weightedRefSchema, } from './implementation/schemas.js';
4
4
  import { formatRef } from './implementation/utils.js';
5
- export const categoryRefSchema = weightedRefSchema('Weighted references to audits and/or groups for the category', 'Slug of an audit or group (depending on `type`)').extend({
6
- type: z
7
- .enum(['audit', 'group'])
8
- .describe('Discriminant for reference kind, affects where `slug` is looked up'),
5
+ export const categoryRefSchema = weightedRefSchema('Weighted references to audits and/or groups for the category', 'Slug of an audit or group (depending on `type`)')
6
+ .extend({
7
+ type: z.enum(['audit', 'group']).meta({
8
+ description: 'Discriminant for reference kind, affects where `slug` is looked up',
9
+ }),
9
10
  plugin: slugSchema.describe('Plugin slug (plugin should contain referenced audit or group)'),
10
- });
11
+ })
12
+ .meta({ title: 'CategoryRef' });
11
13
  export const categoryConfigSchema = scorableSchema('Category with a score calculated from audits and groups from various plugins', categoryRefSchema, createDuplicatesCheck(serializeCategoryRefTarget, duplicates => `Category has duplicate references: ${formatSerializedCategoryRefTargets(duplicates)}`))
12
14
  .extend(metaSchema({
13
15
  titleDescription: 'Category Title',
@@ -15,7 +17,8 @@ export const categoryConfigSchema = scorableSchema('Category with a score calcul
15
17
  descriptionDescription: 'Category description',
16
18
  description: 'Meta info for category',
17
19
  }).shape)
18
- .extend({ scoreTarget: scoreTargetSchema });
20
+ .extend({ scoreTarget: scoreTargetSchema })
21
+ .meta({ title: 'CategoryConfig' });
19
22
  const CATEGORY_REF_SEP = '||';
20
23
  function serializeCategoryRefTarget(ref) {
21
24
  return [ref.type, ref.plugin, ref.slug].join(CATEGORY_REF_SEP);
@@ -31,5 +34,8 @@ function formatSerializedCategoryRefTargets(keys) {
31
34
  export const categoriesSchema = z
32
35
  .array(categoryConfigSchema)
33
36
  .check(createDuplicateSlugsCheck('Category'))
34
- .describe('Categorization of individual audits');
37
+ .meta({
38
+ title: 'Categories',
39
+ description: 'Categorization of individual audits',
40
+ });
35
41
  //# sourceMappingURL=category-config.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"category-config.js","sourceRoot":"","sources":["../../../src/lib/category-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,yBAAyB,EACzB,qBAAqB,GACtB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,UAAU,EACV,cAAc,EACd,iBAAiB,EACjB,UAAU,EACV,iBAAiB,GAClB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAEtD,MAAM,CAAC,MAAM,iBAAiB,GAAG,iBAAiB,CAChD,8DAA8D,EAC9D,iDAAiD,CAClD,CAAC,MAAM,CAAC;IACP,IAAI,EAAE,CAAC;SACJ,IAAI,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;SACxB,QAAQ,CACP,oEAAoE,CACrE;IACH,MAAM,EAAE,UAAU,CAAC,QAAQ,CACzB,+DAA+D,CAChE;CACF,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,oBAAoB,GAAG,cAAc,CAChD,8EAA8E,EAC9E,iBAAiB,EACjB,qBAAqB,CACnB,0BAA0B,EAC1B,UAAU,CAAC,EAAE,CACX,sCAAsC,kCAAkC,CAAC,UAAU,CAAC,EAAE,CACzF,CACF;KACE,MAAM,CACL,UAAU,CAAC;IACT,gBAAgB,EAAE,gBAAgB;IAClC,kBAAkB,EAAE,mBAAmB;IACvC,sBAAsB,EAAE,sBAAsB;IAC9C,WAAW,EAAE,wBAAwB;CACtC,CAAC,CAAC,KAAK,CACT;KACA,MAAM,CAAC,EAAE,WAAW,EAAE,iBAAiB,EAAE,CAAC,CAAC;AAI9C,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAE9B,SAAS,0BAA0B,CAAC,GAAgB;IAClD,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;AACjE,CAAC;AAED,SAAS,kCAAkC,CAAC,IAAc;IACxD,OAAO,IAAI;SACR,GAAG,CAAC,GAAG,CAAC,EAAE;QACT,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,gBAAgB,CAItD,CAAC;QACF,OAAO,SAAS,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3C,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC;KAC9B,KAAK,CAAC,oBAAoB,CAAC;KAC3B,KAAK,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC;KAC5C,QAAQ,CAAC,qCAAqC,CAAC,CAAC"}
1
+ {"version":3,"file":"category-config.js","sourceRoot":"","sources":["../../../src/lib/category-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,yBAAyB,EACzB,qBAAqB,GACtB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,UAAU,EACV,cAAc,EACd,iBAAiB,EACjB,UAAU,EACV,iBAAiB,GAClB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAEtD,MAAM,CAAC,MAAM,iBAAiB,GAAG,iBAAiB,CAChD,8DAA8D,EAC9D,iDAAiD,CAClD;KACE,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;QACpC,WAAW,EACT,oEAAoE;KACvE,CAAC;IACF,MAAM,EAAE,UAAU,CAAC,QAAQ,CACzB,+DAA+D,CAChE;CACF,CAAC;KACD,IAAI,CAAC,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,CAAC;AAIlC,MAAM,CAAC,MAAM,oBAAoB,GAAG,cAAc,CAChD,8EAA8E,EAC9E,iBAAiB,EACjB,qBAAqB,CACnB,0BAA0B,EAC1B,UAAU,CAAC,EAAE,CACX,sCAAsC,kCAAkC,CAAC,UAAU,CAAC,EAAE,CACzF,CACF;KACE,MAAM,CACL,UAAU,CAAC;IACT,gBAAgB,EAAE,gBAAgB;IAClC,kBAAkB,EAAE,mBAAmB;IACvC,sBAAsB,EAAE,sBAAsB;IAC9C,WAAW,EAAE,wBAAwB;CACtC,CAAC,CAAC,KAAK,CACT;KACA,MAAM,CAAC,EAAE,WAAW,EAAE,iBAAiB,EAAE,CAAC;KAC1C,IAAI,CAAC,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC,CAAC;AAIrC,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAE9B,SAAS,0BAA0B,CAAC,GAAgB;IAClD,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;AACjE,CAAC;AAED,SAAS,kCAAkC,CAAC,IAAc;IACxD,OAAO,IAAI;SACR,GAAG,CAAC,GAAG,CAAC,EAAE;QACT,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,gBAAgB,CAItD,CAAC;QACF,OAAO,SAAS,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3C,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC;KAC9B,KAAK,CAAC,oBAAoB,CAAC;KAC3B,KAAK,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC;KAC5C,IAAI,CAAC;IACJ,KAAK,EAAE,YAAY;IACnB,WAAW,EAAE,qCAAqC;CACnD,CAAC,CAAC"}
package/src/lib/commit.js CHANGED
@@ -4,10 +4,15 @@ export const commitSchema = z
4
4
  hash: z
5
5
  .string()
6
6
  .regex(/^[\da-f]{40}$/, 'Commit SHA should be a 40-character hexadecimal string')
7
- .describe('Commit SHA (full)'),
8
- message: z.string().describe('Commit message'),
9
- date: z.coerce.date().describe('Date and time when commit was authored'),
10
- author: z.string().trim().describe('Commit author name'),
7
+ .meta({ description: 'Commit SHA (full)' }),
8
+ message: z.string().meta({ description: 'Commit message' }),
9
+ date: z.coerce
10
+ .date()
11
+ .meta({ description: 'Date and time when commit was authored' }),
12
+ author: z.string().trim().meta({ description: 'Commit author name' }),
11
13
  })
12
- .describe('Git commit');
14
+ .meta({
15
+ title: 'Commit',
16
+ description: 'Git commit',
17
+ });
13
18
  //# sourceMappingURL=commit.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"commit.js","sourceRoot":"","sources":["../../../src/lib/commit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC;KAC1B,MAAM,CAAC;IACN,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,KAAK,CACJ,eAAe,EACf,wDAAwD,CACzD;SACA,QAAQ,CAAC,mBAAmB,CAAC;IAChC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IAC9C,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,wCAAwC,CAAC;IACxE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,oBAAoB,CAAC;CACzD,CAAC;KACD,QAAQ,CAAC,YAAY,CAAC,CAAC"}
1
+ {"version":3,"file":"commit.js","sourceRoot":"","sources":["../../../src/lib/commit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC;KAC1B,MAAM,CAAC;IACN,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,KAAK,CACJ,eAAe,EACf,wDAAwD,CACzD;SACA,IAAI,CAAC,EAAE,WAAW,EAAE,mBAAmB,EAAE,CAAC;IAC7C,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAAC;IAC3D,IAAI,EAAE,CAAC,CAAC,MAAM;SACX,IAAI,EAAE;SACN,IAAI,CAAC,EAAE,WAAW,EAAE,wCAAwC,EAAE,CAAC;IAClE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,oBAAoB,EAAE,CAAC;CACtE,CAAC;KACD,IAAI,CAAC;IACJ,KAAK,EAAE,QAAQ;IACf,WAAW,EAAE,YAAY;CAC1B,CAAC,CAAC"}
@@ -3,17 +3,24 @@ import { globPathSchema } from './implementation/schemas.js';
3
3
  /**
4
4
  * Generic schema for a tool command configuration, reusable across plugins.
5
5
  */
6
- export const artifactGenerationCommandSchema = z.union([
7
- z.string().min(1).describe('Generate artifact files'),
6
+ export const artifactGenerationCommandSchema = z
7
+ .union([
8
+ z.string().min(1).meta({ description: 'Generate artifact files' }),
8
9
  z.object({
9
- command: z.string().min(1).describe('Generate artifact files'),
10
+ command: z
11
+ .string()
12
+ .min(1)
13
+ .meta({ description: 'Generate artifact files' }),
10
14
  args: z.array(z.string()).optional(),
11
15
  }),
12
- ]);
13
- export const pluginArtifactOptionsSchema = z.object({
16
+ ])
17
+ .meta({ title: 'ArtifactGenerationCommand' });
18
+ export const pluginArtifactOptionsSchema = z
19
+ .object({
14
20
  generateArtifactsCommand: artifactGenerationCommandSchema.optional(),
15
21
  artifactsPaths: z
16
22
  .union([globPathSchema, z.array(globPathSchema).min(1)])
17
- .describe('File paths or glob patterns for artifact files'),
18
- });
23
+ .meta({ description: 'File paths or glob patterns for artifact files' }),
24
+ })
25
+ .meta({ title: 'PluginArtifactOptions' });
19
26
  //# sourceMappingURL=configuration.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"configuration.js","sourceRoot":"","sources":["../../../src/lib/configuration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAE7D;;GAEG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC;IACrD,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,yBAAyB,CAAC;IACrD,CAAC,CAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,yBAAyB,CAAC;QAC9D,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;KACrC,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,wBAAwB,EAAE,+BAA+B,CAAC,QAAQ,EAAE;IACpE,cAAc,EAAE,CAAC;SACd,KAAK,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;SACvD,QAAQ,CAAC,gDAAgD,CAAC;CAC9D,CAAC,CAAC"}
1
+ {"version":3,"file":"configuration.js","sourceRoot":"","sources":["../../../src/lib/configuration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAE7D;;GAEG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC;KAC7C,KAAK,CAAC;IACL,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,yBAAyB,EAAE,CAAC;IAClE,CAAC,CAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;aACP,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC;aACN,IAAI,CAAC,EAAE,WAAW,EAAE,yBAAyB,EAAE,CAAC;QACnD,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;KACrC,CAAC;CACH,CAAC;KACD,IAAI,CAAC,EAAE,KAAK,EAAE,2BAA2B,EAAE,CAAC,CAAC;AAEhD,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC;KACzC,MAAM,CAAC;IACN,wBAAwB,EAAE,+BAA+B,CAAC,QAAQ,EAAE;IACpE,cAAc,EAAE,CAAC;SACd,KAAK,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;SACvD,IAAI,CAAC,EAAE,WAAW,EAAE,gDAAgD,EAAE,CAAC;CAC3E,CAAC;KACD,IAAI,CAAC,EAAE,KAAK,EAAE,uBAAuB,EAAE,CAAC,CAAC"}
@@ -12,6 +12,7 @@ export declare const unrefinedCoreConfigSchema: z.ZodObject<{
12
12
  key: "key";
13
13
  slug: "slug";
14
14
  file: "file";
15
+ url: "url";
15
16
  search: "search";
16
17
  blink: "blink";
17
18
  table: "table";
@@ -436,7 +437,6 @@ export declare const unrefinedCoreConfigSchema: z.ZodObject<{
436
437
  go: "go";
437
438
  python: "python";
438
439
  "python-misc": "python-misc";
439
- url: "url";
440
440
  console: "console";
441
441
  powershell: "powershell";
442
442
  gradle: "gradle";
@@ -1189,6 +1189,7 @@ export declare const coreConfigSchema: z.ZodObject<{
1189
1189
  key: "key";
1190
1190
  slug: "slug";
1191
1191
  file: "file";
1192
+ url: "url";
1192
1193
  search: "search";
1193
1194
  blink: "blink";
1194
1195
  table: "table";
@@ -1613,7 +1614,6 @@ export declare const coreConfigSchema: z.ZodObject<{
1613
1614
  go: "go";
1614
1615
  python: "python";
1615
1616
  "python-misc": "python-misc";
1616
- url: "url";
1617
1617
  console: "console";
1618
1618
  powershell: "powershell";
1619
1619
  gradle: "gradle";
@@ -2371,6 +2371,7 @@ export declare function refineCoreConfig(schema: typeof unrefinedCoreConfigSchem
2371
2371
  key: "key";
2372
2372
  slug: "slug";
2373
2373
  file: "file";
2374
+ url: "url";
2374
2375
  search: "search";
2375
2376
  blink: "blink";
2376
2377
  table: "table";
@@ -2795,7 +2796,6 @@ export declare function refineCoreConfig(schema: typeof unrefinedCoreConfigSchem
2795
2796
  go: "go";
2796
2797
  python: "python";
2797
2798
  "python-misc": "python-misc";
2798
- url: "url";
2799
2799
  console: "console";
2800
2800
  powershell: "powershell";
2801
2801
  gradle: "gradle";
@@ -16,7 +16,7 @@ export const unrefinedCoreConfigSchema = z.object({
16
16
  upload: uploadConfigSchema.optional(),
17
17
  categories: categoriesSchema.optional(),
18
18
  });
19
- export const coreConfigSchema = refineCoreConfig(unrefinedCoreConfigSchema);
19
+ export const coreConfigSchema = refineCoreConfig(unrefinedCoreConfigSchema).meta({ title: 'CoreConfig' });
20
20
  /**
21
21
  * Add refinements to coreConfigSchema
22
22
  * workaround for zod issue: https://github.com/colinhacks/zod/issues/454
@@ -1 +1 @@
1
- {"version":3,"file":"core-config.js","sourceRoot":"","sources":["../../../src/lib/core-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,8BAA8B,EAAE,MAAM,2BAA2B,CAAC;AAC3E,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,OAAO,EAAE,CAAC;SACP,KAAK,CAAC,kBAAkB,CAAC;SACzB,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CACP,sEAAsE,CACvE;IACH,kDAAkD;IAClD,OAAO,EAAE,mBAAmB,CAAC,QAAQ,EAAE;IACvC,iDAAiD;IACjD,MAAM,EAAE,kBAAkB,CAAC,QAAQ,EAAE;IACrC,UAAU,EAAE,gBAAgB,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,yBAAyB,CAAC,CAAC;AAE5E;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAwC;IACvE,mDAAmD;IACnD,OAAO,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAAC,CAAC;AACnE,CAAC"}
1
+ {"version":3,"file":"core-config.js","sourceRoot":"","sources":["../../../src/lib/core-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,8BAA8B,EAAE,MAAM,2BAA2B,CAAC;AAC3E,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,OAAO,EAAE,CAAC;SACP,KAAK,CAAC,kBAAkB,CAAC;SACzB,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CACP,sEAAsE,CACvE;IACH,kDAAkD;IAClD,OAAO,EAAE,mBAAmB,CAAC,QAAQ,EAAE;IACvC,iDAAiD;IACjD,MAAM,EAAE,kBAAkB,CAAC,QAAQ,EAAE;IACrC,UAAU,EAAE,gBAAgB,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,gBAAgB,GAAG,gBAAgB,CAC9C,yBAAyB,CAC1B,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;AAEhC;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAwC;IACvE,mDAAmD;IACnD,OAAO,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAAC,CAAC;AACnE,CAAC"}
package/src/lib/group.js CHANGED
@@ -2,19 +2,24 @@ import { z } from 'zod';
2
2
  import { createDuplicateSlugsCheck, createDuplicatesCheck, } from './implementation/checks.js';
3
3
  import { metaSchema, scorableSchema, weightedRefSchema, } from './implementation/schemas.js';
4
4
  import { formatSlugsList } from './implementation/utils.js';
5
- export const groupRefSchema = weightedRefSchema('Weighted reference to a group', "Reference slug to a group within this plugin (e.g. 'max-lines')");
5
+ export const groupRefSchema = weightedRefSchema('Weighted reference to a group', "Reference slug to a group within this plugin (e.g. 'max-lines')").meta({ title: 'GroupRef' });
6
6
  export const groupMetaSchema = metaSchema({
7
7
  titleDescription: 'Descriptive name for the group',
8
8
  descriptionDescription: 'Description of the group (markdown)',
9
9
  docsUrlDescription: 'Group documentation site',
10
10
  description: 'Group metadata',
11
11
  isSkippedDescription: 'Indicates whether the group is skipped',
12
- });
12
+ }).meta({ title: 'GroupMeta' });
13
13
  export const groupSchema = scorableSchema('A group aggregates a set of audits into a single score which can be referenced from a category. ' +
14
- 'E.g. the group slug "performance" groups audits and can be referenced in a category', groupRefSchema, createDuplicatesCheck(({ slug }) => slug, duplicates => `Group has duplicate references to audits: ${formatSlugsList(duplicates)}`)).merge(groupMetaSchema);
14
+ 'E.g. the group slug "performance" groups audits and can be referenced in a category', groupRefSchema, createDuplicatesCheck(({ slug }) => slug, duplicates => `Group has duplicate references to audits: ${formatSlugsList(duplicates)}`))
15
+ .merge(groupMetaSchema)
16
+ .meta({ title: 'Group' });
15
17
  export const groupsSchema = z
16
18
  .array(groupSchema)
17
19
  .check(createDuplicateSlugsCheck('Group'))
18
20
  .optional()
19
- .describe('List of groups');
21
+ .meta({
22
+ title: 'Groups',
23
+ description: 'List of groups',
24
+ });
20
25
  //# sourceMappingURL=group.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"group.js","sourceRoot":"","sources":["../../../src/lib/group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,yBAAyB,EACzB,qBAAqB,GACtB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,UAAU,EACV,cAAc,EACd,iBAAiB,GAClB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAE5D,MAAM,CAAC,MAAM,cAAc,GAAG,iBAAiB,CAC7C,+BAA+B,EAC/B,iEAAiE,CAClE,CAAC;AAGF,MAAM,CAAC,MAAM,eAAe,GAAG,UAAU,CAAC;IACxC,gBAAgB,EAAE,gCAAgC;IAClD,sBAAsB,EAAE,qCAAqC;IAC7D,kBAAkB,EAAE,0BAA0B;IAC9C,WAAW,EAAE,gBAAgB;IAC7B,oBAAoB,EAAE,wCAAwC;CAC/D,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,WAAW,GAAG,cAAc,CACvC,kGAAkG;IAChG,qFAAqF,EACvF,cAAc,EACd,qBAAqB,CACnB,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,EAClB,UAAU,CAAC,EAAE,CACX,6CAA6C,eAAe,CAAC,UAAU,CAAC,EAAE,CAC7E,CACF,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;AAIzB,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC;KAC1B,KAAK,CAAC,WAAW,CAAC;KAClB,KAAK,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;KACzC,QAAQ,EAAE;KACV,QAAQ,CAAC,gBAAgB,CAAC,CAAC"}
1
+ {"version":3,"file":"group.js","sourceRoot":"","sources":["../../../src/lib/group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,yBAAyB,EACzB,qBAAqB,GACtB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,UAAU,EACV,cAAc,EACd,iBAAiB,GAClB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAE5D,MAAM,CAAC,MAAM,cAAc,GAAG,iBAAiB,CAC7C,+BAA+B,EAC/B,iEAAiE,CAClE,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC;AAG9B,MAAM,CAAC,MAAM,eAAe,GAAG,UAAU,CAAC;IACxC,gBAAgB,EAAE,gCAAgC;IAClD,sBAAsB,EAAE,qCAAqC;IAC7D,kBAAkB,EAAE,0BAA0B;IAC9C,WAAW,EAAE,gBAAgB;IAC7B,oBAAoB,EAAE,wCAAwC;CAC/D,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC;AAGhC,MAAM,CAAC,MAAM,WAAW,GAAG,cAAc,CACvC,kGAAkG;IAChG,qFAAqF,EACvF,cAAc,EACd,qBAAqB,CACnB,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,EAClB,UAAU,CAAC,EAAE,CACX,6CAA6C,eAAe,CAAC,UAAU,CAAC,EAAE,CAC7E,CACF;KACE,KAAK,CAAC,eAAe,CAAC;KACtB,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;AAI5B,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC;KAC1B,KAAK,CAAC,WAAW,CAAC;KAClB,KAAK,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;KACzC,QAAQ,EAAE;KACV,IAAI,CAAC;IACJ,KAAK,EAAE,QAAQ;IACf,WAAW,EAAE,gBAAgB;CAC9B,CAAC,CAAC"}
@@ -88,6 +88,7 @@ export declare const materialIconSchema: z.ZodEnum<{
88
88
  key: "key";
89
89
  slug: "slug";
90
90
  file: "file";
91
+ url: "url";
91
92
  search: "search";
92
93
  blink: "blink";
93
94
  table: "table";
@@ -512,7 +513,6 @@ export declare const materialIconSchema: z.ZodEnum<{
512
513
  go: "go";
513
514
  python: "python";
514
515
  "python-misc": "python-misc";
515
- url: "url";
516
516
  console: "console";
517
517
  powershell: "powershell";
518
518
  gradle: "gradle";