commit-cop 1.0.1 → 1.1.1

package/src/reporter.ts

@@ -1,48 +1,88 @@
+import { PRODUCT_NAME } from "./brand.js";
 import chalk from "chalk";
-import type { Finding } from "./types.js";
+import type { Finding, Severity } from "./types.js";
 
-export function printReport(findings: Finding[], scannedCount: number) {
-  console.log(chalk.bold("\nCommitClean Report\n"));
-  console.log(`Scanned ${scannedCount} staged file(s).\n`);
+const WIDTH = 52;
+
+function line(char = "─"): string {
+  return chalk.dim(char.repeat(WIDTH));
+}
+
+function printHeader(title: string): void {
+  console.log("");
+  console.log(line("═"));
+  console.log(chalk.bold(`  ${title}`));
+  console.log(line("═"));
+}
+
+function printSection(title: string, color: (text: string) => string): void {
+  console.log("");
+  console.log(line());
+  console.log(color(chalk.bold(`  ${title}`)));
+  console.log(line());
+  console.log("");
+}
+
+function printSummary(scannedCount: number, errors: number, warnings: number): void {
+  console.log("");
+  console.log(chalk.dim(`  Scanned ${scannedCount} staged file(s)`));
+  console.log(
+    `  ${chalk.red(`Errors: ${errors}`)}${chalk.dim("  │  ")}${chalk.yellow(`Warnings: ${warnings}`)}`
+  );
+}
+
+function printFinding(finding: Finding, index: number): void {
+  const location = finding.line
+    ? `${finding.file}:${finding.line}`
+    : finding.file;
+
+  const checkLabel = chalk.dim(`[${finding.checkName}]`);
 
-  const errors = findings.filter((f) => f.severity === "error");
-  const warnings = findings.filter((f) => f.severity === "warning");
+  console.log(chalk.bold(`  ${index}.`) + ` ${checkLabel}`);
+  console.log(`     ${chalk.cyan(location)}`);
+  console.log(`     ${finding.message}`);
+
+  if (finding.suggestion) {
+    console.log(chalk.gray(`     → ${finding.suggestion}`));
+  }
 
-  console.log(chalk.red(`Errors: ${errors.length}`));
-  console.log(chalk.yellow(`Warnings: ${warnings.length}`));
   console.log("");
+}
+
+function printFindings(findings: Finding[], severity: Severity): void {
+  const filtered = findings.filter((finding) => finding.severity === severity);
+
+  filtered.forEach((finding, index) => {
+    printFinding(finding, index + 1);
+  });
+}
+
+export function printReport(findings: Finding[], scannedCount: number) {
+  const errors = findings.filter((finding) => finding.severity === "error");
+  const warnings = findings.filter((finding) => finding.severity === "warning");
+
+  printHeader(`${PRODUCT_NAME} Report`);
+  printSummary(scannedCount, errors.length, warnings.length);
 
   if (findings.length === 0) {
-    console.log(chalk.green("✅ No issues found. Commit looks clean.\n"));
+    console.log("");
+    console.log(chalk.green("  ✅ All clear — no issues found in staged files."));
+    console.log("");
+    console.log(line("═"));
+    console.log("");
     return;
   }
 
   if (errors.length > 0) {
-    console.log(chalk.red.bold("❌ Errors"));
-    for (const finding of errors) {
-      printFinding(finding);
-    }
+    printSection(`ERRORS (${errors.length})`, chalk.red);
+    printFindings(findings, "error");
   }
 
   if (warnings.length > 0) {
-    console.log(chalk.yellow.bold("\n⚠️ Warnings"));
-    for (const finding of warnings) {
-      printFinding(finding);
-    }
+    printSection(`WARNINGS (${warnings.length})`, chalk.yellow);
+    printFindings(findings, "warning");
   }
 
+  console.log(line("═"));
   console.log("");
 }
-
-function printFinding(finding: Finding) {
-  const location = finding.line
-    ? `${finding.file}:${finding.line}`
-    : finding.file;
-
-  console.log(`- ${chalk.bold(location)}`);
-  console.log(`  ${finding.message}`);
-
-  if (finding.suggestion) {
-    console.log(chalk.gray(`  Fix: ${finding.suggestion}`));
-  }
-}

package/src/runScan.ts

@@ -0,0 +1,35 @@
+import { PRODUCT_NAME } from "./brand.js";
+import { getStagedFiles } from "./git.js";
+import { runChecks } from "./scanner.js";
+import { printReport } from "./reporter.js";
+
+export async function runScan(
+  strict = false,
+  allowConsoleLog = false
+): Promise<number> {
+  const stagedFiles = getStagedFiles();
+
+  if (stagedFiles.length === 0) {
+    console.log(`${PRODUCT_NAME}: No staged files found.`);
+    return 0;
+  }
+
+  const findings = await runChecks({
+    stagedFiles,
+    strict,
+    allowConsoleLog,
+  });
+
+  printReport(findings, stagedFiles.length);
+
+  const hasErrors = findings.some((finding) => finding.severity === "error");
+  const hasWarnings = findings.some(
+    (finding) => finding.severity === "warning"
+  );
+
+  if (hasErrors || (strict && hasWarnings)) {
+    return 1;
+  }
+
+  return 0;
+}

package/src/scanner.ts

@@ -31,8 +31,11 @@ const checks = [
 
 export async function runChecks(context: CheckContext): Promise<Finding[]> {
   const allFindings: Finding[] = [];
+  const activeChecks = context.allowConsoleLog
+    ? checks.filter((check) => check !== consoleLogCheck)
+    : checks;
 
-  for (const check of checks) {
+  for (const check of activeChecks) {
     const findings = await check.run(context);
     allFindings.push(...findings);
   }

package/src/types.ts

@@ -12,6 +12,11 @@ export type Finding = {
 export type CheckContext = {
   stagedFiles: string[];
   strict: boolean;
+  allowConsoleLog?: boolean;
+};
+
+export type WipFixOptions = {
+  fixConsoleLog?: boolean;
 };
 
 export type Check = {

package/test.ts

@@ -1,2 +1,6 @@
+// Add test cases here, make sure to to
+// git add when you make a change to see CLI in
+// action
 console.log("Hello, world!");
-console.log("Debug log");
+console.log("Debug log");
+console.log("Debug log 2");

package/testing.ts

@@ -0,0 +1,3 @@
+console.log("testingFinal");
+console.log("testingFinal");
+console.log("testingFinal");