@code-pushup/utils 0.8.0 → 0.8.2

package/index.js

@@ -4,7 +4,7 @@ import { spawn } from "child_process";
 // packages/utils/src/lib/report.ts
 import { join as join2 } from "path";
 
-// packages/models/src/lib/category-config.ts
+// packages/models/src/lib/audit.ts
 import { z as z2 } from "zod";
 
 // packages/models/src/lib/implementation/schemas.ts
@@ -144,13 +144,107 @@ function hasWeightedRefsInCategories(categoryRefs) {
   return categoryRefs.reduce((acc, { weight }) => weight + acc, 0) !== 0;
 }
 
+// packages/models/src/lib/audit.ts
+var auditSchema = z2.object({
+  slug: slugSchema("ID (unique within plugin)")
+}).merge(
+  metaSchema({
+    titleDescription: "Descriptive name",
+    descriptionDescription: "Description (markdown)",
+    docsUrlDescription: "Link to documentation (rationale)",
+    description: "List of scorable metrics for the given plugin"
+  })
+);
+var pluginAuditsSchema = z2.array(auditSchema, {
+  description: "List of audits maintained in a plugin"
+}).refine(
+  (auditMetadata) => !getDuplicateSlugsInAudits(auditMetadata),
+  (auditMetadata) => ({
+    message: duplicateSlugsInAuditsErrorMsg(auditMetadata)
+  })
+);
+function duplicateSlugsInAuditsErrorMsg(audits) {
+  const duplicateRefs = getDuplicateSlugsInAudits(audits);
+  return `In plugin audits the slugs are not unique: ${errorItems(
+    duplicateRefs
+  )}`;
+}
+function getDuplicateSlugsInAudits(audits) {
+  return hasDuplicateStrings(audits.map(({ slug }) => slug));
+}
+
+// packages/models/src/lib/audit-issue.ts
+import { z as z3 } from "zod";
+var sourceFileLocationSchema = z3.object(
+  {
+    file: filePathSchema("Relative path to source file in Git repo"),
+    position: z3.object(
+      {
+        startLine: positiveIntSchema("Start line"),
+        startColumn: positiveIntSchema("Start column").optional(),
+        endLine: positiveIntSchema("End line").optional(),
+        endColumn: positiveIntSchema("End column").optional()
+      },
+      { description: "Location in file" }
+    ).optional()
+  },
+  { description: "Source file location" }
+);
+var issueSeveritySchema = z3.enum(["info", "warning", "error"], {
+  description: "Severity level"
+});
+var issueSchema = z3.object(
+  {
+    message: z3.string({ description: "Descriptive error message" }).max(512),
+    severity: issueSeveritySchema,
+    source: sourceFileLocationSchema.optional()
+  },
+  { description: "Issue information" }
+);
+
+// packages/models/src/lib/audit-output.ts
+import { z as z4 } from "zod";
+var auditOutputSchema = z4.object(
+  {
+    slug: slugSchema("Reference to audit"),
+    displayValue: z4.string({ description: "Formatted value (e.g. '0.9 s', '2.1 MB')" }).optional(),
+    value: positiveIntSchema("Raw numeric value"),
+    score: z4.number({
+      description: "Value between 0 and 1"
+    }).min(0).max(1),
+    details: z4.object(
+      {
+        issues: z4.array(issueSchema, { description: "List of findings" })
+      },
+      { description: "Detailed information" }
+    ).optional()
+  },
+  { description: "Audit information" }
+);
+var auditOutputsSchema = z4.array(auditOutputSchema, {
+  description: "List of JSON formatted audit output emitted by the runner process of a plugin"
+}).refine(
+  (audits) => !getDuplicateSlugsInAudits2(audits),
+  (audits) => ({ message: duplicateSlugsInAuditsErrorMsg2(audits) })
+);
+function duplicateSlugsInAuditsErrorMsg2(audits) {
+  const duplicateRefs = getDuplicateSlugsInAudits2(audits);
+  return `In plugin audits the slugs are not unique: ${errorItems(
+    duplicateRefs
+  )}`;
+}
+function getDuplicateSlugsInAudits2(audits) {
+  return hasDuplicateStrings(audits.map(({ slug }) => slug));
+}
+
 // packages/models/src/lib/category-config.ts
