@code-pushup/models 0.56.0 → 0.58.0

package/src/lib/implementation/utils.js

@@ -0,0 +1,72 @@
+/**
+ * Regular expression to validate a slug for categories, plugins and audits.
+ * - audit (e.g. 'max-lines')
+ * - category (e.g. 'performance')
+ * Also validates ``and ` `
+ */
+export const slugRegex = /^[a-z\d]+(?:-[a-z\d]+)*$/;
+/**
+ * Regular expression to validate a filename.
+ */
+export const filenameRegex = /^(?!.*[ \\/:*?"<>|]).+$/;
+/**
+ * helper function to validate string arrays
+ *
+ * @param strings
+ */
+export function hasDuplicateStrings(strings) {
+    const sortedStrings = strings.toSorted();
+    const duplStrings = sortedStrings.filter((item, index) => index !== 0 && item === sortedStrings[index - 1]);
+    return duplStrings.length === 0 ? false : [...new Set(duplStrings)];
+}
+/**
+ * helper function to validate string arrays
+ *
+ * @param toCheck
+ * @param existing
+ */
+export function hasMissingStrings(toCheck, existing) {
+    const nonExisting = toCheck.filter(s => !existing.includes(s));
+    return nonExisting.length === 0 ? false : nonExisting;
+}
+/**
+ * helper for error items
+ */
+export function errorItems(items, transform = itemArr => itemArr.join(', ')) {
+    return transform(items || []);
+}
+export function exists(value) {
+    return value != null;
+}
+/**
+ * Get category references that do not point to any audit or group
+ * @param categories
+ * @param plugins
+ * @returns Array of missing references.
+ */
+export function getMissingRefsForCategories(categories, plugins) {
+    if (!categories || categories.length === 0) {
+        return false;
+    }
+    const auditRefsFromCategory = categories.flatMap(({ refs }) => refs
+        .filter(({ type }) => type === 'audit')
+        .map(({ plugin, slug }) => `${plugin}/${slug}`));
+    const auditRefsFromPlugins = plugins.flatMap(({ audits, slug: pluginSlug }) => audits.map(({ slug }) => `${pluginSlug}/${slug}`));
+    const missingAuditRefs = hasMissingStrings(auditRefsFromCategory, auditRefsFromPlugins);
+    const groupRefsFromCategory = categories.flatMap(({ refs }) => refs
+        .filter(({ type }) => type === 'group')
+        .map(({ plugin, slug }) => `${plugin}#${slug} (group)`));
+    const groupRefsFromPlugins = plugins.flatMap(({ groups, slug: pluginSlug }) => Array.isArray(groups)
+        ? groups.map(({ slug }) => `${pluginSlug}#${slug} (group)`)
+        : []);
+    const missingGroupRefs = hasMissingStrings(groupRefsFromCategory, groupRefsFromPlugins);
+    const missingRefs = [missingAuditRefs, missingGroupRefs]
+        .filter((refs) => Array.isArray(refs) && refs.length > 0)
+        .flat();
+    return missingRefs.length > 0 ? missingRefs : false;
+}
+export function missingRefsForCategoriesErrorMsg(categories, plugins) {
+    const missingRefs = getMissingRefsForCategories(categories, plugins);
+    return `The following category references need to point to an audit or group: ${errorItems(missingRefs)}`;
+}
+//# sourceMappingURL=utils.js.map

package/src/lib/implementation/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../../../packages/models/src/lib/implementation/utils.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,0BAA0B,CAAC;AAEpD;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,yBAAyB,CAAC;AAEvD;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAiB;IACnD,MAAM,aAAa,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IACzC,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CACtC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,CAAC,IAAI,IAAI,KAAK,aAAa,CAAC,KAAK,GAAG,CAAC,CAAC,CAClE,CAAC;IAEF,OAAO,WAAW,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;AACtE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAC/B,OAAiB,EACjB,QAAkB;IAElB,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/D,OAAO,WAAW,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC;AACxD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CACxB,KAAuB,EACvB,YAA2C,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;IAExE,OAAO,SAAS,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;AAChC,CAAC;AAED,MAAM,UAAU,MAAM,CAAI,KAAQ;IAChC,OAAO,KAAK,IAAI,IAAI,CAAC;AACvB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,2BAA2B,CACzC,UAAwC,EACxC,OAAwC;IAExC,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,qBAAqB,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAC5D,IAAI;SACD,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,KAAK,OAAO,CAAC;SACtC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC,CAClD,CAAC;IACF,MAAM,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,CAC5E,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,GAAG,UAAU,IAAI,IAAI,EAAE,CAAC,CAClD,CAAC;IACF,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,qBAAqB,EACrB,oBAAoB,CACrB,CAAC;IAEF,MAAM,qBAAqB,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAC5D,IAAI;SACD,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,KAAK,OAAO,CAAC;SACtC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,GAAG,MAAM,IAAI,IAAI,UAAU,CAAC,CAC1D,CAAC;IACF,MAAM,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAC1C,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,CAC/B,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;QACnB,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,GAAG,UAAU,IAAI,IAAI,UAAU,CAAC;QAC3D,CAAC,CAAC,EAAE,CACT,CAAC;IACF,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,qBAAqB,EACrB,oBAAoB,CACrB,CAAC;IAEF,MAAM,WAAW,GAAG,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;SACrD,MAAM,CAAC,CAAC,IAAI,EAAoB,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;SAC1E,IAAI,EAAE,CAAC;IAEV,OAAO,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC;AACtD,CAAC;AAED,MAAM,UAAU,gCAAgC,CAC9C,UAAwC,EACxC,OAAwC;IAExC,MAAM,WAAW,GAAG,2BAA2B,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACrE,OAAO,yEAAyE,UAAU,CACxF,WAAW,CACZ,EAAE,CAAC;AACN,CAAC"}

package/src/lib/issue.d.ts

@@ -1,5 +1,13 @@
 import { z } from 'zod';
 export declare const issueSeveritySchema: z.ZodEnum<["info", "warning", "error"]>;
+/**
+ * Type Definition: `IssueSeverity`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `IssueSeverity` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#issueseverity}
+ */
 export type IssueSeverity = z.infer<typeof issueSeveritySchema>;
 export declare const issueSchema: z.ZodObject<{
     message: z.ZodString;
@@ -64,4 +72,12 @@ export declare const issueSchema: z.ZodObject<{
         } | undefined;
     } | undefined;
 }>;
+/**
+ * Type Definition: `Issue`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `Issue` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#issue}
+ */
 export type Issue = z.infer<typeof issueSchema>;

package/src/lib/issue.js

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+import { MAX_ISSUE_MESSAGE_LENGTH } from './implementation/limits.js';
+import { sourceFileLocationSchema } from './source.js';
+export const issueSeveritySchema = z.enum(['info', 'warning', 'error'], {
+    description: 'Severity level',
+});
+export const issueSchema = z.object({
+    message: z
+        .string({ description: 'Descriptive error message' })
+        .max(MAX_ISSUE_MESSAGE_LENGTH),
+    severity: issueSeveritySchema,
+    source: sourceFileLocationSchema.optional(),
+}, { description: 'Issue information' });
+//# sourceMappingURL=issue.js.map

package/src/lib/issue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"issue.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/issue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAEvD,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE;IACtE,WAAW,EAAE,gBAAgB;CAC9B,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CACjC;IACE,OAAO,EAAE,CAAC;SACP,MAAM,CAAC,EAAE,WAAW,EAAE,2BAA2B,EAAE,CAAC;SACpD,GAAG,CAAC,wBAAwB,CAAC;IAChC,QAAQ,EAAE,mBAAmB;IAC7B,MAAM,EAAE,wBAAwB,CAAC,QAAQ,EAAE;CAC5C,EACD,EAAE,WAAW,EAAE,mBAAmB,EAAE,CACrC,CAAC"}

