guard-my-design-system 1.7.0 → 1.9.0

package/README.md

@@ -56,11 +56,32 @@ it updates that same comment. It never adds more comments:
   are decided elsewhere, so they are left alone.
 - **A second definition of a component you already have.** The finding names
   the file that already defines it, and how many places use that one.
+- **A new import of a duplicate component.** When a name is defined in more
+  than one file and one copy is clearly the main one, importing another copy
+  is flagged. The finding names the main copy, how often each is used, and
+  the colours the other copy hard-codes. If two copies are used about
+  equally, nothing is flagged.
+- **A new colour token that copies an existing one.** A token added to a
+  stylesheet whose value is almost the same as a token the system already
+  has, or whose dark value is exactly the same, is flagged with the existing
+  token named: `--color-overdue-soft (#fff4e5) is a twin of the existing
+  --color-warning-soft (#fdf5e6)`. Numbered steps such as `gray-100` and
+  shadcn's own theme variables are never compared.
 - **A palette colour where a theme variable exists.** On a shadcn repo whose
   theme file holds the variables, `text-slate-500` in the app's own code is
   flagged and the theme file named. Off on utility-class installs.
-
-It reads the repo the way the roast report does. On a shadcn repo the
+- **A colour or a pixel size written onto a kit component.** On a product
+  built on MUI, Mantine, Chakra UI or Ant Design, `color: '#667085'` in an
+  `sx` prop or a style object is flagged and the finding says whether the
+  theme already holds that colour, or tells you to add it there once. A
+  pixel size such as `p: '12px'` is turned into the theme's spacing step. The
+  advice is in the kit's own words: `sx` paths on MUI, props on Mantine,
+  style props on Chakra, the theme config on Ant Design.
+
+It reads the repo the way the roast report does. On a kit repo the theme's
+colours are the token set, and a colour the theme already holds is flagged
+on a kit component all the same: writing it by hand is the exact mistake the
+check exists for. On a shadcn repo the
 installed catalogue, installed registries and kit blocks are not judged:
 `shadcn add` is not a sin. On a repo that publishes a shadcn registry only
 the published folders are judged. `!important` in an embedded widget's

package/index.mjs

@@ -81,7 +81,14 @@ const readWhole = (file) => {
   }
   return wholeFile.get(file);
 };
-let findings = judge(judged, system, { readFile: readWhole });
+// The file at the base, so a token or an import already there before this
+// change is not reported as new. null: the change creates the file.
+const readBase = (file) => {
+  try {
+    return execFileSync('git', ['show', `${base}:${file}`], { cwd, encoding: 'utf8', stdio: ['ignore', 'pipe', 'ignore'], maxBuffer: 16 * 1024 * 1024 });
+  } catch { return null; }
+};
+let findings = judge(judged, system, { readFile: readWhole, readBase });
 
 // The escape hatch: a `guard-ignore-next-line` comment silences every finding
 // on the line below it. Checked against the file as it stands (not just the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "guard-my-design-system",
