canicode 0.3.3 → 0.4.1

package/README.md

@@ -144,33 +144,6 @@ canicode analyze <url> --preset strict
 
 </details>
 
-<details>
-<summary><strong>Custom Rules</strong></summary>
-
-Add project-specific checks via a JSON file:
-
-```bash
-canicode analyze <url> --custom-rules ./my-rules.json
-```
-
-```json
-[
-  {
-    "id": "icon-missing-component",
-    "category": "component",
-    "severity": "blocking",
-    "score": -10,
-    "prompt": "Check if this node is an icon and is not a component.",
-    "why": "Icons that are not components cannot be reused.",
-    "impact": "Developers will hardcode icons.",
-    "fix": "Convert to a component and publish to the library."
-  }
-]
-```
-
-See [`examples/custom-rules.json`](examples/custom-rules.json) | Run `canicode docs rules`
-
-</details>
 
 <details>
 <summary><strong>Config Overrides</strong></summary>
@@ -308,9 +281,10 @@ pnpm lint       # type check
 
 - [x] **Phase 1** — 39 rules, density-based scoring, HTML reports, presets, scoped analysis
 - [x] **Phase 2** — 4-agent calibration pipeline, `/calibrate-loop` debate loop
-- [x] **Phase 3** — Custom rules, config overrides, MCP server, Claude Skills
+- [x] **Phase 3** — Config overrides, MCP server, Claude Skills
 - [x] **Phase 4** — Figma comment from report (per-issue "Comment" button in HTML report, posts to Figma node via API)
-- [ ] **Phase 5** — Screenshot comparison (Figma vs AI-generated code, visual diff)
+- [ ] **Phase 5** — Custom rules with pattern matching (node name/type/attribute conditions)
+- [ ] **Phase 6** — Screenshot comparison (Figma vs AI-generated code, visual diff)
 
 ## License
 

package/dist/cli/index.js

@@ -7,6 +7,204 @@ import cac from 'cac';
 import { z } from 'zod';
 import { homedir } from 'os';
 