package/src/lib/persist-config.d.ts

@@ -1,5 +1,13 @@
 import { z } from 'zod';
 export declare const formatSchema: z.ZodEnum<["json", "md"]>;
+/**
+ * Type Definition: `Format`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `Format` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#format}
+ */
 export type Format = z.infer<typeof formatSchema>;
 export declare const persistConfigSchema: z.ZodObject<{
     outputDir: z.ZodOptional<z.ZodString>;
@@ -14,4 +22,12 @@ export declare const persistConfigSchema: z.ZodObject<{
     filename?: string | undefined;
     format?: ("json" | "md")[] | undefined;
 }>;
+/**
+ * Type Definition: `PersistConfig`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `PersistConfig` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#persistconfig}
+ */
 export type PersistConfig = z.infer<typeof persistConfigSchema>;

package/src/lib/persist-config.js

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+import { fileNameSchema, filePathSchema } from './implementation/schemas.js';
+export const formatSchema = z.enum(['json', 'md']);
+export const persistConfigSchema = z.object({
+    outputDir: filePathSchema.describe('Artifacts folder').optional(),
+    filename: fileNameSchema
+        .describe('Artifacts file name (without extension)')
+        .optional(),
+    format: z.array(formatSchema).optional(),
+});
+//# sourceMappingURL=persist-config.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"persist-config.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/persist-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAE7E,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;AAGnD,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,SAAS,EAAE,cAAc,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,QAAQ,EAAE;IACjE,QAAQ,EAAE,cAAc;SACrB,QAAQ,CAAC,yCAAyC,CAAC;SACnD,QAAQ,EAAE;IACb,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE;CACzC,CAAC,CAAC"}