@vibecheckai/cli 3.5.0 → 3.5.2

package/bin/runners/lib/engines/vibecheck-engines/lib/file-filter.js

@@ -0,0 +1,217 @@
+/**
+ * File Filter
+ *
+ * Central filtering rules for analysis engines.
+ *
+ * Goals:
+ * - Skip generated/build/vendored output
+ * - Skip non-code files
+ * - Skip tests by default (engines can opt-in)
+ */
+
+const path = require("path");
+
+function normalizePath(p) {
+  return (p || "").replace(/\\/g, "/");
+}
+
+const CODE_EXTENSIONS = new Set([".js", ".jsx", ".ts", ".tsx", ".mjs", ".cjs"]);
+
+function isCodeFile(filePath) {
+  const fp = normalizePath(filePath);
+  if (!fp) return false;
+  if (fp.toLowerCase().endsWith(".d.ts")) return false;
+  const ext = path.extname(fp).toLowerCase();
+  return CODE_EXTENSIONS.has(ext);
+}
+
+function looksLikeTestFile(filePath) {
+  const fp = normalizePath(filePath).toLowerCase();
+  const base = path.basename(fp);
+
+  if (
+    fp.includes("/__tests__/") ||
+    fp.includes("/__mocks__/") ||
+    fp.includes("/fixtures/") ||
+    fp.includes("/fixture/") ||
+    fp.includes("/test/") ||
+    fp.includes("/tests/") ||
+    fp.includes("/spec/") ||
+    fp.includes("/e2e/")
+  ) {
+    return true;
+  }
+
+  if (/\.(test|spec|e2e)\.(js|jsx|ts|tsx|mjs|cjs)$/.test(base)) return true;
+
+  if (
+    base === "jest.config.js" ||
+    base === "jest.config.ts" ||
+    base === "vitest.config.ts" ||
+    base === "playwright.config.ts" ||
+    base === "cypress.config.ts"
+  ) {
+    return true;
+  }
+
+  return false;
+}
+
+const EXCLUDED_PATH_SNIPPETS = [
+  "/node_modules/",
+  "/dist/",
+  "/build/",
+  "/out/",
+  "/coverage/",
+  "/.next/",
+  "/.turbo/",
+  "/.cache/",
+  "/.git/",
+  "/vendor/",
+  "/generated/",
+  "/__generated__/",
+  "/codegen/",
+  "/storybook-static/",
+  "/public/",
+  "/static/",
+  "/tmp/",
+  "/temp/",
+  "/bin/",
+  "/scripts/",
+  "/examples/",
+  "/demo/",
+  "/docs/",
+  "/.vscode/",
+  "/.idea/",
+  "/.husky/",
+  "/.github/",
+  "/migrations/",
+  "/prisma/",
+  "/.cursor/",
+  "/.windsurf/",
+  "/.guardrail/",
+  "/.test-cli/",
+  "/_archive/",
+  "/attached_assets/",
+  "/shared/",
+  "/templates/",
+  "/tmp/",
+  "/vscode-extension/",
+];
+
+const EXCLUDED_NAME_PATTERNS = [
+  /\.min\./i,
+  /\.bundle\./i,
+  /-min\./i,
+  /\.generated\./i,
+  /\.gen\./i,
+  /\.d\.ts$/i,
+  /\.map$/i,
+  /\.snap$/i,
+  /\.lock$/i,
+  /^\.env/i,
+  /\.config\.(js|ts|json)$/i,
+  /\.setup\.(js|ts)$/i,
+  /\.test\.(js|ts|jsx|tsx)$/i,
+  /\.spec\.(js|ts|jsx|tsx)$/i,
+  /\.e2e\.(js|ts|jsx|tsx)$/i,
+  /\.stories\.(js|ts|jsx|tsx)$/i,
+  /\.mock\.(js|ts|jsx|tsx)$/i,
+  /\.fixture\.(js|ts|jsx|tsx)$/i,
+];
+
+function shouldExcludeFile(filePath, opts = {}) {
+  const fp = normalizePath(filePath);
+  if (!fp) return true;
+
+  const allowNonCode = Boolean(opts.allowNonCode);
+  const includeTests = Boolean(opts.includeTests);
+
+  const lowered = fp.toLowerCase();
+
+  // Always exclude these
+  if (lowered.endsWith(".map") || lowered.endsWith(".snap") || lowered.endsWith(".lock")) return true;
+  if (lowered.endsWith(".d.ts")) return true;
+
+  if (!allowNonCode && !isCodeFile(fp)) return true;
+
+  for (const snippet of EXCLUDED_PATH_SNIPPETS) {
+    if (lowered.includes(snippet)) return true;
+  }
+
+  const base = path.basename(lowered);
+  for (const re of EXCLUDED_NAME_PATTERNS) {
+    if (re.test(base) || re.test(lowered)) return true;
+  }
+
+  // Skip tests by default
+  if (!includeTests && looksLikeTestFile(fp)) return true;
+
+  return false;
+}
+
+/**
+ * Determine whether a file/code is likely test-only code.
+ * Used to reduce false positives on rules that target production behavior.
+ */
+function isTestContext(code, filePath = "") {
+  const fp = normalizePath(filePath).toLowerCase();
+  if (looksLikeTestFile(fp)) return true;
+
+  if (!code || typeof code !== "string") return false;
+
+  // sample a slice to keep it cheap
+  const head = code.slice(0, 2500);
+  const midStart = Math.max(0, Math.floor(code.length / 2) - 1250);
+  const mid = code.slice(midStart, midStart + 2500);
+  const sample = `${head}\n${mid}`;
+
+  const hints = [
+    /\bdescribe\s*\(/,
+    /\bit\s*\(/,
+    /\btest\s*\(/,
+    /\bexpect\s*\(/,
+    /\b(beforeEach|afterEach|beforeAll|afterAll)\s*\(/,
+    /\bfrom\s+['"]vitest['"]/,
+    /\bfrom\s+['"]@jest\/globals['"]/,
+    /\bfrom\s+['"]mocha['"]/,
+    /\bplaywright\b/i,
+    /\bcypress\b/i,
+    /\bsupertest\b/i,
+    /\bjest\b/i,
+    /\bvitest\b/i,
+  ];
+
+  if (hints.some((re) => re.test(sample))) return true;
+  if (/process\.env\.NODE_ENV\s*===\s*['"]test['"]/.test(sample)) return true;
+
+  return false;
+}
+
+/**
+ * Lightweight opt-out mechanism:
+ *   // vibecheck-ignore
+ *   // vibecheck-ignore(rule-name)
+ */
+function hasIgnoreDirective(code, ruleName) {
+  if (!code || typeof code !== "string") return false;
+
+  // only check the header
+  const header = code.split(/\r?\n/).slice(0, 60).join("\n");
+  if (!/vibecheck-ignore\b/i.test(header)) return false;
+
+  if (!ruleName) return true;
+
+  const escaped = ruleName.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+  const re = new RegExp(`vibecheck-ignore\\s*\\(\\s*${escaped}\\s*\\)`, "i");
+  return re.test(header);
+}
+
+module.exports = {
+  normalizePath,
+  isCodeFile,
+  looksLikeTestFile,
+  shouldExcludeFile,
+  isTestContext,
+  hasIgnoreDirective,
+};