guard-my-design-system 1.8.0 → 1.9.0

package/README.md

@@ -56,6 +56,17 @@ 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.

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.8.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.6"
+    "roast-my-design-system": "8.6.1"
   },
   "keywords": [
     "design-system",

package/src/judge.mjs

@@ -13,6 +13,7 @@ import {
   definedComponents, exemptReason,
   EXTRA_KINDS, extraValue, fontDeclarations,
   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
@@ -363,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

@@ -19,11 +19,14 @@ const KIND_LABEL = {
   // 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`';