@wbern/obscene 1.4.0 → 1.5.0

package/dist/cli.js

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 
 // src/cli.ts
+import { existsSync, writeFileSync } from "fs";
 import { Command } from "commander";
 
 // src/analyze.ts
@@ -385,6 +386,106 @@ function getNestingDepths(filePaths) {
   }
   return depths;
 }
+var INIT_DIR_RULES = [
+  {
+    dir: ".github",
+    pattern: ".github/**",
+    comment: "GitHub Actions and workflows"
+  },
+  {
+    dir: ".circleci",
+    pattern: ".circleci/**",
+    comment: "CircleCI configuration"
+  },
+  { dir: ".husky", pattern: ".husky/**", comment: "Git hooks" },
+  { dir: ".vscode", pattern: ".vscode/**", comment: "VS Code settings" },
+  { dir: ".idea", pattern: ".idea/**", comment: "JetBrains settings" },
+  {
+    dir: "scripts",
+    pattern: "scripts/**",
+    comment: "Build and utility scripts"
+  },
+  { dir: "docs", pattern: "docs/**", comment: "Documentation" },
+  { dir: "docker", pattern: "docker/**", comment: "Docker configuration" },
+  {
+    dir: "fixtures",
+    pattern: "fixtures/**",
+    comment: "Test fixtures"
+  },
+  {
+    dir: "vendor",
+    pattern: "vendor/**",
+    comment: "Vendored dependencies"
+  }
+];
+var INIT_FILE_RULES = [
+  {
+    test: /\.generated\./,
+    pattern: "*.generated.*",
+    comment: "Generated code"
+  },
+  { test: /\.gen\.[^.]+$/, pattern: "*.gen.*", comment: "Generated code" },
+  {
+    test: /\.config\.\w/,
+    pattern: "*.config.*",
+    comment: "Configuration files"
+  },
+  {
+    test: /(?:^|\/)\.gitlab-ci/,
+    pattern: ".gitlab-ci*",
+    comment: "GitLab CI configuration"
+  }
+];
+function detectIgnorePatterns() {
+  let raw;
+  try {
+    raw = execSync("git ls-files", {
+      maxBuffer: 50 * 1024 * 1024,
+      stdio: ["pipe", "pipe", "pipe"]
+    });
+  } catch {
+    throw new Error("Not a git repository or git is not installed.");
+  }
+  const trackedFiles = raw.toString().split("\n").map((l) => normalizePath(l.trim())).filter(Boolean);
+  const patterns = [];
+  const topDirs = /* @__PURE__ */ new Set();
+  for (const f of trackedFiles) {
+    const slash = f.indexOf("/");
+    if (slash > 0) topDirs.add(f.slice(0, slash));
+  }
+  for (const rule of INIT_DIR_RULES) {
+    if (topDirs.has(rule.dir)) {
+      patterns.push({ pattern: rule.pattern, comment: rule.comment });
+    }
+  }
+  for (const rule of INIT_FILE_RULES) {
+    if (trackedFiles.some((f) => rule.test.test(f))) {
+      patterns.push({ pattern: rule.pattern, comment: rule.comment });
+    }
+  }
+  return patterns;
+}
+function formatIgnoreFile(patterns) {
+  const lines = [
+    "# Generated by obscene init",
+    "# Edit this file to customize which files are excluded from analysis.",
+    "# Patterns use glob syntax (same as .gitignore).",
+    "# See: https://github.com/wbern/obscene#ignore-files",
+    ""
+  ];
+  if (patterns.length === 0) {
+    lines.push("# No project-specific patterns detected.");
+    lines.push("# Add glob patterns here, one per line.");
+    lines.push("");
+  } else {
+    for (const p of patterns) {
+      lines.push(`# ${p.comment}`);
+      lines.push(p.pattern);
+      lines.push("");
+    }
+  }
+  return lines.join("\n");
+}
 var RRF_K = 10;
 function computeComposite(rankings, churn, top) {
   const totalDimensions = Object.keys(rankings).length;
@@ -756,7 +857,7 @@ function formatCompositeTable(output) {
 
 // src/cli.ts
 var program = new Command();
-program.name("obscene").description("Identify hotspot files \u2014 complex code that changes frequently").version("1.4.0");
+program.name("obscene").description("Identify hotspot files \u2014 complex code that changes frequently").version("1.5.0");
 var REPORT_GUIDE = {
   complexity: "Cyclomatic complexity (branch/loop count). NOT a quality judgment \u2014 a 500-line parser will naturally score high. Compare density, not raw values.",
   complexityDensity: "Complexity per line of code. Normalizes for file size. >0.25 suggests dense logic worth reviewing; <0.10 is typical for straightforward code.",
@@ -812,6 +913,13 @@ addSharedOptions(
     exitWithError(err);
   }
 });
+program.command("init").description("generate a starter .obsignore based on project structure").action(() => {
+  try {
+    runInit();
+  } catch (err) {
+    exitWithError(err);
+  }
+});
 function resolveExcludes(cliExcludes) {
   return [...readIgnoreFile(), ...cliExcludes ?? []];
 }
@@ -929,6 +1037,35 @@ function runCoupling(opts) {
 `);
   }
 }
+function runInit() {
+  if (existsSync(".obsignore")) {
+    throw new Error(
+      ".obsignore already exists. Remove it first to regenerate."
+    );
+  }
+  if (existsSync(".obsceneignore")) {
+    throw new Error(
+      ".obsceneignore already exists. Remove it first to regenerate."
+    );
+  }
+  const patterns = detectIgnorePatterns();
+  const content = formatIgnoreFile(patterns);
+  writeFileSync(".obsignore", content);
+  if (patterns.length === 0) {
+    process.stderr.write(
+      "Created .obsignore (no project-specific patterns detected)\n"
+    );
+  } else {
+    process.stderr.write(
+      `Created .obsignore with ${patterns.length} patterns:
+`
+    );
+    for (const p of patterns) {
+      process.stderr.write(`  ${p.pattern.padEnd(20)} ${p.comment}
+`);
+    }
+  }
+}
 function exitWithError(err) {
   const message = err instanceof Error ? err.message : String(err);
   process.stderr.write(`Error: ${message}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wbern/obscene",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Identify hotspot files — complex code that changes frequently. Churn × complexity analysis for any git repo.",
   "type": "module",
   "bin": {