+var __defProp = Object.defineProperty;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __esm = (fn, res) => function __init() {
+  return fn && (res = (0, fn[__getOwnPropNames(fn)[0]])(fn = 0)), res;
+};
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+
+// src/monitoring/browser.ts
+var browser_exports = {};
+__export(browser_exports, {
+  initBrowserMonitoring: () => initBrowserMonitoring,
+  shutdownBrowserMonitoring: () => shutdownBrowserMonitoring,
+  trackBrowserError: () => trackBrowserError,
+  trackBrowserEvent: () => trackBrowserEvent
+});
+function getGlobal() {
+  return globalThis;
+}
+function injectScript(src) {
+  return new Promise((resolve7, reject) => {
+    const g = getGlobal();
+    const doc = g["document"];
+    if (!doc) {
+      resolve7();
+      return;
+    }
+    const script = doc["createElement"]("script");
+    script["src"] = src;
+    script["async"] = true;
+    script["onload"] = () => resolve7();
+    script["onerror"] = () => reject(new Error(`Failed to load script: ${src}`));
+    doc["head"]["appendChild"](script);
+  });
+}
+async function initBrowserMonitoring(config2) {
+  if (config2.enabled === false) return;
+  const g = getGlobal();
+  if (!g["document"]) return;
+  monitoringEnabled = true;
+  if (config2.posthogApiKey) {
+    try {
+      await injectScript("https://us-assets.i.posthog.com/static/array.js");
+      g["posthog"]?.["init"]?.(config2.posthogApiKey, {
+        api_host: "https://us.i.posthog.com",
+        autocapture: false,
+        capture_pageview: true
+      });
+    } catch {
+    }
+  }
+  if (config2.sentryDsn) {
+    try {
+      await injectScript("https://browser.sentry-cdn.com/8.0.0/bundle.min.js");
+      g["Sentry"]?.["init"]?.({
+        dsn: config2.sentryDsn,
+        environment: config2.environment ?? "web",
+        release: config2.version,
+        tracesSampleRate: 0
+      });
+    } catch {
+    }
+  }
+}
+function trackBrowserEvent(event, properties) {
+  if (!monitoringEnabled) return;
+  try {
+    getGlobal()["posthog"]?.["capture"]?.(event, properties);
+  } catch {
+  }
+}
+function trackBrowserError(error, context) {
+  if (!monitoringEnabled) return;
+  try {
+    getGlobal()["Sentry"]?.["captureException"]?.(
+      error,
+      context ? { extra: context } : void 0
+    );
+  } catch {
+  }
+  try {
+    getGlobal()["posthog"]?.["capture"]?.("error", {
+      error: error.message,
+      ...context
+    });
+  } catch {
+  }
+}
+async function shutdownBrowserMonitoring() {
+  monitoringEnabled = false;
+}
+var monitoringEnabled;
+var init_browser = __esm({
+  "src/monitoring/browser.ts"() {
+    monitoringEnabled = false;
+  }
+});
+
+// src/monitoring/node.ts
+var node_exports = {};
+__export(node_exports, {
+  initNodeMonitoring: () => initNodeMonitoring,
+  shutdownNodeMonitoring: () => shutdownNodeMonitoring,
+  trackNodeError: () => trackNodeError,
+  trackNodeEvent: () => trackNodeEvent
+});
+async function initNodeMonitoring(config2) {
+  if (config2.enabled === false) return;
+  monitoringEnabled2 = true;
+  commonProps = {
+    _sdk: "canicode",
+    _sdk_version: config2.version ?? "unknown",
+    _env: config2.environment ?? "unknown"
+  };
+  if (config2.posthogApiKey) {
+    try {
+      const mod = await import('posthog-node');
+      const PostHog = mod.PostHog;
+      posthogClient = new PostHog(config2.posthogApiKey, {
+        host: "https://us.i.posthog.com",
+        flushAt: 10,
+        flushInterval: 1e4
+      });
+    } catch {
+    }
+  }
+  if (config2.sentryDsn) {
+    try {
+      const mod = await import('@sentry/node');
+      sentryModule = mod;
+      sentryModule.init({
+        dsn: config2.sentryDsn,
+        environment: config2.environment ?? "cli",
+        release: config2.version,
+        tracesSampleRate: 0
+      });
+    } catch {
+    }
+  }
+}
+function trackNodeEvent(event, properties) {
+  if (!monitoringEnabled2 || !posthogClient) return;
+  try {
+    const captureOpts = {
+      distinctId: "anonymous",
+      event
+    };
+    captureOpts.properties = { ...commonProps, ...properties };
+    posthogClient.capture(captureOpts);
+  } catch {
+  }
+}
+function trackNodeError(error, context) {
+  if (!monitoringEnabled2) return;
+  try {
+    sentryModule?.captureException(error, context ? { extra: context } : void 0);
+  } catch {
+  }
+  try {
+    posthogClient?.capture({
+      distinctId: "anonymous",
+      event: "cic_error",
+      properties: { ...commonProps, error: error.message, ...context }
+    });
+  } catch {
+  }
+}
+async function shutdownNodeMonitoring() {
+  if (!monitoringEnabled2) return;
+  const tasks = [];
+  if (posthogClient) {
+    tasks.push(
+      posthogClient.shutdown().catch(() => {
+      })
+    );
+  }
+  if (sentryModule) {
+    tasks.push(
+      sentryModule.close(2e3).catch(() => {
+      })
+    );
+  }
+  await Promise.allSettled(tasks);
+  posthogClient = null;
+  sentryModule = null;
+  monitoringEnabled2 = false;
+}
+var posthogClient, sentryModule, monitoringEnabled2, commonProps;
+var init_node = __esm({
+  "src/monitoring/node.ts"() {
+    posthogClient = null;
+    sentryModule = null;
+    monitoringEnabled2 = false;
+    commonProps = {};
+  }
+});
 z.object({
   fileKey: z.string(),
   nodeId: z.string().optional(),
@@ -1033,6 +1231,20 @@ function getReportsDir() {
 function ensureReportsDir() {
   ensureDir(REPORTS_DIR);
 }
+function getTelemetryEnabled() {
+  return readConfig().telemetry !== false;
+}
+function setTelemetryEnabled(enabled) {
+  const config2 = readConfig();
+  config2.telemetry = enabled;
+  writeConfig(config2);
+}
+function getPosthogApiKey() {
+  return process.env["POSTHOG_API_KEY"] ?? readConfig().posthogApiKey;
+}
+function getSentryDsn() {
+  return process.env["SENTRY_DSN"] ?? readConfig().sentryDsn;
+}
 function initAiready(token) {
   setFigmaToken(token);
   ensureReportsDir();
@@ -2818,6 +3030,77 @@ function handleDocs(topic) {
   }
 }
 
+// src/monitoring/events.ts
+var EVENT_PREFIX = "cic_";
+var EVENTS = {
+  // Analysis
+  ANALYSIS_STARTED: `${EVENT_PREFIX}analysis_started`,
+  ANALYSIS_COMPLETED: `${EVENT_PREFIX}analysis_completed`,
+  ANALYSIS_FAILED: `${EVENT_PREFIX}analysis_failed`,
+  // Report
+  REPORT_GENERATED: `${EVENT_PREFIX}report_generated`,
+  COMMENT_POSTED: `${EVENT_PREFIX}comment_posted`,
+  COMMENT_FAILED: `${EVENT_PREFIX}comment_failed`,
+  // MCP
+  MCP_TOOL_CALLED: `${EVENT_PREFIX}mcp_tool_called`,
+  // CLI
+  CLI_COMMAND: `${EVENT_PREFIX}cli_command`,
+  CLI_INIT: `${EVENT_PREFIX}cli_init`
+};
+
+// src/monitoring/index.ts
+var _trackEvent = () => {
+};
+var _trackError = () => {
+};
+var _shutdown = () => Promise.resolve();
+function isBrowser() {
+  const g = globalThis;
+  return typeof g["window"] !== "undefined" && typeof g["document"] !== "undefined";
+}
+async function initMonitoring(config2) {
+  if (config2.enabled === false) return;
+  if (!config2.posthogApiKey && !config2.sentryDsn) return;
+  try {
+    if (isBrowser()) {
+      const { initBrowserMonitoring: initBrowserMonitoring2, trackBrowserEvent: trackBrowserEvent2, trackBrowserError: trackBrowserError2, shutdownBrowserMonitoring: shutdownBrowserMonitoring2 } = await Promise.resolve().then(() => (init_browser(), browser_exports));
+      await initBrowserMonitoring2(config2);
+      _trackEvent = trackBrowserEvent2;
+      _trackError = trackBrowserError2;
+      _shutdown = shutdownBrowserMonitoring2;
+    } else {
+      const { initNodeMonitoring: initNodeMonitoring2, trackNodeEvent: trackNodeEvent2, trackNodeError: trackNodeError2, shutdownNodeMonitoring: shutdownNodeMonitoring2 } = await Promise.resolve().then(() => (init_node(), node_exports));
+      await initNodeMonitoring2(config2);
+      _trackEvent = trackNodeEvent2;
+      _trackError = trackNodeError2;
+      _shutdown = shutdownNodeMonitoring2;
+    }
+  } catch {
+  }
+}
+function trackEvent(event, properties) {
+  try {
+    _trackEvent(event, properties);
+  } catch {
+  }
+}
+function trackError(error, context) {
+  try {
+    _trackError(error, context);
+  } catch {
+  }
+}
+async function shutdownMonitoring() {
+  try {
+    await _shutdown();
+  } catch {
+  }
+}
+
+// src/monitoring/keys.ts
+var POSTHOG_API_KEY = "phc_rBFeG140KqJLpUnlpYDEFgdMM6JozZeqQsf9twXf5Dq" ;
+var SENTRY_DSN = "https://80a836a8300b25f17ef5bbf23afb5b3a@o4511080656207872.ingest.us.sentry.io/4511080661319680" ;
+
 // src/rules/layout/index.ts
 function isContainerNode(node) {
   return node.type === "FRAME" || node.type === "GROUP" || node.type === "COMPONENT";
@@ -3987,6 +4270,23 @@ defineRule({
 // src/cli/index.ts
 config();
 var cli = cac("canicode");
+{
+  const monitoringConfig = {
+    environment: "cli",
+    version: "0.3.3",
+    enabled: getTelemetryEnabled()
+  };
+  const phKey = getPosthogApiKey() || POSTHOG_API_KEY;
+  monitoringConfig.posthogApiKey = phKey;
+  const sDsn = getSentryDsn() || SENTRY_DSN;
+  monitoringConfig.sentryDsn = sDsn;
+  initMonitoring(monitoringConfig).catch(() => {
+  });
+}
+process.on("beforeExit", () => {
+  shutdownMonitoring().catch(() => {
+  });
+});
 var MAX_NODES_WITHOUT_SCOPE = 500;
 function pickRandomScope(root) {
   const candidates = [];
@@ -4019,6 +4319,8 @@ function countNodes2(node) {
   return count;
 }
 cli.command("analyze <input>", "Analyze a Figma file or JSON fixture").option("--preset <preset>", "Analysis preset (relaxed | dev-friendly | ai-ready | strict)").option("--output <path>", "HTML report output path").option("--token <token>", "Figma API token (or use FIGMA_TOKEN env var)").option("--mcp", "Load via Figma MCP (no FIGMA_TOKEN needed)").option("--api", "Load via Figma REST API (requires FIGMA_TOKEN)").option("--screenshot", "Include screenshot comparison in report (requires ANTHROPIC_API_KEY)").option("--custom-rules <path>", "Path to custom rules JSON file").option("--config <path>", "Path to config JSON file (override rule scores/settings)").option("--no-open", "Don't open report in browser after analysis").example("  canicode analyze https://www.figma.com/design/ABC123/MyDesign").example("  canicode analyze https://www.figma.com/design/ABC123/MyDesign --mcp").example("  canicode analyze https://www.figma.com/design/ABC123/MyDesign --api --token YOUR_TOKEN").example("  canicode analyze ./fixtures/design.json --output report.html").example("  canicode analyze ./fixtures/design.json --custom-rules ./my-rules.json").example("  canicode analyze ./fixtures/design.json --config ./my-config.json").action(async (input, options) => {
+  const analysisStart = Date.now();
+  trackEvent(EVENTS.ANALYSIS_STARTED, { source: isJsonFile(input) ? "fixture" : "figma" });
   try {
     if (options.mcp && options.api) {
       throw new Error("Cannot use --mcp and --api together. Choose one.");
@@ -4117,6 +4419,14 @@ Analyzing: ${file.name}`);
     await writeFile(outputPath, html, "utf-8");
     console.log(`
 Report saved: ${outputPath}`);
+    trackEvent(EVENTS.ANALYSIS_COMPLETED, {
+      nodeCount: result.nodeCount,
+      issueCount: result.issues.length,
+      grade: scores.overall.grade,
+      percentage: scores.overall.percentage,
+      duration: Date.now() - analysisStart
+    });
+    trackEvent(EVENTS.REPORT_GENERATED, { format: "html" });
     if (!options.noOpen) {
       const { exec } = await import('child_process');
       const cmd = process.platform === "darwin" ? "open" : process.platform === "win32" ? "start" : "xdg-open";
@@ -4126,6 +4436,14 @@ Report saved: ${outputPath}`);
       process.exit(1);
     }
   } catch (error) {
+    trackError(
+      error instanceof Error ? error : new Error(String(error)),
+      { command: "analyze", input }
+    );
+    trackEvent(EVENTS.ANALYSIS_FAILED, {
+      error: error instanceof Error ? error.message : String(error),
+      duration: Date.now() - analysisStart
+    });
     console.error(
       "\nError:",
       error instanceof Error ? error.message : String(error)
@@ -4382,6 +4700,35 @@ cli.command("init", "Set up canicode (Figma token or MCP)").option("--token <tok
     process.exit(1);
   }
 });
+cli.command("config", "Manage canicode configuration").option("--telemetry", "Enable anonymous telemetry").option("--no-telemetry", "Disable anonymous telemetry").action((options) => {
+  try {
+    if (options.noTelemetry === true) {
+      setTelemetryEnabled(false);
+      console.log("Telemetry disabled. No analytics data will be sent.");
+      return;
+    }
+    if (options.telemetry === true) {
+      setTelemetryEnabled(true);
+      console.log("Telemetry enabled. Only anonymous usage events are tracked \u2014 no design data.");
+      return;
+    }
+    const cfg = readConfig();
+    console.log("CANICODE CONFIG\n");
+    console.log(`  Config path: ${getConfigPath()}`);
+    console.log(`  Figma token: ${cfg.figmaToken ? "set" : "not set"}`);
+    console.log(`  Telemetry:   ${cfg.telemetry !== false ? "enabled" : "disabled"}`);
+    console.log(`
+Options:`);
+    console.log(`  canicode config --no-telemetry    Opt out of anonymous telemetry`);
+    console.log(`  canicode config --telemetry       Opt back in`);
+  } catch (error) {
+    console.error(
+      "\nError:",
+      error instanceof Error ? error.message : String(error)
+    );
+    process.exit(1);
+  }
+});
 cli.command("list-rules", "List all analysis rules with scores and severity").option("--custom-rules <path>", "Include custom rules from JSON file").option("--config <path>", "Apply config overrides to show effective scores").option("--json", "Output as JSON").action(async (options) => {
   try {
     let configs = { ...RULE_CONFIGS };
@@ -4460,7 +4807,6 @@ cli.help((sections) => {
     {
       title: "\nCustomization",
       body: [
-        `  --custom-rules <path>   Add custom rules (see: canicode docs rules)`,
         `  --config <path>         Override rule settings (see: canicode docs config)`
       ].join("\n")
     },
@@ -4470,8 +4816,7 @@ cli.help((sections) => {
         `  $ canicode analyze "https://www.figma.com/design/..." --mcp`,
         `  $ canicode analyze "https://www.figma.com/design/..." --api`,
         `  $ canicode analyze "https://www.figma.com/design/..." --preset strict`,
-        `  $ canicode analyze "https://www.figma.com/design/..." --config ./my-config.json`,
-        `  $ canicode analyze "https://www.figma.com/design/..." --custom-rules ./my-rules.json`
+        `  $ canicode analyze "https://www.figma.com/design/..." --config ./my-config.json`
       ].join("\n")
     },
     {