guard-my-design-system 1.0.2 → 1.1.0

package/README.md

@@ -8,6 +8,16 @@ A pull request guard that checks **only the lines a change adds**, says nothing
 about the past, and points each new sin at the on-system value the author
 probably meant. Old wiring is not its business; new sparks are.
 
+It speaks in nearests, not scoldings:
+
+> `Card.tsx:24` — new colour `#4a7be8`. Nearest token: `#3b6fe0`.
+>
+> `site.css:31` — new spacing value `13px`. Nearest existing value: `12px`.
+>
+> `site.css:33` — new typeface `Comic Sans MS`. First typeface declared in this codebase.
+>
+> `site.css:35` — `!important`. The cascade admitting defeat; raise specificity or fix the source order.
+
 It learns your system by scanning your repo with the
 [roast-my-design-system](https://github.com/gregkozakiewicz/roast-my-design-system)
 engine, then judges the diff against what it learned. No config files, no rules
@@ -83,7 +93,7 @@ Judge your uncommitted work before anyone else sees it:
 npx guard-my-design-system@latest
 ```
 
-| Command | What you get |
+| Command                                                                                      | What you get |
 |---|---|
 | <code>npx&nbsp;guard-my-design-system@latest</code> | Your working tree's added lines judged against main, in the terminal |
 | <code>npx&nbsp;guard-my-design-system@latest&nbsp;&lt;path&gt;</code> | Judge a different repo than the current directory |
@@ -138,6 +148,6 @@ by Greg Kozakiewicz*.
 
 **guard-my-design-system**™ and the GK mark are trademarks of Greg Kozakiewicz.
 Forking is welcome, republishing under this name is not: see
-[brand and attribution](https://gregkozakiewicz.github.io/roast-my-design-system/brand.html).
+[brand and attribution](https://gregkozakiewicz.github.io/guard-my-design-system/brand.html).
 
 Built and designed by <a href="https://gregkozakiewicz.com"><picture><source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/gregkozakiewicz/roast-my-design-system/main/assets/gk-mark-dark.png?v=3.10.1"><img src="https://raw.githubusercontent.com/gregkozakiewicz/roast-my-design-system/main/assets/gk-mark.png?v=3.10.1" height="15" alt="GK mark"></picture> Greg Kozakiewicz</a>.

package/index.mjs

@@ -13,6 +13,8 @@
  * --strict, 2 could not run.
  */
 import { resolve } from 'node:path';
+import { readFileSync } from 'node:fs';
+import { execFileSync } from 'node:child_process';
 import { learnSystem } from 'roast-my-design-system/engine';
 import { defaultBase, addedLines } from './src/diff.mjs';
 import { judge } from './src/judge.mjs';
@@ -25,7 +27,22 @@ const opt = (name) => {
   return i > -1 && argv[i + 1] ? argv[i + 1] : null;
 };
 
+if (flag('version') || argv.includes('-v')) {
+  const pkg = JSON.parse(readFileSync(new URL('./package.json', import.meta.url), 'utf8'));
+  console.log(`guard-my-design-system ${pkg.version}`);
+  process.exit(0);
+}
+
 const cwd = resolve(argv[0] && !argv[0].startsWith('--') ? argv[0] : '.');
+
+// The guard judges diffs, so a git repository is its whole world. Say so
+// calmly instead of letting git's own fatals leak through.
+try {
+  execFileSync('git', ['rev-parse', '--is-inside-work-tree'], { cwd, stdio: 'ignore' });
+} catch {
+  console.error('guard: this is not a git repository, and the guard judges diffs. Run it inside a repo.');
+  process.exit(2);
+}
 const base = opt('base') ?? defaultBase(cwd);
 if (!base) {
   console.error('guard: cannot find a base to diff against (no origin/main, origin/master, main or master). Pass one with --base <ref>.');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "guard-my-design-system",
-  "version": "1.0.2",
+  "version": "1.1.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": {
@@ -37,7 +37,7 @@
     "type": "git",
     "url": "git+https://github.com/gregkozakiewicz/guard-my-design-system.git"
   },
-  "homepage": "https://github.com/gregkozakiewicz/guard-my-design-system#readme",
+  "homepage": "https://gregkozakiewicz.github.io/guard-my-design-system/",
   "bugs": {
     "url": "https://github.com/gregkozakiewicz/guard-my-design-system/issues"
   },

package/src/diff.mjs

@@ -11,7 +11,7 @@ import { join } from 'node:path';
 export function defaultBase(cwd) {
   for (const ref of ['origin/main', 'origin/master', 'main', 'master']) {
     try {
-      return execFileSync('git', ['merge-base', 'HEAD', ref], { cwd, encoding: 'utf8' }).trim();
+      return execFileSync('git', ['merge-base', 'HEAD', ref], { cwd, encoding: 'utf8', stdio: ['ignore', 'pipe', 'ignore'] }).trim();
     } catch { /* try the next spelling */ }
   }
   return null;

package/src/judge.mjs

@@ -13,8 +13,20 @@ import {
 } from 'roast-my-design-system/engine';
 
 // Same honesty exemptions the engine applies: email and print styling must be
-// inline, and artwork files carry hex that is drawing, not styling.
-const EXEMPT_FILE_RE = /email|(^|[/.])print([/.]|$)|(^|\/)[\w.-]*(icon|logo|badge|illustration|artwork)[\w.-]*\.(tsx|jsx)$/i;
+// inline, always. Artwork-named files (Icon, Logo, Badge…) are exempt only
+// when their added lines actually draw SVG — a Badge component that is plain
+// styled UI gets guarded like everything else.
+const EMAIL_PRINT_RE = /email|(^|[/.])print([/.]|$)/i;
+const ARTWORK_NAME_RE = /(^|\/)[\w.-]*(icon|logo|badge|illustration|artwork)[\w.-]*\.(tsx|jsx)$/i;
+const SVG_MARKUP_RE = /<(svg|path|rect|circle|ellipse|polygon|defs|mask)\b/i;
+
+function exemptFiles(added) {
+  const svgish = new Set();
+  for (const { file, text } of added) {
+    if (ARTWORK_NAME_RE.test(file) && SVG_MARKUP_RE.test(text)) svgish.add(file);
+  }
+  return (file) => EMAIL_PRINT_RE.test(file) || svgish.has(file);
+}
 
 const FONT_LINE_RE = /font-family\s*:\s*([^;{}]+)/i;
 
@@ -29,9 +41,10 @@ export function judge(added, system) {
   // The system was learned from the tree that already CONTAINS these added
   // lines, so a new value would vouch for itself. A value is only "known"
   // if the repo uses it more times than this change added it.
+  const exempt = exemptFiles(added);
   const addedLengths = new Map(), addedFaces = new Map();
   for (const { file, line, text } of added) {
-    if (EXEMPT_FILE_RE.test(file)) continue;
+    if (exempt(file)) continue;
     const css = isStyleFile(file);
     if (!css && !isCodeFile(file)) continue;
     for (const s of extractStyling(text, { css }).spacing) {
@@ -55,7 +68,7 @@ export function judge(added, system) {
   const findings = [];
 
   for (const { file, line, text } of added) {
-    if (EXEMPT_FILE_RE.test(file)) continue;
+    if (exempt(file)) continue;
     const css = isStyleFile(file);
     if (!css && !isCodeFile(file)) continue;
 
@@ -111,5 +124,15 @@ export function judge(added, system) {
     }
   }
 
-  return findings.sort((a, b) => a.file.localeCompare(b.file) || a.line - b.line);
+  // 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();
+  const deduped = findings.filter((f) => {
+    const key = `${f.file}|${f.line}|${f.kind}|${f.value}`;
+    if (seen.has(key)) return false;
+    seen.add(key);
+    return true;
+  });
+
+  return deduped.sort((a, b) => a.file.localeCompare(b.file) || a.line - b.line);
 }