stylelint-plugin-rhythmguard 2.0.0 → 2.1.0

package/examples/audit-dashboard.mjs

@@ -0,0 +1,95 @@
+#!/usr/bin/env node
+
+import fs from 'node:fs';
+import path from 'node:path';
+import { createAuditReport, toAuditContractReport } from 'stylelint-plugin-rhythmguard/audit';
+
+function readOption(argv, name, fallback) {
+  const index = argv.indexOf(name);
+  if (index === -1 || !argv[index + 1] || argv[index + 1].startsWith('--')) {
+    return fallback;
+  }
+
+  return argv[index + 1];
+}
+
+function escapeHtml(value) {
+  return String(value)
+    .replace(/&/g, '&')
+    .replace(/</g, '&lt;')
+    .replace(/>/g, '&gt;')
+    .replace(/"/g, '&quot;');
+}
+
+function collectFindings(findings) {
+  return [
+    ...(findings.css || []),
+    ...(findings.tailwind || []),
+    ...(findings.motion || []),
+  ];
+}
+
+function renderMetric(label, value) {
+  return `<article class="metric"><span>${escapeHtml(label)}</span><strong>${escapeHtml(value)}</strong></article>`;
+}
+
+function renderDashboard(contract) {
+  const findings = collectFindings(contract.findings);
+  const topFindings = findings.slice(0, 12);
+  const cleanliness = contract.contracts.scale.cleanliness;
+  const score = typeof cleanliness === 'number' ? cleanliness : contract.summary.cleanliness;
+
+  return `<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<title>Rhythmguard Audit Dashboard</title>
+<style>
+body{font-family:Inter,ui-sans-serif,system-ui,sans-serif;margin:0;background:#f7f8fa;color:#111827;}
+main{max-width:1120px;margin:0 auto;padding:32px 20px;}
+h1{font-size:28px;margin:0 0 8px;}
+p{color:#4b5563;margin:0 0 24px;}
+.metrics{display:grid;grid-template-columns:repeat(auto-fit,minmax(180px,1fr));gap:12px;margin:24px 0;}
+.metric{border:1px solid #d8dde5;background:#fff;border-radius:8px;padding:16px;}
+.metric span{display:block;color:#6b7280;font-size:12px;text-transform:uppercase;}
+.metric strong{display:block;font-size:28px;margin-top:8px;}
+table{width:100%;border-collapse:collapse;background:#fff;border:1px solid #d8dde5;border-radius:8px;overflow:hidden;}
+th,td{text-align:left;border-bottom:1px solid #e5e7eb;padding:10px 12px;font-size:14px;}
+th{background:#f1f5f9;color:#374151;font-size:12px;text-transform:uppercase;}
+tr:last-child td{border-bottom:0;}
+code{font-family:ui-monospace,SFMono-Regular,Menlo,monospace;font-size:12px;}
+</style>
+</head>
+<body>
+<main>
+<h1>Rhythmguard Audit Dashboard</h1>
+<p>${escapeHtml(contract.command.directory)} · ${escapeHtml(contract.command.scanScope)} · schema ${escapeHtml(contract.schemaVersion)}</p>
+<section class="metrics">
+${renderMetric('Scale cleanliness', `${score ?? 100}%`)}
+${renderMetric('CSS files', contract.scanned.cssFiles)}
+${renderMetric('Template files', contract.scanned.templateFiles)}
+${renderMetric('Findings', findings.length)}
+</section>
+<table>
+<thead><tr><th>Type</th><th>File</th><th>Value</th><th>Message</th></tr></thead>
+<tbody>
+${topFindings.map((finding) => `<tr><td>${escapeHtml(finding.type)}</td><td><code>${escapeHtml(finding.file)}</code></td><td><code>${escapeHtml(finding.value || finding.rawValue || '')}</code></td><td>${escapeHtml(finding.message || '')}</td></tr>`).join('\n')}
+</tbody>
+</table>
+</main>
+</body>
+</html>`;
+}
+
+const argv = process.argv.slice(2);
+const dir = readOption(argv, '--dir', argv.find((arg) => !arg.startsWith('--')) || 'src');
+const output = readOption(argv, '--output', 'rhythmguard-dashboard.html');
+const includeMotion = argv.includes('--include-motion');
+
+const report = await createAuditReport({ dir, includeMotion });
+const contract = toAuditContractReport(report);
+const outputPath = path.resolve(process.cwd(), output);
+
+fs.writeFileSync(outputPath, renderDashboard(contract));
+process.stdout.write(`Wrote ${outputPath}\n`);

package/examples/audit-figma-export.mjs

@@ -0,0 +1,81 @@
+#!/usr/bin/env node
+
+import fs from 'node:fs';
+import path from 'node:path';
+import { createAuditReport, toAuditContractReport } from 'stylelint-plugin-rhythmguard/audit';
+
+function readOption(argv, name, fallback) {
+  const index = argv.indexOf(name);
+  if (index === -1 || !argv[index + 1] || argv[index + 1].startsWith('--')) {
+    return fallback;
+  }
+
+  return argv[index + 1];
+}
+
+function collectFindings(findings) {
+  return [
+    ...(findings.css || []),
+    ...(findings.tailwind || []),
+    ...(findings.motion || []),
+  ];
+}
+
+function countBy(items, getKey) {
+  const counts = new Map();
+  for (const item of items) {
+    const key = getKey(item) || 'unknown';
+    counts.set(key, (counts.get(key) || 0) + 1);
+  }
+
+  return [...counts.entries()]
+    .sort((a, b) => b[1] - a[1] || a[0].localeCompare(b[0]))
+    .map(([label, value]) => ({ label, value }));
+}
+
+function buildFigmaPayload(contract) {
+  const findings = collectFindings(contract.findings);
+  const cleanliness = contract.contracts.scale.cleanliness;
+
+  return {
+    schema: 'rhythmguard.figma-export.v1',
+    generatedAt: new Date().toISOString(),
+    source: {
+      directory: contract.command.directory,
+      scanScope: contract.command.scanScope,
+      schemaVersion: contract.schemaVersion,
+    },
+    summaryCards: [
+      {
+        label: 'Scale cleanliness',
+        value: `${typeof cleanliness === 'number' ? cleanliness : contract.summary.cleanliness ?? 100}%`,
+      },
+      { label: 'CSS files', value: contract.scanned.cssFiles },
+      { label: 'Template files', value: contract.scanned.templateFiles },
+      { label: 'Findings', value: findings.length },
+    ],
+    charts: {
+      findingsByType: countBy(findings, (finding) => finding.type),
+      findingsByFile: countBy(findings, (finding) => finding.file).slice(0, 10),
+    },
+    findings: findings.slice(0, 25).map((finding) => ({
+      file: finding.file,
+      line: finding.line || null,
+      message: finding.message || '',
+      type: finding.type,
+      value: finding.value || finding.rawValue || null,
+    })),
+  };
+}
+
+const argv = process.argv.slice(2);
+const dir = readOption(argv, '--dir', argv.find((arg) => !arg.startsWith('--')) || 'src');
+const output = readOption(argv, '--output', 'rhythmguard-figma-export.json');
+const includeMotion = argv.includes('--include-motion');
+
+const report = await createAuditReport({ dir, includeMotion });
+const contract = toAuditContractReport(report);
+const outputPath = path.resolve(process.cwd(), output);
+
+fs.writeFileSync(outputPath, `${JSON.stringify(buildFigmaPayload(contract), null, 2)}\n`);
+process.stdout.write(`Wrote ${outputPath}\n`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stylelint-plugin-rhythmguard",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Token governance for CSS and Tailwind — enforce spacing scales, require design tokens, catch arbitrary values",
   "bin": {
     "rhythmguard": "src/cli/index.js"
@@ -20,76 +20,95 @@
   ],
   "type": "commonjs",
   "main": "src/index.js",
+  "types": "./types/index.d.ts",
   "exports": {
     ".": {
+      "types": "./types/index.d.ts",
       "require": "./src/index.js",
       "import": "./src/index.mjs"
     },
     "./configs/recommended": {
+      "types": "./types/config.d.ts",
       "require": "./src/configs/recommended.js",
       "import": "./src/configs/recommended.mjs"
     },
     "./configs/strict": {
+      "types": "./types/config.d.ts",
       "require": "./src/configs/strict.js",
       "import": "./src/configs/strict.mjs"
     },
     "./configs/tailwind": {
+      "types": "./types/config.d.ts",
       "require": "./src/configs/tailwind.js",
       "import": "./src/configs/tailwind.mjs"
     },
     "./configs/expanded": {
+      "types": "./types/config.d.ts",
       "require": "./src/configs/expanded.js",
       "import": "./src/configs/expanded.mjs"
     },
     "./configs/logical": {
+      "types": "./types/config.d.ts",
       "require": "./src/configs/logical.js",
       "import": "./src/configs/logical.mjs"
     },
     "./configs/migration": {
+      "types": "./types/config.d.ts",
       "require": "./src/configs/migration.js",
       "import": "./src/configs/migration.mjs"
     },
     "./configs/motion": {
+      "types": "./types/config.d.ts",
       "require": "./src/configs/motion.js",
       "import": "./src/configs/motion.mjs"
     },
     "./configs/react-tailwind": {
+      "types": "./types/config.d.ts",
       "require": "./src/configs/react-tailwind.js",
       "import": "./src/configs/react-tailwind.mjs"
     },
     "./presets": {
+      "types": "./types/presets.d.ts",
       "require": "./src/presets/index.js",
       "import": "./src/presets/index.mjs"
     },
     "./audit": {
+      "types": "./types/audit.d.ts",
       "require": "./src/audit/index.js",
       "import": "./src/audit/index.mjs"
     },
     "./rules/use-scale": {
+      "types": "./types/rule.d.ts",
       "require": "./src/rules/use-scale/index.js",
       "import": "./src/rules/use-scale/index.mjs"
     },
     "./rules/prefer-token": {
+      "types": "./types/rule.d.ts",
       "require": "./src/rules/prefer-token/index.js",
       "import": "./src/rules/prefer-token/index.mjs"
     },
     "./rules/no-offscale-transform": {
+      "types": "./types/rule.d.ts",
       "require": "./src/rules/no-offscale-transform/index.js",
       "import": "./src/rules/no-offscale-transform/index.mjs"
     },
     "./rules/use-motion-scale": {
+      "types": "./types/rule.d.ts",
       "require": "./src/rules/use-motion-scale/index.js",
       "import": "./src/rules/use-motion-scale/index.mjs"
     },
     "./eslint": {
+      "types": "./types/eslint.d.ts",
       "require": "./src/eslint/index.js",
       "import": "./src/eslint/index.mjs"
     }
   },
   "files": [
+    "examples",
     "scales",
     "schemas",
     "src",
+    "types",
     "README.md",
     "CHANGELOG.md",
     "CONTRIBUTING.md",
@@ -102,16 +121,17 @@
     "lint": "eslint .",
     "scales:add": "node scripts/scales/add-scale.mjs",
     "scales:validate": "node scripts/scales/validate-community-scales.mjs",
-    "test:pack-smoke": "node scripts/ci/pack-smoke.mjs",
-    "test:npm-smoke": "node scripts/ci/npm-registry-smoke.mjs --package stylelint-plugin-rhythmguard --version latest",
     "test": "node --test test/*.test.js",
     "test:compat-floor": "node --test test/floor-compat.test.js",
+    "test:coverage": "c8 --reporter=text --reporter=lcov node --test test/*.test.js",
+    "test:npm-smoke": "node scripts/ci/npm-registry-smoke.mjs --package stylelint-plugin-rhythmguard --version latest",
+    "test:pack-smoke": "node scripts/ci/pack-smoke.mjs",
     "test:watch": "node --test --watch test/*.test.js",
-    "test:coverage": "c8 --reporter=text --reporter=lcov node --test test/*.test.js"
+    "typecheck": "tsc -p tsconfig.typecheck.json"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/PetriLahdelma/stylelint-plugin-rhythmguard"
+    "url": "git+https://github.com/PetriLahdelma/stylelint-plugin-rhythmguard.git"
   },
   "homepage": "https://github.com/petrilahdelma/stylelint-plugin-rhythmguard#readme",
   "bugs": {
@@ -128,13 +148,15 @@
   },
   "devDependencies": {
     "@eslint/js": "^9.22.0",
+    "@types/node": "^22.20.1",
     "c8": "^10.1.3",
     "eslint": "^9.22.0",
     "geist": "^1.7.0",
     "postcss-value-parser": "^4.2.0",
     "stylelint": "^16.15.0",
+    "stylelint-plugin-logical-css": "^2.0.2",
     "stylelint-scales": "^5.0.0",
-    "stylelint-plugin-logical-css": "^2.0.2"
+    "typescript": "^5.9.3"
   },
   "engines": {
     "node": ">=18.18.0"