guard-my-design-system 1.8.0 → 2.0.0

package/README.md

@@ -1,6 +1,6 @@
 # guard-my-design-system
 
-[![npm](https://img.shields.io/npm/v/guard-my-design-system?color=2dd4bf&label=npm)](https://www.npmjs.com/package/guard-my-design-system) [![downloads](https://img.shields.io/npm/dm/guard-my-design-system?color=2dd4bf&label=downloads)](https://www.npmjs.com/package/guard-my-design-system) [![license](https://img.shields.io/badge/license-MIT-blue)](LICENSE) [![no telemetry](https://img.shields.io/badge/no-telemetry-2dd4bf)](https://github.com/gregkozakiewicz/guard-my-design-system#what-makes-the-verdict-trustworthy) [![GitHub Action](https://img.shields.io/badge/GitHub_Action-v1-2dd4bf)](#on-a-pull-request)
+[![npm](https://img.shields.io/npm/v/guard-my-design-system?color=2dd4bf&label=npm)](https://www.npmjs.com/package/guard-my-design-system) [![downloads](https://img.shields.io/npm/dm/guard-my-design-system?color=2dd4bf&label=downloads)](https://www.npmjs.com/package/guard-my-design-system) [![license](https://img.shields.io/badge/license-MIT-blue)](LICENSE) [![no telemetry](https://img.shields.io/badge/no-telemetry-2dd4bf)](https://github.com/gregkozakiewicz/guard-my-design-system#what-makes-the-verdict-trustworthy) [![GitHub Action](https://img.shields.io/badge/GitHub_Action-v2-2dd4bf)](#on-a-pull-request)
 
 ## Your design system dies one pull request at a time. This makes sure it doesn't.
 
@@ -56,9 +56,31 @@ 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.
+- **A chart colour written by hand.** A chart needs several colours that
+  differ from each other, and most design systems never name them, so the
+  chart rule (roast 8.8) has three answers. Where the repo keeps a chart
+  palette (`--chart-*` or `--series-*` tokens, a `chartColors` entry in the
+  theme, or shadcn's `--chart-1` to `--chart-5` when a chart actually reads
+  them), a hex in a chart file is flagged and the palette named. Where the
+  repo has charts but no palette, a new chart painting by hand gets one line
+  that names the existing chart doing the same and asks for the palette
+  once. The first chart in a repo gets one line asking for a name. The
+  generic colour rule stays out of chart files, the same way it does in
+  `roast_validate`.
 - **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
@@ -123,7 +145,7 @@ jobs:
       - uses: actions/checkout@v5
         with:
           fetch-depth: 0
-      - uses: gregkozakiewicz/guard-my-design-system@v1
+      - uses: gregkozakiewicz/guard-my-design-system@v2
 ```
 
 After that it runs on every pull request and needs no attention from you.
@@ -132,7 +154,7 @@ If you want the check to fail instead of commenting, turn on strict mode.
 It is the only setting:
 
 ```yaml
-      - uses: gregkozakiewicz/guard-my-design-system@v1
+      - uses: gregkozakiewicz/guard-my-design-system@v2
         with:
           strict: true
 ```

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": "2.0.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": "9.0.0"
   },
   "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, isChartFile, chartFindings,
 } 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 | chart-colour | chart-palette
+ * 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
@@ -216,6 +221,18 @@ export function judge(added, system, { readFile } = {}) {
 
   const findings = [];
 
+  // A chart's series colours are judged against the chart palette, or its
+  // absence, by the engine (roast 8.8.0, lib/charts): the report never
+  // counted them, the live checks counted every one, and the guard did too.
+  // On a chart file the chart rule owns colours, the same way it does in
+  // roast_validate: the kit judge and the generic colour rule stay out.
+  const chartColours = new Map(); // file → [{ value, index: line }]
+  const isChart = (file) => {
+    if (!system.charts) return false;
+    const w = wholeText(file);
+    return isChartFile(file, w ?? '');
+  };
+
   for (const { file, line, text } of added) {
     if (exempt(file) || outOfScope(file)) continue;
     const css = isStyleFile(file);
@@ -223,7 +240,14 @@ export function judge(added, system, { readFile } = {}) {
 
     const seen = extractStyling(text, { css });
 
-    const onKit = css ? null : kitLines(file);
+    const chart = !css && isChart(file);
+    if (chart) {
+      const list = chartColours.get(file) ?? [];
+      for (const c of seen.colors) if (!tokenSet.has(c.value)) list.push({ value: c.value, index: line });
+      chartColours.set(file, list);
+    }
+
+    const onKit = css || chart ? 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]);
@@ -234,7 +258,7 @@ export function judge(added, system, { readFile } = {}) {
     }
 
     for (const c of seen.colors) {
-      if (onKit) break; // the kit rule owns colours on a kit file
+      if (onKit || chart) break; // the kit rule or the chart rule owns colours here
       if (tokenSet.has(c.value)) continue; // disciplined token use
       const near = c.value.startsWith('#') ? nearestColor(c.value, system.tokens) : null;
       findings.push({
@@ -363,6 +387,59 @@ 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(/\.$/, '')}`,
+      });
+    }
+  }
+
+  // The chart rule, once per chart file, in the engine's words: with a
+  // palette every hand-written colour is a finding that names it; without
+  // one the file gets a single line that names the precedent chart and asks
+  // for the palette once (roast 8.8.0). `index` carries the diff line.
+  for (const [file, colours] of chartColours) {
+    if (!colours.length) continue;
+    for (const f of chartFindings({ file, colours, charts: system.charts, tokenFile: system.tokenFile ?? null })) {
+      findings.push({
+        file, line: f.index, kind: f.rule,
+        value: f.rule === 'chart-colour' ? f.message.match(/Chart colour (\S+)/)?.[1] ?? 'colour' : `${colours.length} series colour${colours.length === 1 ? '' : 's'} by hand`,
+        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,18 @@ 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',
+  // the chart rule (roast 8.8): a colour beside a chart palette, or a chart
+  // painting by hand where the repo keeps none
+  'chart-colour': 'chart colour written by hand',
+  'chart-palette': 'chart painted by hand',
 };
 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', 'chart-palette']);
 
 const FOOTER = 'Full picture of the whole codebase: `npx roast-my-design-system`';