+import { z as z5 } from "zod";
 var categoryRefSchema = weightedRefSchema(
   "Weighted references to audits and/or groups for the category",
   "Slug of an audit or group (depending on `type`)"
 ).merge(
-  z2.object({
-    type: z2.enum(["audit", "group"], {
+  z5.object({
+    type: z5.enum(["audit", "group"], {
       description: "Discriminant for reference kind, affects where `slug` is looked up"
     }),
     plugin: slugSchema(
@@ -171,8 +265,8 @@ var categoryConfigSchema = scorableSchema(
     description: "Meta info for category"
   })
 ).merge(
-  z2.object({
-    isBinary: z2.boolean({
+  z5.object({
+    isBinary: z5.boolean({
       description: 'Is this a binary category (i.e. only a perfect score considered a "pass")?'
     }).optional()
   })
@@ -188,7 +282,7 @@ function getDuplicateRefsInCategoryMetrics(metrics) {
     metrics.map(({ slug, type, plugin }) => `${type} :: ${plugin} / ${slug}`)
   );
 }
-var categoriesSchema = z2.array(categoryConfigSchema, {
+var categoriesSchema = z5.array(categoryConfigSchema, {
   description: "Categorization of individual audits"
 }).min(1).refine(
   (categoryCfg) => !getDuplicateSlugCategories(categoryCfg),
@@ -210,68 +304,38 @@ function getDuplicateSlugCategories(categories) {
 import { z as z11 } from "zod";
 
 // packages/models/src/lib/persist-config.ts
-import { z as z3 } from "zod";
-var formatSchema = z3.enum(["json", "md"]);
-var persistConfigSchema = z3.object({
+import { z as z6 } from "zod";
+var formatSchema = z6.enum(["json", "md"]);
+var persistConfigSchema = z6.object({
   outputDir: filePathSchema("Artifacts folder").optional(),
   filename: fileNameSchema(
     "Artifacts file name (without extension)"
   ).optional(),
-  format: z3.array(formatSchema).optional()
+  format: z6.array(formatSchema).optional()
 });
 
 // packages/models/src/lib/plugin-config.ts
 import { z as z9 } from "zod";
 
-// packages/models/src/lib/plugin-config-audits.ts
-import { z as z4 } from "zod";
-var auditSchema = z4.object({
-  slug: slugSchema("ID (unique within plugin)")
-}).merge(
-  metaSchema({
-    titleDescription: "Descriptive name",
-    descriptionDescription: "Description (markdown)",
-    docsUrlDescription: "Link to documentation (rationale)",
-    description: "List of scorable metrics for the given plugin"
-  })
-);
-var pluginAuditsSchema = z4.array(auditSchema, {
-  description: "List of audits maintained in a plugin"
-}).refine(
-  (auditMetadata) => !getDuplicateSlugsInAudits(auditMetadata),
-  (auditMetadata) => ({
-    message: duplicateSlugsInAuditsErrorMsg(auditMetadata)
-  })
-);
-function duplicateSlugsInAuditsErrorMsg(audits) {
-  const duplicateRefs = getDuplicateSlugsInAudits(audits);
-  return `In plugin audits the slugs are not unique: ${errorItems(
-    duplicateRefs
-  )}`;
-}
-function getDuplicateSlugsInAudits(audits) {
-  return hasDuplicateStrings(audits.map(({ slug }) => slug));
-}
-
-// packages/models/src/lib/plugin-config-groups.ts
-import { z as z5 } from "zod";
-var auditGroupRefSchema = weightedRefSchema(
-  "Weighted references to audits",
-  "Reference slug to an audit within this plugin (e.g. 'max-lines')"
+// packages/models/src/lib/group.ts
+import { z as z7 } from "zod";
+var groupRefSchema = weightedRefSchema(
+  "Weighted reference to a group",
+  "Reference slug to a group within this plugin (e.g. 'max-lines')"
 );
-var auditGroupMetaSchema = metaSchema({
+var groupMetaSchema = metaSchema({
   titleDescription: "Descriptive name for the group",
   descriptionDescription: "Description of the group (markdown)",
   docsUrlDescription: "Group documentation site",
   description: "Group metadata"
 });
-var auditGroupSchema = scorableSchema(
-  'An audit group aggregates a set of audits into a single score which can be referenced from a category. E.g. the group slug "performance" groups audits and can be referenced in a category',
-  auditGroupRefSchema,
+var groupSchema = scorableSchema(
+  'A group aggregates a set of audits into a single score which can be referenced from a category. E.g. the group slug "performance" groups audits and can be referenced in a category',
+  groupRefSchema,
   getDuplicateRefsInGroups,
   duplicateRefsInGroupsErrorMsg
-).merge(auditGroupMetaSchema);
-var auditGroupsSchema = z5.array(auditGroupSchema, {
+).merge(groupMetaSchema);
+var groupsSchema = z7.array(groupSchema, {
   description: "List of groups"
 }).optional().refine(
   (groups) => !getDuplicateSlugsInGroups(groups),
@@ -279,16 +343,14 @@ var auditGroupsSchema = z5.array(auditGroupSchema, {
     message: duplicateSlugsInGroupsErrorMsg(groups)
   })
 );
-function duplicateRefsInGroupsErrorMsg(groupAudits) {
-  const duplicateRefs = getDuplicateRefsInGroups(groupAudits);
-  return `In plugin groups the audit refs are not unique: ${errorItems(
+function duplicateRefsInGroupsErrorMsg(groups) {
+  const duplicateRefs = getDuplicateRefsInGroups(groups);
+  return `In plugin groups the following references are not unique: ${errorItems(
     duplicateRefs
   )}`;
 }
-function getDuplicateRefsInGroups(groupAudits) {
-  return hasDuplicateStrings(
-    groupAudits.map(({ slug: ref }) => ref).filter(exists)
-  );
+function getDuplicateRefsInGroups(groups) {
+  return hasDuplicateStrings(groups.map(({ slug: ref }) => ref).filter(exists));
 }
 function duplicateSlugsInGroupsErrorMsg(groups) {
   const duplicateRefs = getDuplicateSlugsInGroups(groups);
@@ -298,76 +360,8 @@ function getDuplicateSlugsInGroups(groups) {
   return Array.isArray(groups) ? hasDuplicateStrings(groups.map(({ slug }) => slug)) : false;
 }
 
-// packages/models/src/lib/plugin-config-runner.ts
+// packages/models/src/lib/runner-config.ts
 import { z as z8 } from "zod";
-
-// packages/models/src/lib/plugin-process-output.ts
-import { z as z7 } from "zod";
-
-// packages/models/src/lib/plugin-process-output-audit-issue.ts
-import { z as z6 } from "zod";
-var sourceFileLocationSchema = z6.object(
-  {
-    file: filePathSchema("Relative path to source file in Git repo"),
-    position: z6.object(
-      {
-        startLine: positiveIntSchema("Start line"),
-        startColumn: positiveIntSchema("Start column").optional(),
-        endLine: positiveIntSchema("End line").optional(),
-        endColumn: positiveIntSchema("End column").optional()
-      },
-      { description: "Location in file" }
-    ).optional()
-  },
-  { description: "Source file location" }
-);
-var issueSeveritySchema = z6.enum(["info", "warning", "error"], {
-  description: "Severity level"
-});
-var issueSchema = z6.object(
-  {
-    message: z6.string({ description: "Descriptive error message" }).max(512),
-    severity: issueSeveritySchema,
-    source: sourceFileLocationSchema.optional()
-  },
-  { description: "Issue information" }
-);
-
-// packages/models/src/lib/plugin-process-output.ts
-var auditOutputSchema = z7.object(
-  {
-    slug: slugSchema("Reference to audit"),
-    displayValue: z7.string({ description: "Formatted value (e.g. '0.9 s', '2.1 MB')" }).optional(),
-    value: positiveIntSchema("Raw numeric value"),
-    score: z7.number({
-      description: "Value between 0 and 1"
-    }).min(0).max(1),
-    details: z7.object(
-      {
-        issues: z7.array(issueSchema, { description: "List of findings" })
-      },
-      { description: "Detailed information" }
-    ).optional()
-  },
-  { description: "Audit information" }
-);
-var auditOutputsSchema = z7.array(auditOutputSchema, {
-  description: "List of JSON formatted audit output emitted by the runner process of a plugin"
-}).refine(
-  (audits) => !getDuplicateSlugsInAudits2(audits),
-  (audits) => ({ message: duplicateSlugsInAuditsErrorMsg2(audits) })
-);
-function duplicateSlugsInAuditsErrorMsg2(audits) {
-  const duplicateRefs = getDuplicateSlugsInAudits2(audits);
-  return `In plugin audits the slugs are not unique: ${errorItems(
-    duplicateRefs
-  )}`;
-}
-function getDuplicateSlugsInAudits2(audits) {
-  return hasDuplicateStrings(audits.map(({ slug }) => slug));
-}
-
-// packages/models/src/lib/plugin-config-runner.ts
 var outputTransformSchema = z8.function().args(z8.unknown()).returns(z8.union([auditOutputsSchema, z8.promise(auditOutputsSchema)]));
 var runnerConfigSchema = z8.object(
   {
@@ -404,7 +398,7 @@ var pluginMetaSchema = packageVersionSchema({
 var pluginDataSchema = z9.object({
   runner: z9.union([runnerConfigSchema, runnerFunctionSchema]),
   audits: pluginAuditsSchema,
-  groups: auditGroupsSchema
+  groups: groupsSchema
 });
 var pluginConfigSchema = pluginMetaSchema.merge(pluginDataSchema).refine(
   (pluginCfg) => !getMissingRefsFromGroups(pluginCfg),
@@ -517,7 +511,7 @@ var pluginReportSchema = pluginMetaSchema.merge(
 ).merge(
   z12.object({
     audits: z12.array(auditReportSchema),
-    groups: z12.array(auditGroupSchema).optional()
+    groups: z12.array(groupSchema).optional()
   })
 );
 var reportSchema = packageVersionSchema({
@@ -789,25 +783,28 @@ function calcDuration(start, stop) {
   return Math.floor(stop - start);
 }
 function countCategoryAudits(refs, plugins) {
-  const groupLookup = plugins.reduce((lookup, plugin) => {
-    if (!plugin.groups.length) {
-      return lookup;
-    }
-    return {
-      ...lookup,
-      [plugin.slug]: {
-        ...plugin.groups.reduce(
-          (groupLookup2, group) => {
-            return {
-              ...groupLookup2,
-              [group.slug]: group
-            };
-          },
-          {}
-        )
+  const groupLookup = plugins.reduce(
+    (lookup, plugin) => {
+      if (!plugin.groups.length) {
+        return lookup;
       }
-    };
-  }, {});
+      return {
+        ...lookup,
+        [plugin.slug]: {
+          ...plugin.groups.reduce(
+            (groupLookup2, group) => {
+              return {
+                ...groupLookup2,
+                [group.slug]: group
+              };
+            },
+            {}
+          )
+        }
+      };
+    },
+    {}
+  );
   return refs.reduce((acc, ref) => {
     if (ref.type === "group") {
       const groupRefs = groupLookup[ref.plugin]?.[ref.slug]?.refs;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/utils",
-  "version": "0.8.0",
+  "version": "0.8.2",
   "dependencies": {
     "@code-pushup/models": "*",
     "bundle-require": "^4.0.1",

package/src/lib/report.d.ts

@@ -1,5 +1,5 @@
 import { CategoryRef, IssueSeverity as CliIssueSeverity, Format, Issue, PersistConfig, Report } from '@code-pushup/models';
-import { EnrichedAuditReport, EnrichedScoredAuditGroupWithAudits, ScoredReport, WeighedAuditReport } from './scoring';
+import { EnrichedAuditReport, EnrichedScoredGroupWithAudits, ScoredReport, WeighedAuditReport } from './scoring';
 export declare const FOOTER_PREFIX = "Made with \u2764 by";
 export declare const CODE_PUSHUP_DOMAIN = "code-pushup.dev";
 export declare const README_LINK = "https://github.com/flowup/quality-metrics-cli#readme";
@@ -17,7 +17,7 @@ export declare function calcDuration(start: number, stop?: number): number;
 export declare function countWeightedRefs(refs: CategoryRef[]): number;
 export declare function countCategoryAudits(refs: CategoryRef[], plugins: ScoredReport['plugins']): number;
 export declare function getAuditByRef({ slug, weight, plugin }: CategoryRef, plugins: ScoredReport['plugins']): WeighedAuditReport;
-export declare function getGroupWithAudits(refSlug: string, refPlugin: string, plugins: ScoredReport['plugins']): EnrichedScoredAuditGroupWithAudits;
+export declare function getGroupWithAudits(refSlug: string, refPlugin: string, plugins: ScoredReport['plugins']): EnrichedScoredGroupWithAudits;
 export declare function sortCategoryAudits(a: WeighedAuditReport, b: WeighedAuditReport): number;
 export declare function sortAudits(a: EnrichedAuditReport, b: EnrichedAuditReport): number;
 export declare function compareIssueSeverity(severity1: CliIssueSeverity, severity2: CliIssueSeverity): number;

package/src/lib/scoring.d.ts

@@ -1,24 +1,24 @@
-import { AuditGroup, AuditReport, CategoryConfig, PluginReport, Report } from '@code-pushup/models';
+import { AuditReport, CategoryConfig, Group, PluginReport, Report } from '@code-pushup/models';
 export type EnrichedAuditReport = AuditReport & {
     plugin: string;
 };
 export type WeighedAuditReport = EnrichedAuditReport & {
     weight: number;
 };
-export type EnrichedScoredAuditGroupWithAudits = EnrichedScoredAuditGroup & {
+export type EnrichedScoredGroupWithAudits = EnrichedScoredGroup & {
     audits: AuditReport[];
 };
 type ScoredCategoryConfig = CategoryConfig & {
     score: number;
 };
-export type EnrichedScoredAuditGroup = AuditGroup & {
+export type EnrichedScoredGroup = Group & {
     plugin: string;
     score: number;
 };
 export type ScoredReport = Omit<Report, 'plugins' | 'categories'> & {
     plugins: (Omit<PluginReport, 'audits' | 'groups'> & {
         audits: EnrichedAuditReport[];
-        groups: EnrichedScoredAuditGroup[];
+        groups: EnrichedScoredGroup[];
     })[];
     categories: ScoredCategoryConfig[];
 };