@controlfront/detect 0.0.1

package/bin/cfb.js

@@ -0,0 +1,202 @@
+#!/usr/bin/env node
+
+import { Command } from "commander";
+import dotenv from "dotenv";
+import https from "https";
+import { runInit } from "../src/commands/init.js";
+import { runLogin } from "../src/commands/login.js";
+import { runLogout } from "../src/commands/logout.js";
+import { runScan } from "../src/commands/scan.js";
+import { runSync } from "../src/commands/sync.js";
+dotenv.config();
+
+import { createRequire } from "module";
+const require = createRequire(import.meta.url);
+const { version } = require("../package.json");
+
+const program = new Command();
+
+program.name("cf").description("ControlFront CLI").version(version);
+
+program
+  .command("scan")
+  .description("Run a local scan scan")
+  .option("--baseline", "Perform baseline scan instead of snapshot scan")
+  .option("--snapshot", "Perform snapshot scan instead of baseline scan")
+  .option("--sync", "Also sync the scan after scanning")
+  .option("--no-web-open", "Sync but do not open browser afterward")
+  .option(
+    "--changed-files <files>",
+    "Comma-separated list of changed files via GitHub commit/PR (optional)"
+  )
+  .option(
+    "--slug <slug>",
+    "Custom slug for CI scans (e.g. ci, ci-install, local)"
+  )
+  .option("--commit <sha>", "Run scan against a specific commit SHA")
+  .option(
+    "--make-baseline",
+    "Promote this scan's snapshot to become the active baseline"
+  )
+  .option(
+    "--last-90-days-all",
+    "Run a snapshot scan for every commit in the last 90 days"
+  )
+  .option(
+    "--last-180-days-all",
+    "Run a snapshot scan for every commit in the last 180 days"
+  )
+  .option(
+    "--range-sha <from,to>",
+    "Run a snapshot scan for every commit between two SHAs (inclusive), e.g. --range-sha abc123,def456"
+  )
+  .option(
+    "--range-date <from,to>",
+    "Run a snapshot scan for every commit between two dates (inclusive), e.g. --range-date 2025-01-01,2025-01-15"
+  )
+  .option(
+    "--last-commit",
+    "CI mode: snapshot HEAD (GITHUB_SHA) and sync immediately. Use in GitHub Actions with CF_INGEST_TOKEN, CF_PROJECT_ID, CF_WORKSPACE_ID."
+  )
+  .action((options) => {
+    const sync = options.sync;
+    const openWeb = options.webOpen !== false;
+    const changedFiles = options.changedFiles
+      ? options.changedFiles.split(",").filter(Boolean)
+      : undefined;
+    const slug = options.slug;
+
+    const makeBaseline = options.makeBaseline === true;
+    const last90DaysAll = options.last90DaysAll === true;
+    const last180DaysAll = options.last180DaysAll === true;
+    const rangeSha = options.rangeSha;
+    const rangeDate = options.rangeDate;
+    const lastCommit = options.lastCommit === true;
+
+    const snapshot = options.snapshot === true;
+
+    // Legacy compatibility: --baseline implies snapshot + make-baseline
+    if (options.baseline === true) {
+      console.warn(
+        "⚠️  --baseline is deprecated. Use --snapshot --make-baseline instead."
+      );
+    }
+
+    // --last-commit: CI shorthand — snapshot HEAD + sync, no backfill allowed
+    if (lastCommit) {
+      runScan({
+        lastCommit: true,
+        snapshot: true,
+        sync: true,
+        slug: slug || "ci",
+        openWeb: false,
+      });
+      return;
+    }
+
+    if (!snapshot && !options.baseline && !last90DaysAll && !last180DaysAll && !rangeSha && !rangeDate) {
+      console.error("❌ You must specify --snapshot or --last-commit.");
+      process.exit(1);
+    }
+
+    if (rangeSha) {
+      const [fromSha, toSha] = rangeSha.split(",").map((s) => s.trim());
+      if (!fromSha || !toSha) {
+        console.error("❌ --range-sha requires two comma-separated SHAs, e.g. --range-sha abc123,def456");
+        process.exit(1);
+      }
+      runScan({
+        sync,
+        openWeb,
+        changedFiles,
+        slug,
+        snapshot: true,
+        makeBaseline,
+        rangeFromSha: fromSha,
+        rangeToSha: toSha,
+      });
+      return;
+    }
+
+    if (rangeDate) {
+      const [fromDate, toDate] = rangeDate.split(",").map((s) => s.trim());
+      if (!fromDate || !toDate) {
+        console.error("❌ --range-date requires two comma-separated dates, e.g. --range-date 2025-01-01,2025-01-15");
+        process.exit(1);
+      }
+      runScan({
+        sync,
+        openWeb,
+        changedFiles,
+        slug,
+        snapshot: true,
+        makeBaseline,
+        rangeFromDate: fromDate,
+        rangeToDate: toDate,
+      });
+      return;
+    }
+
+    runScan({
+      sync,
+      openWeb,
+      changedFiles,
+      slug,
+      snapshot: true,
+      makeBaseline,
+    });
+  });
+
+program
+  .command("sync")
+  .description("Sync scan report to ControlFront web app")
+  .action(runSync);
+
+program
+  .command("login")
+  .description("Log into your ControlFront account")
+  .option("--prod", "Login to production environment (default: development/localhost)")
+  .action((options) => runLogin(options));
+
+program
+  .command("init")
+  .description("Initialize workspace and project for CLI use")
+  .action(runInit);
+
+program
+  .command("logout")
+  .description("Log out of your ControlFront account")
+  .action(runLogout);
+
+program.parse();
+
+async function checkForUpdates() {
+  const currentVersion = version;
+  const url = "https://registry.npmjs.workspace/@controlfront/cli/latest";
+
+  https
+    .get(url, (res) => {
+      let data = "";
+      res.on("data", (chunk) => {
+        data += chunk;
+      });
+      res.on("end", () => {
+        try {
+          const json = JSON.parse(data);
+          const latest = json.version;
+          if (latest && latest !== currentVersion) {
+            console.log(
+              `⚠️  A newer version of cf is available: ${latest} (you have ${currentVersion}). Update with: npm install -g @controlfront/cli`
+            );
+          }
+        } catch (e) {
+          // ignore JSON parse errors
+        }
+      });
+    })
+    .on("error", () => {
+      // ignore errors
+    });
+}
+
+checkForUpdates();

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@controlfront/detect",
+  "version": "0.0.1",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "CLI tool for running ControlFront baseline scans and syncing with the ControlFront.io web app",
+  "bin": {
+    "cfdetect": "bin/cfb.js",
+    "controlfront-detect": "bin/cfb.js"
+  },
+  "type": "module",
+  "files": [
+    "bin/",
+    "src/commands/",
+    "src/config/",
+    "src/engine/",
+    "src/baseline/",
+    "src/utils/",
+    "src/rules/core/",
+    "src/lib/",
+    "src/data/",
+    "!src/rules/dev/",
+    "!*.env"
+  ],
+  "scripts": {
+    "start": "node ./bin/cfb.js",
+    "init": "node ./bin/cfb.js init",
+    "sync": "node ./bin/cfb.js sync",
+    "login": "node ./bin/cfb.js login",
+    "dev": "nodemon ./bin/cfb.js"
+  },
+  "keywords": [
+    "controlfront",
+    "cli",
+    "ui-governance",
+    "ai-governance",
+    "frontend-governance"
+  ],
+  "author": "ControlFront",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/controlfront/controlfront-cli-baseline.git"
+  },
+  "dependencies": {
+    "@babel/parser": "^7.25.7",
+    "@babel/traverse": "^7.25.7",
+    "chalk": "^5.3.0",
+    "commander": "^14.0.0",
+    "dotenv": "^16.4.5",
+    "fast-glob": "^3.3.3",
+    "jsonwebtoken": "^9.0.2",
+    "micromatch": "^4.0.8",
+    "node-fetch": "^3.3.2",
+    "open": "^9.1.0",
+    "postcss": "^8.4.31",
+    "postcss-safe-parser": "^6.0.0",
+    "prompts": "^2.4.2",
+    "yaml": "^2.8.0"
+  },
+  "packageManager": "pnpm@10.5.2+sha512.da9dc28cd3ff40d0592188235ab25d3202add8a207afbedc682220e4a0029ffbff4562102b9e6e46b4e3f9e8bd53e6d05de48544b0c57d4b0179e22c76d1199b"
+}