-  "version": "1.7.0",
+  "version": "1.9.0",
   "description": "Your design system dies one pull request at a time. This makes sure it doesn't. A guard that judges only the lines a change adds, against the system the repo already has, and names the on-system value the author probably meant.",
   "type": "module",
   "bin": {
@@ -11,7 +11,7 @@
     "src/"
   ],
   "dependencies": {
-    "roast-my-design-system": "8.4.5"
+    "roast-my-design-system": "8.6.1"
   },
   "keywords": [
     "design-system",

package/src/judge.mjs

@@ -12,7 +12,8 @@ import {
   isCodeFile, isStyleFile, typefaceOf, GENERIC_FONTS,
   definedComponents, exemptReason,
   EXTRA_KINDS, extraValue, fontDeclarations,
-  WIDGET_CSS_RE, isLibraryClass, PALETTE_CLASS_RE, blankComments,
+  WIDGET_CSS_RE, isLibraryClass, PALETTE_CLASS_RE, blankComments, kitPaintFindings,
+  tokenTwinFindings, avoidedImportFindings,
 } from 'roast-my-design-system/engine';
 
 // Folder membership, the way the engine's own splits do it.
@@ -86,9 +87,13 @@ function exemptFiles(added, readFile) {
  * Judge added lines against the learned system.
  * Returns [{ file, line, kind, value, advice }] sorted by file then line.
  * kinds: color | spacing | radius | fontsize | shadow | arbitrary |
- *        important | font | inline | component
+ *        important | font | inline | component | palette | kit-colour |
+ *        kit-px | twin-token | avoided-copy
+ * readFile(file) gives the file as it stands; readBase(file) the file at the
+ * base (null when the change creates it), so a token or an import the change
+ * adds can be told from one that was already there.
  */
-export function judge(added, system, { readFile } = {}) {
+export function judge(added, system, { readFile, readBase } = {}) {
   const tokenSet = new Set(system.tokens);
   // How the repo was read, from the engine's own profiles (roast 7.8):
   // installed code is not the change's sin, a registry is judged on what it
@@ -185,6 +190,35 @@ export function judge(added, system, { readFile } = {}) {
     }
   }
 
+  // A product built on a kit (MUI, Mantine, Chakra UI, Ant Design), roast
+  // 8.4.6: a colour or a pixel size written onto a kit component where the
+  // theme has a value. The engine judges the whole file (the import that makes
+  // it a kit file sits at the top, where the diff never looks) and the guard
+  // keeps the hits on added lines. On a kit file the kit rule owns colours
+  // and the pixel sizes it named, so the generic rules stay quiet about the
+  // same value: one line, one finding, the same words as the roast report's
+  // live checks.
+  const kit = prof.kit ?? null;
+  const kitJudged = new Map();
+  const kitLines = (file) => {
+    if (!kit) return null;
+    if (!kitJudged.has(file)) {
+      const w = wholeText(file);
+      const j = w == null ? null : kitPaintFindings(w, kit, { file });
+      if (!j || j.exempt) kitJudged.set(file, null);
+      else {
+        const byLine = new Map();
+        for (const f of j.findings) {
+          const ln = w.slice(0, f.index).split('\n').length;
+          if (!byLine.has(ln)) byLine.set(ln, []);
+          byLine.get(ln).push(f);
+        }
+        kitJudged.set(file, byLine);
+      }
+    }
+    return kitJudged.get(file);
+  };
+
   const findings = [];
 
   for (const { file, line, text } of added) {
@@ -194,7 +228,18 @@ export function judge(added, system, { readFile } = {}) {
 
     const seen = extractStyling(text, { css });
 
+    const onKit = css ? null : kitLines(file);
+    const kitPx = new Set();
+    for (const f of onKit?.get(line) ?? []) {
+      if (f.rule === 'kit-px') kitPx.add(f.value.split(': ')[1]);
+      findings.push({
+        file, line, kind: f.rule, value: f.value, label: f.label,
+        advice: f.note ? `${f.note}. ${f.fix.replace(/\.$/, '')}` : f.fix.replace(/\.$/, ''),
+      });
+    }
+
     for (const c of seen.colors) {
+      if (onKit) break; // the kit rule owns colours on a kit file
       if (tokenSet.has(c.value)) continue; // disciplined token use
       const near = c.value.startsWith('#') ? nearestColor(c.value, system.tokens) : null;
       findings.push({
@@ -208,6 +253,7 @@ export function judge(added, system, { readFile } = {}) {
     }
 
     for (const s of seen.spacing) {
+      if (kitPx.has(s.value)) continue; // the kit rule said it
       if (knownLengths.has(s.value)) continue; // the codebase already uses it
       const near = nearestLength(s.value, [...knownLengths]);
       findings.push({
@@ -322,6 +368,44 @@ export function judge(added, system, { readFile } = {}) {
     }
   }
 
+  // Two checks that read the whole file against its base, roast 8.6: a new
+  // colour token that copies one the system already has, and a new import of
+  // the duplicate the canonical copy replaces. The engine words both, the
+  // same words roast_validate, roast_review and --check give; the guard keeps
+  // the hits on added lines.
+  const addedAt = new Map();
+  for (const { file, line } of added) {
+    if (!addedAt.has(file)) addedAt.set(file, new Set());
+    addedAt.get(file).add(line);
+  }
+  const baseText = (file) => {
+    if (!readBase) return undefined;
+    try { return readBase(file); } catch { return undefined; }
+  };
+  const lineAt = (text, index) => text.slice(0, index).split('\n').length;
+  for (const [file, lines] of addedAt) {
+    if (exempt(file) || outOfScope(file)) continue;
+    const css = isStyleFile(file);
+    if (!css && !isCodeFile(file)) continue;
+    const w = wholeText(file);
+    if (w == null) continue;
+    const hits = css
+      ? (system.tokenDefs && w.includes('--') ? tokenTwinFindings(w, {
+          before: baseText(file),
+          others: system.tokenDefs.filter((d) => !samePath(d.file, file)),
+          tailwind: prof.kind === 'tailwind' || /@theme\b/.test(w),
+        }) : [])
+      : (system.duplicates ? avoidedImportFindings(w, { file, before: baseText(file), dupes: system.duplicates }) : []);
+    for (const f of hits) {
+      const line = lineAt(w, f.index);
+      if (!lines.has(line)) continue;
+      findings.push({
+        file, line, kind: f.rule, value: f.name,
+        advice: `${f.message} ${f.fix.replace(/\.$/, '')}`,
+      });
+    }
+  }
+
   // Two extractors can see the same value on the same line (a hex inside a
   // Tailwind class is also a hex in the raw sweep). One sin, one line.
   const seen = new Set();

package/src/report.mjs

@@ -16,10 +16,17 @@ const KIND_LABEL = {
   inline: 'inline style block',
   component: 'second definition of',
   palette: 'palette colour where a theme variable exists',
+  // on a kit repo the engine words the label with the kit's name (f.label)
+  'kit-colour': 'colour written onto a kit component',
+  'kit-px': 'pixel size on a kit component',
+  // the engine's sentence names the token or the import itself (roast 8.6)
+  'twin-token': 'token that copies an existing one',
+  'avoided-copy': 'import of a duplicate',
 };
+const labelOf = (f) => f.label ?? KIND_LABEL[f.kind];
 
 // Kinds whose label already says everything; printing the value repeats it.
-const VALUELESS = new Set(['important', 'inline']);
+const VALUELESS = new Set(['important', 'inline', 'twin-token', 'avoided-copy']);
 
 const FOOTER = 'Full picture of the whole codebase: `npx roast-my-design-system`';
 
@@ -29,7 +36,7 @@ export function terminalReport(findings) {
   }
   const lines = [`guard-my-design-system: ${findings.length} new issue${findings.length === 1 ? '' : 's'} in this change\n`];
   for (const f of findings) {
-    lines.push(`  ${f.file}:${f.line} · ${KIND_LABEL[f.kind]} ${VALUELESS.has(f.kind) ? '' : f.value}`.trimEnd() + `. ${capitalise(f.advice)}.`);
+    lines.push(`  ${f.file}:${f.line} · ${labelOf(f)} ${VALUELESS.has(f.kind) ? '' : f.value}`.trimEnd() + `. ${capitalise(f.advice)}.`);
   }
   lines.push('');
   lines.push('  Only lines added in this change were counted. The existing codebase was not judged.');
@@ -49,7 +56,7 @@ export function markdownReport(findings) {
   }
   const out = [`**🛡 guard-my-design-system: ${findings.length} new issue${findings.length === 1 ? '' : 's'} in this pull request**`, ''];
   for (const f of findings) {
-    out.push(`- \`${f.file}:${f.line}\` · ${KIND_LABEL[f.kind]} ${VALUELESS.has(f.kind) ? '' : `\`${f.value}\``}`.trimEnd() + `. ${capitalise(f.advice)}.`);
+    out.push(`- \`${f.file}:${f.line}\` · ${labelOf(f)} ${VALUELESS.has(f.kind) ? '' : `\`${f.value}\``}`.trimEnd() + `. ${capitalise(f.advice)}.`);
   }
   out.push('');
   out.push(`<sub>Only added lines are checked; the existing codebase is never judged. ${FOOTER}</sub>`);