@code-pushup/eslint-plugin 0.2.0 → 0.3.1

package/bin.js

@@ -9,6 +9,11 @@ import { z as z2 } from "zod";
 import { z } from "zod";
 import { MATERIAL_ICONS } from "@code-pushup/portal-client";
 
+// packages/models/src/lib/implementation/limits.ts
+var MAX_SLUG_LENGTH = 128;
+var MAX_TITLE_LENGTH = 256;
+var MAX_DESCRIPTION_LENGTH = 65536;
+
 // packages/models/src/lib/implementation/utils.ts
 var slugRegex = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;
 var filenameRegex = /^(?!.*[ \\/:*?"<>|]).+$/;
@@ -44,12 +49,12 @@ function executionMetaSchema(options = {
 function slugSchema(description = "Unique ID (human-readable, URL-safe)") {
   return z.string({ description }).regex(slugRegex, {
     message: "The slug has to follow the pattern [0-9a-z] followed by multiple optional groups of -[0-9a-z]. e.g. my-slug"
-  }).max(128, {
-    message: "slug can be max 128 characters long"
+  }).max(MAX_SLUG_LENGTH, {
+    message: `slug can be max ${MAX_SLUG_LENGTH} characters long`
   });
 }
 function descriptionSchema(description = "Description (markdown)") {
-  return z.string({ description }).max(65536).optional();
+  return z.string({ description }).max(MAX_DESCRIPTION_LENGTH).optional();
 }
 function docsUrlSchema(description = "Documentation site") {
   return urlSchema(description).optional().or(z.string().max(0));
@@ -58,7 +63,7 @@ function urlSchema(description) {
   return z.string({ description }).url();
 }
 function titleSchema(description = "Descriptive name") {
-  return z.string({ description }).max(256);
+  return z.string({ description }).max(MAX_TITLE_LENGTH);
 }
 function metaSchema(options) {
   const {

package/index.js

@@ -5,7 +5,7 @@ import { fileURLToPath } from "url";
 
 // packages/plugin-eslint/package.json
 var name = "@code-pushup/eslint-plugin";
-var version = "0.2.0";
+var version = "0.3.1";
 
 // packages/plugin-eslint/src/lib/config.ts
 import { z } from "zod";
@@ -31,6 +31,11 @@ import { z as z3 } from "zod";
 import { z as z2 } from "zod";
 import { MATERIAL_ICONS } from "@code-pushup/portal-client";
 
+// packages/models/src/lib/implementation/limits.ts
+var MAX_SLUG_LENGTH = 128;
+var MAX_TITLE_LENGTH = 256;
+var MAX_DESCRIPTION_LENGTH = 65536;
+
 // packages/models/src/lib/implementation/utils.ts
 var slugRegex = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;
 var filenameRegex = /^(?!.*[ \\/:*?"<>|]).+$/;
@@ -66,12 +71,12 @@ function executionMetaSchema(options = {
 function slugSchema(description = "Unique ID (human-readable, URL-safe)") {
   return z2.string({ description }).regex(slugRegex, {
     message: "The slug has to follow the pattern [0-9a-z] followed by multiple optional groups of -[0-9a-z]. e.g. my-slug"
-  }).max(128, {
-    message: "slug can be max 128 characters long"
+  }).max(MAX_SLUG_LENGTH, {
+    message: `slug can be max ${MAX_SLUG_LENGTH} characters long`
   });
 }
 function descriptionSchema(description = "Description (markdown)") {
-  return z2.string({ description }).max(65536).optional();
+  return z2.string({ description }).max(MAX_DESCRIPTION_LENGTH).optional();
 }
 function docsUrlSchema(description = "Documentation site") {
   return urlSchema(description).optional().or(z2.string().max(0));
@@ -80,7 +85,7 @@ function urlSchema(description) {
   return z2.string({ description }).url();
 }
 function titleSchema(description = "Descriptive name") {
-  return z2.string({ description }).max(256);
+  return z2.string({ description }).max(MAX_TITLE_LENGTH);
 }
 function metaSchema(options) {
   const {
@@ -558,6 +563,19 @@ import { join } from "path";
 function slugify(text) {
   return text.trim().toLowerCase().replace(/\s+|\//g, "-").replace(/[^a-z0-9-]/g, "");
 }
+function truncateText(text, maxChars) {
+  if (text.length <= maxChars) {
+    return text;
+  }
+  const ellipsis = "...";
+  return text.slice(0, maxChars - ellipsis.length) + ellipsis;
+}
+function truncateTitle(text) {
+  return truncateText(text, MAX_TITLE_LENGTH);
+}
+function truncateDescription(text) {
+  return truncateText(text, MAX_DESCRIPTION_LENGTH);
+}
 
 // packages/utils/src/lib/file-system.ts
 async function fileExists(path) {
@@ -790,8 +808,8 @@ function ruleToAudit({ ruleId, meta, options }) {
   ];
   return {
     slug: ruleIdToSlug(ruleId, options),
-    title: meta.docs?.description ?? name2,
-    description: lines.join("\n\n"),
+    title: truncateTitle(meta.docs?.description ?? name2),
+    description: truncateDescription(lines.join("\n\n")),
     ...meta.docs?.url && {
       docsUrl: meta.docs.url
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/eslint-plugin",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "dependencies": {
     "@code-pushup/utils": "*",
     "@code-pushup/models": "*",