package/src/commands/baseline.js

@@ -0,0 +1,198 @@
+// =============================================================
+//  ControlFront CLI — Baseline Mode
+//  Purpose: Establish structural baseline only (no drift compare)
+// =============================================================
+import fs from "fs";
+import micromatch from "micromatch";
+import path from "path";
+import inferCatalog from "../baseline/components/inferCatalog.js";
+import { execSync } from "child_process";
+
+// -------------------------------------------------------------
+//  Default Exclude Patterns
+// -------------------------------------------------------------
+const DEFAULT_EXCLUDE_PATTERNS = [
+  // build + vendor dirs
+  "**/node_modules/**",
+  "**/dist/**",
+  "**/build/**",
+  "**/.next/**",
+  "**/.turbo/**",
+  "**/coverage/**",
+  "**/.git/**",
+  "**/public/**",
+  "**/.cache/**",
+  "**/out/**",
+
+  // tests + stories
+  "**/*.test.*",
+  "**/*.spec.*",
+  "**/*.stories.*",
+  "**/*.d.ts",
+  "**/__mocks__/**",
+  "**/__tests__/**",
+
+  // CF artifacts (exclude everywhere in repo)
+  "**/baseline-structural.json",
+  "**/baseline-styles.json",
+  "**/baseline-components.json",
+  "**/baseline-outliers.json",
+  "**/baseline-structural-outliers.json",
+  "**/baseline-style-outliers.json",
+  "**/baseline-components-outliers.json",
+  "**/baseline.json",
+  "**/scan-report.json",
+  "**/cf-violations.json",
+  "**/insights.json",
+  "**/.cf/**",
+
+  // logs + env
+  "*.log",
+  ".env",
+  ".env.*",
+
+  // lockfiles
+  "package-lock.json",
+  "yarn.lock",
+  "pnpm-lock.yaml",
+
+  // big config JSONs (skip, not relevant to UI/CD)
+  "turbo.json",
+  "tsconfig*.json",
+  "package.json",
+
+  // misc config not relevant
+  "vite.config.*",
+  "next.config.*",
+  "tailwind.config.*",
+  "babel.config.*",
+  "postcss.config.*",
+  ".eslintrc.*",
+  ".prettierrc.*",
+  ".stylelintrc.*",
+  ".npmrc",
+  ".nvmrc",
+  ".DS_Store",
+];
+
+// -------------------------------------------------------------
+//  File Collection + Exclusions
+// -------------------------------------------------------------
+function getAllFiles(
+  dir,
+  exts = [
+    ".js",
+    ".ts",
+    ".jsx",
+    ".tsx",
+    ".css",
+    ".scss",
+    ".sass",
+    ".less",
+    ".styl",
+    ".vue",
+    ".svelte",
+    ".astro",
+    ".html",
+    ".htm",
+    ".mdx",
+    ".md",
+    ".json",
+    ".jsonc",
+    ".yml",
+    ".yaml",
+    ".cjs",
+    ".mjs",
+  ],
+  files = [],
+  excludePatterns = DEFAULT_EXCLUDE_PATTERNS,
+  baseDir = process.cwd()
+) {
+  const entries = fs.readdirSync(dir, { withFileTypes: true });
+
+  for (const entry of entries) {
+    const fullPath = path.join(dir, entry.name);
+    const relativePath = path.relative(baseDir, fullPath).replace(/\\/g, "/");
+
+    if (excludePatterns.length) {
+      const isExcluded = micromatch.isMatch(relativePath, excludePatterns, {
+        nocase: true,
+      });
+      // console.log(`Checking ${relativePath}, excluded: ${isExcluded}`);
+      if (isExcluded) {
+        continue;
+      }
+    }
+
+    if (entry.isDirectory()) {
+      getAllFiles(fullPath, exts, files, excludePatterns, baseDir);
+    } else if (exts.includes(path.extname(entry.name))) {
+      files.push(fullPath);
+    }
+  }
+
+  return files;
+}
+
+// =============================================================
+//  ControlFront CLI — Baseline Mode
+//  Purpose: Establish structural baseline only (no drift compare)
+// =============================================================
+
+export async function runBaseline({ files } = {}) {
+  if (!files) {
+    files = getAllFiles(process.cwd());
+  }
+
+  const cssFiles = files.filter((f) => /\.(css|scss|sass|less|styl)$/.test(f));
+  const codeFiles = files.filter((f) => /\.(js|jsx|ts|tsx)$/.test(f));
+  const jsonFiles = files.filter((f) => /\.json$/.test(f));
+
+  const { buildStructuralBaseline } = await import(
+    "../baseline/structural/buildStructuralBaseline.js"
+  );
+  const { buildComponentsBaseline } = await import(
+    "../baseline/components/buildComponentsBaseline.js"
+  );
+  const { buildStylesBaseline } = await import(
+    "../baseline/styles/buildStylesBaseline.js"
+  );
+
+  const catalog = await inferCatalog(codeFiles);
+
+  const structuralBaseline = await buildStructuralBaseline({ files });
+  const componentsBaseline = await buildComponentsBaseline({ files: codeFiles, catalog });
+  const stylesBaseline = await buildStylesBaseline({ cssFiles, codeFiles, jsonFiles });
+
+  let commit_sha = null;
+  let commit_author = null;
+  let commit_timestamp = null;
+  let commit_branch = null;
+  let commit_message = null;
+
+  try {
+    commit_sha = execSync("git rev-parse HEAD").toString().trim();
+    commit_author = execSync("git log -1 --pretty=format:%an").toString().trim();
+    commit_timestamp = execSync("git log -1 --pretty=format:%cI").toString().trim();
+    commit_branch = execSync("git rev-parse --abbrev-ref HEAD").toString().trim();
+    commit_message = execSync("git log -1 --pretty=format:%s").toString().trim();
+  } catch {}
+
+  return {
+    summary: {
+      baseline: {
+        metrics: {
+          commit_sha,
+          commit_author,
+          commit_timestamp,
+          commit_branch,
+          commit_message,
+        },
+        details: {}
+      }
+    },
+    structural: structuralBaseline,
+    components: componentsBaseline,
+    styles: stylesBaseline,
+  };
+}