@code-pushup/eslint-plugin 0.26.1 → 0.28.0

package/bin.js

@@ -88,6 +88,9 @@ var descriptionSchema = z.string({ description: "Description (markdown)" }).max(
 var urlSchema = z.string().url();
 var docsUrlSchema = urlSchema.optional().or(z.literal("")).describe("Documentation site");
 var titleSchema = z.string({ description: "Descriptive name" }).max(MAX_TITLE_LENGTH);
+var scoreSchema = z.number({
+  description: "Value between 0 and 1"
+}).min(0).max(1);
 function metaSchema(options) {
   const {
     descriptionDescription,
@@ -219,6 +222,8 @@ var issueSchema = z3.object(
 );
 
 // packages/models/src/lib/audit-output.ts
+var auditValueSchema = nonnegativeIntSchema.describe("Raw numeric value");
+var auditDisplayValueSchema = z4.string({ description: "Formatted value (e.g. '0.9 s', '2.1 MB')" }).optional();
 var auditDetailsSchema = z4.object(
   {
     issues: z4.array(issueSchema, { description: "List of findings" })
@@ -228,11 +233,9 @@ var auditDetailsSchema = z4.object(
 var auditOutputSchema = z4.object(
   {
     slug: slugSchema.describe("Reference to audit"),
-    displayValue: z4.string({ description: "Formatted value (e.g. '0.9 s', '2.1 MB')" }).optional(),
-    value: nonnegativeIntSchema.describe("Raw numeric value"),
-    score: z4.number({
-      description: "Value between 0 and 1"
-    }).min(0).max(1),
+    displayValue: auditDisplayValueSchema,
+    value: auditValueSchema,
+    score: scoreSchema,
     details: auditDetailsSchema.optional()
   },
   { description: "Audit information" }
@@ -555,9 +558,99 @@ var reportSchema = packageVersionSchema({
   })
 );
 
+// packages/models/src/lib/reports-diff.ts
+import { z as z14 } from "zod";
+function makeComparisonSchema(schema) {
+  const sharedDescription = schema.description || "Result";
+  return z14.object({
+    before: schema.describe(`${sharedDescription} (source commit)`),
+    after: schema.describe(`${sharedDescription} (target commit)`)
+  });
+}
+function makeArraysComparisonSchema(diffSchema, resultSchema, description) {
+  return z14.object(
+    {
+      changed: z14.array(diffSchema),
+      unchanged: z14.array(resultSchema),
+      added: z14.array(resultSchema),
+      removed: z14.array(resultSchema)
+    },
+    { description }
+  );
+}
+var scorableMetaSchema = z14.object({ slug: slugSchema, title: titleSchema });
+var scorableWithPluginMetaSchema = scorableMetaSchema.merge(
+  z14.object({
+    plugin: pluginMetaSchema.pick({ slug: true, title: true }).describe("Plugin which defines it")
+  })
+);
+var scorableDiffSchema = scorableMetaSchema.merge(
+  z14.object({
+    scores: makeComparisonSchema(scoreSchema).merge(
+      z14.object({
+        diff: z14.number().min(-1).max(1).describe("Score change (`scores.after - scores.before`)")
+      })
+    ).describe("Score comparison")
+  })
+);
+var scorableWithPluginDiffSchema = scorableDiffSchema.merge(
+  scorableWithPluginMetaSchema
+);
+var categoryDiffSchema = scorableDiffSchema;
+var groupDiffSchema = scorableWithPluginDiffSchema;
+var auditDiffSchema = scorableWithPluginDiffSchema.merge(
+  z14.object({
+    values: makeComparisonSchema(auditValueSchema).merge(
+      z14.object({
+        diff: z14.number().int().describe("Value change (`values.after - values.before`)")
+      })
+    ).describe("Audit `value` comparison"),
+    displayValues: makeComparisonSchema(auditDisplayValueSchema).describe(
+      "Audit `displayValue` comparison"
+    )
+  })
+);
+var categoryResultSchema = scorableMetaSchema.merge(
+  z14.object({ score: scoreSchema })
+);
+var groupResultSchema = scorableWithPluginMetaSchema.merge(
+  z14.object({ score: scoreSchema })
+);
+var auditResultSchema = scorableWithPluginMetaSchema.merge(
+  auditOutputSchema.pick({ score: true, value: true, displayValue: true })
+);
+var reportsDiffSchema = z14.object({
+  commits: makeComparisonSchema(commitSchema).nullable().describe("Commits identifying compared reports"),
+  categories: makeArraysComparisonSchema(
+    categoryDiffSchema,
+    categoryResultSchema,
+    "Changes affecting categories"
+  ),
+  groups: makeArraysComparisonSchema(
+    groupDiffSchema,
+    groupResultSchema,
+    "Changes affecting groups"
+  ),
+  audits: makeArraysComparisonSchema(
+    auditDiffSchema,
+    auditResultSchema,
+    "Changes affecting audits"
+  )
+}).merge(
+  packageVersionSchema({
+    versionDescription: "NPM version of the CLI (when `compare` was run)",
+    required: true
+  })
+).merge(
+  executionMetaSchema({
+    descriptionDate: "Start date and time of the compare run",
+    descriptionDuration: "Duration of the compare run in ms"
+  })
+);
+
 // packages/utils/src/lib/file-system.ts
 import { bundleRequire } from "bundle-require";
-import chalk from "chalk";
+import chalk2 from "chalk";
 import { mkdir, readFile, readdir, rm, stat } from "node:fs/promises";
 import { join } from "node:path";
 
@@ -565,7 +658,10 @@ import { join } from "node:path";
 function slugify(text) {
   return text.trim().toLowerCase().replace(/\s+|\//g, "-").replace(/[^a-z\d-]/g, "");
 }
-function pluralize(text) {
+function pluralize(text, amount) {
+  if (amount != null && Math.abs(amount) === 1) {
+    return text;
+  }
   if (text.endsWith("y")) {
     return `${text.slice(0, -1)}ies`;
   }
@@ -574,7 +670,7 @@ function pluralize(text) {
   }
   return `${text}s`;
 }
-function pluralizeToken(token, times = 0) {
+function pluralizeToken(token, times) {
   return `${times} ${Math.abs(times) === 1 ? token : pluralize(token)}`;
 }
 function truncateText(text, maxChars) {
@@ -588,6 +684,38 @@ function truncateIssueMessage(text) {
   return truncateText(text, MAX_ISSUE_MESSAGE_LENGTH);
 }
 
+// packages/utils/src/lib/logging.ts
+import isaacs_cliui from "@isaacs/cliui";
+import { cliui } from "@poppinss/cliui";
+import chalk from "chalk";
+
+// packages/utils/src/lib/reports/constants.ts
+var TERMINAL_WIDTH = 80;
+
+// packages/utils/src/lib/logging.ts
+var singletonUiInstance;
+function ui() {
+  if (singletonUiInstance === void 0) {
+    singletonUiInstance = cliui();
+  }
+  return {
+    ...singletonUiInstance,
+    row: (args) => {
+      logListItem(args);
+    }
+  };
+}
+var singletonisaacUi;
+function logListItem(args) {
+  if (singletonisaacUi === void 0) {
+    singletonisaacUi = isaacs_cliui({ width: TERMINAL_WIDTH });
+  }
+  singletonisaacUi.div(...args);
+  const content = singletonisaacUi.toString();
+  singletonisaacUi.rows = [];
+  singletonUiInstance?.logger.log(content);
+}
+
 // packages/utils/src/lib/file-system.ts
 async function readTextFile(path) {
   const buffer = await readFile(path);
@@ -602,7 +730,7 @@ async function ensureDirectoryExists(baseDir) {
     await mkdir(baseDir, { recursive: true });
     return;
   } catch (error) {
-    console.error(error.message);
+    ui().logger.error(error.message);
     if (error.code !== "EEXIST") {
       throw error;
     }
@@ -642,17 +770,12 @@ function distinct(array) {
   return [...new Set(array)];
 }
 
-// packages/utils/src/lib/logging.ts
-import chalk2 from "chalk";
-
 // packages/utils/src/lib/progress.ts
 import chalk3 from "chalk";
 import { MultiProgressBars } from "multi-progress-bars";
 
-// packages/utils/src/lib/reports/generate-stdout-summary.ts
-import cliui from "@isaacs/cliui";
+// packages/utils/src/lib/reports/log-stdout-summary.ts
 import chalk4 from "chalk";
-import CliTable3 from "cli-table3";
 
 // packages/plugin-eslint/src/lib/setup.ts
 import { ESLint } from "eslint";
@@ -722,7 +845,7 @@ function lintResultsToAudits({
   ).reduce((acc, issue) => {
     const { ruleId, message, filePath } = issue;
     if (!ruleId) {
-      console.warn(`ESLint core error - ${message}`);
+      ui().logger.warning(`ESLint core error - ${message}`);
       return acc;
     }
     const options = ruleOptionsPerFile[filePath]?.[ruleId] ?? [];
@@ -754,13 +877,15 @@ function convertIssue(issue) {
     severity: convertSeverity(issue.severity),
     source: {
       file: issue.filePath,
-      position: {
-        startLine: issue.line,
-        ...issue.column > 0 && { startColumn: issue.column },
-        ...issue.endLine && issue.endLine > 0 && {
-          endLine: issue.endLine
-        },
-        ...issue.endColumn && issue.endColumn > 0 && { endColumn: issue.endColumn }
+      ...issue.line > 0 && {
+        position: {
+          startLine: issue.line,
+          ...issue.column > 0 && { startColumn: issue.column },
+          ...issue.endLine && issue.endLine > 0 && {
+            endLine: issue.endLine
+          },
+          ...issue.endColumn && issue.endColumn > 0 && { endColumn: issue.endColumn }
+        }
       }
     }
   };

package/index.js

@@ -5,7 +5,7 @@ import { fileURLToPath } from "node:url";
 
 // packages/plugin-eslint/package.json
 var name = "@code-pushup/eslint-plugin";
-var version = "0.26.1";
+var version = "0.28.0";
 
 // packages/plugin-eslint/src/lib/config.ts
 import { z } from "zod";
@@ -110,6 +110,9 @@ var descriptionSchema = z2.string({ description: "Description (markdown)" }).max
 var urlSchema = z2.string().url();
 var docsUrlSchema = urlSchema.optional().or(z2.literal("")).describe("Documentation site");
 var titleSchema = z2.string({ description: "Descriptive name" }).max(MAX_TITLE_LENGTH);
+var scoreSchema = z2.number({
+  description: "Value between 0 and 1"
+}).min(0).max(1);
 function metaSchema(options) {
   const {
     descriptionDescription,
@@ -241,6 +244,8 @@ var issueSchema = z4.object(
 );
 
 // packages/models/src/lib/audit-output.ts
+var auditValueSchema = nonnegativeIntSchema.describe("Raw numeric value");
+var auditDisplayValueSchema = z5.string({ description: "Formatted value (e.g. '0.9 s', '2.1 MB')" }).optional();
 var auditDetailsSchema = z5.object(
   {
     issues: z5.array(issueSchema, { description: "List of findings" })
@@ -250,11 +255,9 @@ var auditDetailsSchema = z5.object(
 var auditOutputSchema = z5.object(
   {
     slug: slugSchema.describe("Reference to audit"),
-    displayValue: z5.string({ description: "Formatted value (e.g. '0.9 s', '2.1 MB')" }).optional(),
-    value: nonnegativeIntSchema.describe("Raw numeric value"),
-    score: z5.number({
-      description: "Value between 0 and 1"
-    }).min(0).max(1),
+    displayValue: auditDisplayValueSchema,
+    value: auditValueSchema,
+    score: scoreSchema,
     details: auditDetailsSchema.optional()
   },
   { description: "Audit information" }
@@ -577,9 +580,99 @@ var reportSchema = packageVersionSchema({
   })
 );
 
+// packages/models/src/lib/reports-diff.ts
+import { z as z15 } from "zod";
+function makeComparisonSchema(schema) {
+  const sharedDescription = schema.description || "Result";
+  return z15.object({
+    before: schema.describe(`${sharedDescription} (source commit)`),
+    after: schema.describe(`${sharedDescription} (target commit)`)
+  });
+}
+function makeArraysComparisonSchema(diffSchema, resultSchema, description) {
+  return z15.object(
+    {
+      changed: z15.array(diffSchema),
+      unchanged: z15.array(resultSchema),
+      added: z15.array(resultSchema),
+      removed: z15.array(resultSchema)
+    },
+    { description }
+  );
+}
+var scorableMetaSchema = z15.object({ slug: slugSchema, title: titleSchema });
+var scorableWithPluginMetaSchema = scorableMetaSchema.merge(
+  z15.object({
+    plugin: pluginMetaSchema.pick({ slug: true, title: true }).describe("Plugin which defines it")
+  })
+);
+var scorableDiffSchema = scorableMetaSchema.merge(
+  z15.object({
+    scores: makeComparisonSchema(scoreSchema).merge(
+      z15.object({
+        diff: z15.number().min(-1).max(1).describe("Score change (`scores.after - scores.before`)")
+      })
+    ).describe("Score comparison")
+  })
+);
+var scorableWithPluginDiffSchema = scorableDiffSchema.merge(
+  scorableWithPluginMetaSchema
+);
+var categoryDiffSchema = scorableDiffSchema;
+var groupDiffSchema = scorableWithPluginDiffSchema;
+var auditDiffSchema = scorableWithPluginDiffSchema.merge(
+  z15.object({
+    values: makeComparisonSchema(auditValueSchema).merge(
+      z15.object({
+        diff: z15.number().int().describe("Value change (`values.after - values.before`)")
+      })
+    ).describe("Audit `value` comparison"),
+    displayValues: makeComparisonSchema(auditDisplayValueSchema).describe(
+      "Audit `displayValue` comparison"
+    )
+  })
+);
+var categoryResultSchema = scorableMetaSchema.merge(
+  z15.object({ score: scoreSchema })
+);
+var groupResultSchema = scorableWithPluginMetaSchema.merge(
+  z15.object({ score: scoreSchema })
+);
+var auditResultSchema = scorableWithPluginMetaSchema.merge(
+  auditOutputSchema.pick({ score: true, value: true, displayValue: true })
+);
+var reportsDiffSchema = z15.object({
+  commits: makeComparisonSchema(commitSchema).nullable().describe("Commits identifying compared reports"),
+  categories: makeArraysComparisonSchema(
+    categoryDiffSchema,
+    categoryResultSchema,
+    "Changes affecting categories"
+  ),
+  groups: makeArraysComparisonSchema(
+    groupDiffSchema,
+    groupResultSchema,
+    "Changes affecting groups"
+  ),
+  audits: makeArraysComparisonSchema(
+    auditDiffSchema,
+    auditResultSchema,
+    "Changes affecting audits"
+  )
+}).merge(
+  packageVersionSchema({
+    versionDescription: "NPM version of the CLI (when `compare` was run)",
+    required: true
+  })
+).merge(
+  executionMetaSchema({
+    descriptionDate: "Start date and time of the compare run",
+    descriptionDuration: "Duration of the compare run in ms"
+  })
+);
+
 // packages/utils/src/lib/file-system.ts
 import { bundleRequire } from "bundle-require";
-import chalk from "chalk";
+import chalk2 from "chalk";
 import { mkdir, readFile, readdir, rm, stat } from "node:fs/promises";
 import { join } from "node:path";
 
@@ -601,6 +694,38 @@ function truncateDescription(text) {
   return truncateText(text, MAX_DESCRIPTION_LENGTH);
 }
 
+// packages/utils/src/lib/logging.ts
+import isaacs_cliui from "@isaacs/cliui";
+import { cliui } from "@poppinss/cliui";
+import chalk from "chalk";
+
+// packages/utils/src/lib/reports/constants.ts
+var TERMINAL_WIDTH = 80;
+
+// packages/utils/src/lib/logging.ts
+var singletonUiInstance;
+function ui() {
+  if (singletonUiInstance === void 0) {
+    singletonUiInstance = cliui();
+  }
+  return {
+    ...singletonUiInstance,
+    row: (args) => {
+      logListItem(args);
+    }
+  };
+}
+var singletonisaacUi;
+function logListItem(args) {
+  if (singletonisaacUi === void 0) {
+    singletonisaacUi = isaacs_cliui({ width: TERMINAL_WIDTH });
+  }
+  singletonisaacUi.div(...args);
+  const content = singletonisaacUi.toString();
+  singletonisaacUi.rows = [];
+  singletonUiInstance?.logger.log(content);
+}
+
 // packages/utils/src/lib/file-system.ts
 async function fileExists(path) {
   try {
@@ -615,7 +740,7 @@ async function ensureDirectoryExists(baseDir) {
     await mkdir(baseDir, { recursive: true });
     return;
   } catch (error) {
-    console.error(error.message);
+    ui().logger.error(error.message);
     if (error.code !== "EEXIST") {
       throw error;
     }
@@ -639,17 +764,12 @@ function distinct(array) {
   return [...new Set(array)];
 }
 
-// packages/utils/src/lib/logging.ts
-import chalk2 from "chalk";
-
 // packages/utils/src/lib/progress.ts
 import chalk3 from "chalk";
 import { MultiProgressBars } from "multi-progress-bars";
 
-// packages/utils/src/lib/reports/generate-stdout-summary.ts
-import cliui from "@isaacs/cliui";
+// packages/utils/src/lib/reports/log-stdout-summary.ts
 import chalk4 from "chalk";
-import CliTable3 from "cli-table3";
 
 // packages/plugin-eslint/src/lib/meta/hash.ts
 import { createHash } from "node:crypto";
@@ -687,7 +807,7 @@ async function listRules(eslint, patterns) {
     (acc, [ruleId, ruleEntry]) => {
       const meta = rulesMeta[ruleId];
       if (!meta) {
-        console.warn(`Metadata not found for ESLint rule ${ruleId}`);
+        ui().logger.warning(`Metadata not found for ESLint rule ${ruleId}`);
         return acc;
       }
       const options = toArray(ruleEntry).slice(1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/eslint-plugin",
-  "version": "0.26.1",
+  "version": "0.28.0",
   "license": "MIT",
   "dependencies": {
     "@code-pushup/utils": "*",