@code-pushup/models 0.69.5 → 0.70.0

package/src/lib/plugin-config.js

@@ -1,9 +1,14 @@
 import { z } from 'zod';
 import { pluginAuditsSchema } from './audit.js';
 import { groupsSchema } from './group.js';
+import { createCheck } from './implementation/checks.js';
 import { materialIconSchema, metaSchema, packageVersionSchema, slugSchema, } from './implementation/schemas.js';
-import { errorItems, hasMissingStrings } from './implementation/utils.js';
+import { formatSlugsList, hasMissingStrings } from './implementation/utils.js';
 import { runnerConfigSchema, runnerFunctionSchema } from './runner-config.js';
+export const pluginContextSchema = z
+    .record(z.string(), z.unknown())
+    .optional()
+    .describe('Plugin-specific context data for helpers');
 export const pluginMetaSchema = packageVersionSchema()
     .merge(metaSchema({
     titleDescription: 'Descriptive name',
@@ -19,19 +24,19 @@ export const pluginDataSchema = z.object({
     runner: z.union([runnerConfigSchema, runnerFunctionSchema]),
     audits: pluginAuditsSchema,
     groups: groupsSchema,
+    context: pluginContextSchema,
 });
 export const pluginConfigSchema = pluginMetaSchema
     .merge(pluginDataSchema)
-    // every listed group ref points to an audit within the plugin
-    .refine(pluginCfg => !getMissingRefsFromGroups(pluginCfg), pluginCfg => ({
-    message: missingRefsFromGroupsErrorMsg(pluginCfg),
-}));
-// helper for validator: every listed group ref points to an audit within the plugin
-function missingRefsFromGroupsErrorMsg(pluginCfg) {
-    const missingRefs = getMissingRefsFromGroups(pluginCfg);
-    return `The following group references need to point to an existing audit in this plugin config: ${errorItems(missingRefs)}`;
+    .check(createCheck(findMissingSlugsInGroupRefs));
+// every listed group ref points to an audit within the plugin
+export function findMissingSlugsInGroupRefs({ audits, groups = [] }) {
+    const missingSlugs = getAuditSlugsFromGroups(audits, groups);
+    return (missingSlugs && {
+        message: `Group references audits which don't exist in this plugin: ${formatSlugsList(missingSlugs)}`,
+    });
 }
-function getMissingRefsFromGroups(pluginCfg) {
-    return hasMissingStrings(pluginCfg.groups?.flatMap(({ refs: audits }) => audits.map(({ slug: ref }) => ref)) ?? [], pluginCfg.audits.map(({ slug }) => slug));
+function getAuditSlugsFromGroups(audits, groups) {
+    return hasMissingStrings(groups.flatMap(({ refs }) => refs.map(({ slug }) => slug)), audits.map(({ slug }) => slug));
 }
 //# sourceMappingURL=plugin-config.js.map

package/src/lib/plugin-config.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin-config.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/plugin-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EACL,kBAAkB,EAClB,UAAU,EACV,oBAAoB,EACpB,UAAU,GACX,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC1E,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAE9E,MAAM,CAAC,MAAM,gBAAgB,GAAG,oBAAoB,EAAE;KACnD,KAAK,CACJ,UAAU,CAAC;IACT,gBAAgB,EAAE,kBAAkB;IACpC,sBAAsB,EAAE,wBAAwB;IAChD,kBAAkB,EAAE,2BAA2B;IAC/C,WAAW,EAAE,iBAAiB;CAC/B,CAAC,CACH;KACA,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;IACP,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,uCAAuC,CAAC;IAClE,IAAI,EAAE,kBAAkB;CACzB,CAAC,CACH,CAAC;AAGJ,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,kBAAkB,EAAE,oBAAoB,CAAC,CAAC;IAC3D,MAAM,EAAE,kBAAkB;IAC1B,MAAM,EAAE,YAAY;CACrB,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,kBAAkB,GAAG,gBAAgB;KAC/C,KAAK,CAAC,gBAAgB,CAAC;IACxB,8DAA8D;KAC7D,MAAM,CACL,SAAS,CAAC,EAAE,CAAC,CAAC,wBAAwB,CAAC,SAAS,CAAC,EACjD,SAAS,CAAC,EAAE,CAAC,CAAC;IACZ,OAAO,EAAE,6BAA6B,CAAC,SAAS,CAAC;CAClD,CAAC,CACH,CAAC;AAIJ,oFAAoF;AACpF,SAAS,6BAA6B,CAAC,SAAqB;IAC1D,MAAM,WAAW,GAAG,wBAAwB,CAAC,SAAS,CAAC,CAAC;IACxD,OAAO,4FAA4F,UAAU,CAC3G,WAAW,CACZ,EAAE,CAAC;AACN,CAAC;AAED,SAAS,wBAAwB,CAAC,SAAqB;IACrD,OAAO,iBAAiB,CACtB,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAC7C,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,CACnC,IAAI,EAAE,EACP,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CACzC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"plugin-config.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/plugin-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAc,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAC5D,OAAO,EAAc,YAAY,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EACL,kBAAkB,EAClB,UAAU,EACV,oBAAoB,EACpB,UAAU,GACX,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC/E,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAE9E,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC;KACjC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;KAC/B,QAAQ,EAAE;KACV,QAAQ,CAAC,0CAA0C,CAAC,CAAC;AAGxD,MAAM,CAAC,MAAM,gBAAgB,GAAG,oBAAoB,EAAE;KACnD,KAAK,CACJ,UAAU,CAAC;IACT,gBAAgB,EAAE,kBAAkB;IACpC,sBAAsB,EAAE,wBAAwB;IAChD,kBAAkB,EAAE,2BAA2B;IAC/C,WAAW,EAAE,iBAAiB;CAC/B,CAAC,CACH;KACA,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;IACP,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,uCAAuC,CAAC;IAClE,IAAI,EAAE,kBAAkB;CACzB,CAAC,CACH,CAAC;AAGJ,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,kBAAkB,EAAE,oBAAoB,CAAC,CAAC;IAC3D,MAAM,EAAE,kBAAkB;IAC1B,MAAM,EAAE,YAAY;IACpB,OAAO,EAAE,mBAAmB;CAC7B,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,gBAAgB;KAC/C,KAAK,CAAC,gBAAgB,CAAC;KACvB,KAAK,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAAC,CAAC;AAInD,8DAA8D;AAC9D,MAAM,UAAU,2BAA2B,CAEzC,EAAE,MAAM,EAAE,MAAM,GAAG,EAAE,EAAK;IAC1B,MAAM,YAAY,GAAG,uBAAuB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7D,OAAO,CACL,YAAY,IAAI;QACd,OAAO,EAAE,6DAA6D,eAAe,CACnF,YAAY,CACb,EAAE;KACJ,CACF,CAAC;AACJ,CAAC;AAED,SAAS,uBAAuB,CAAC,MAAe,EAAE,MAAe;IAC/D,OAAO,iBAAiB,CACtB,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,EAC1D,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAC/B,CAAC;AACJ,CAAC"}