@staff0rd/assist 0.323.1 → 0.324.0

package/README.md

@@ -166,7 +166,7 @@ The first backlog command in a repository that still has a local `.assist/backlo
 - `assist verify --measure` - After the run, print a summary table of each command's status and duration (slowest first) plus a wall-clock total
 - `assist verify init` - Add verify scripts to a project (writes to `assist.yml` by default; pass `--package-json` to write to `package.json` scripts instead)
 - `assist verify hardcoded-colors` - Check for hardcoded hex colors in src/ (supports `hardcodedColors.ignore` globs in config)
-- `assist verify comment-policy` - Flag comments added on changed lines (staged + unstaged) unless they carry a justification marker; supports `commentPolicy.markers` and `commentPolicy.ignore` globs in config
+- `assist verify block-comments` - Fail on any comment on a changed line (staged + unstaged), whether newly added or edited, reporting each offending file:line; functional machine directives are exempt and `blockComments.ignore` globs in config scope which files are scanned
 - `assist verify forbidden-strings` - Check configured JSON files for disallowed values. Each `forbiddenStrings` rule names a `file`, a list of dot-`paths` to inspect (string or string[] values are scanned; other types skipped), and a `disallowed` wildcard matched via minimatch; any matching value fails the check. Zero rules is a no-op that passes
 - `assist lint [-f, --fix]` - Run lint checks for conventions not enforced by oxlint (use `-f` to auto-fix)
 - `assist lint init` - Initialize oxlint with baseline linter config

package/dist/index.js

@@ -6,7 +6,7 @@ import { Command } from "commander";
 // package.json
 var package_default = {
   name: "@staff0rd/assist",
-  version: "0.323.1",
+  version: "0.324.0",
   type: "module",
   main: "dist/index.js",
   bin: {
@@ -215,9 +215,8 @@ var assistConfigSchema = z2.strictObject({
   hardcodedColors: z2.strictObject({
     ignore: z2.array(z2.string()).default([])
   }).optional(),
-  commentPolicy: z2.strictObject({
-    ignore: z2.array(z2.string()).default([]),
-    markers: z2.array(z2.string()).default(["HACK:", "why:"])
+  blockComments: z2.strictObject({
+    ignore: z2.array(z2.string()).default([])
   }).optional(),
   restructure: z2.strictObject({
     ignore: z2.array(z2.string()).default([])
@@ -1753,13 +1752,13 @@ function lint(options2 = {}) {
 import { execSync as execSync12 } from "child_process";
 import { basename, resolve as resolve5 } from "path";
 
-// src/commands/verify/commentPolicy/findAddedComments.ts
+// src/commands/verify/blockComments/findComments.ts
 import { execSync as execSync6 } from "child_process";
 import fs13 from "fs";
 import { minimatch } from "minimatch";
 import { Project as Project2 } from "ts-morph";
 
-// src/commands/verify/commentPolicy/collectComments.ts
+// src/commands/verify/blockComments/collectComments.ts
 function collectComments(sourceFile) {
   const seen = /* @__PURE__ */ new Set();
   const comments3 = [];
@@ -1796,7 +1795,7 @@ function parseMaintainabilityOverride(content) {
   return void 0;
 }
 
-// src/commands/verify/commentPolicy/isCommentExempt.ts
+// src/commands/verify/blockComments/isCommentExempt.ts
 var MACHINE_DIRECTIVES = [
   "oxlint-disable",
   "oxlint-enable",
@@ -1812,13 +1811,12 @@ var MACHINE_DIRECTIVES = [
   "@vitest-environment",
   MAINTAINABILITY_OVERRIDE_MARKER
 ];
-function isCommentExempt(text6, markers) {
+function isCommentExempt(text6) {
   const lower = text6.toLowerCase();
-  if (MACHINE_DIRECTIVES.some((d) => lower.includes(d))) return true;
-  return markers.some((m) => lower.includes(m.toLowerCase()));
+  return MACHINE_DIRECTIVES.some((d) => lower.includes(d));
 }
 
-// src/commands/verify/commentPolicy/parseDiffAddedLines.ts
+// src/commands/verify/blockComments/parseDiffAddedLines.ts
 var FILE_HEADER = /^\+\+\+ (?:b\/)?(.+)$/;
 var HUNK_HEADER = /^@@ -\d+(?:,\d+)? \+(\d+)(?:,\d+)? @@/;
 function parseDiffAddedLines(diff2) {
@@ -1846,15 +1844,14 @@ function parseDiffAddedLines(diff2) {
       }
       set.add(newLine);
       newLine++;
-    } else if (line.startsWith("-")) {
-    } else {
+    } else if (!line.startsWith("-")) {
       newLine++;
     }
   }
   return added;
 }
 
-// src/commands/verify/commentPolicy/findAddedComments.ts
+// src/commands/verify/blockComments/findComments.ts
 var SOURCE_EXTENSIONS = [".ts", ".tsx", ".cts", ".mts", ".js", ".jsx"];
 function toSingleLine(text6) {
   return text6.replace(/\s+/g, " ").trim();
@@ -1864,7 +1861,7 @@ function shouldScan(file, ignoreGlobs) {
   if (ignoreGlobs.some((glob) => minimatch(file, glob))) return false;
   return fs13.existsSync(file);
 }
-function findAddedComments(options2) {
+function findComments(options2) {
   const diff2 = execSync6("git diff HEAD", {
     encoding: "utf8",
     maxBuffer: 64 * 1024 * 1024
@@ -1881,7 +1878,7 @@ function findAddedComments(options2) {
     for (const { pos, text: text6 } of collectComments(sourceFile)) {
       const { line } = sourceFile.getLineAndColumnAtPos(pos);
       if (!lines.has(line)) continue;
-      if (isCommentExempt(text6, options2.markers)) continue;
+      if (isCommentExempt(text6)) continue;
       findings.push({ file, line, text: toSingleLine(text6) });
     }
   }
@@ -1889,29 +1886,22 @@ function findAddedComments(options2) {
   return findings;
 }
 
-// src/commands/verify/commentPolicy/index.ts
-var DEFAULT_MARKERS = ["HACK:", "why:"];
-function commentPolicy() {
-  const config = loadConfig().commentPolicy;
-  const markers = config?.markers ?? DEFAULT_MARKERS;
-  const ignoreGlobs = config?.ignore ?? [];
-  const findings = findAddedComments({ markers, ignoreGlobs });
+// src/commands/verify/blockComments/index.ts
+function blockComments() {
+  const ignoreGlobs = loadConfig().blockComments?.ignore ?? [];
+  const findings = findComments({ ignoreGlobs });
   if (findings.length === 0) {
-    console.log("No undocumented comments on changed lines.");
+    console.log("No comments on changed lines.");
     process.exit(0);
   }
-  console.log("Comments added on changed lines:\n");
+  console.log("Comments on changed lines:\n");
   for (const { file, line, text: text6 } of findings) {
     console.log(`${file}:${line} \u2192 ${text6}`);
   }
   console.log(`
 Total: ${findings.length} comment(s)`);
   console.log(
-    "\nDon't comment standard logic or syntax \u2014 only unintuitive complexity or a hack."
-  );
-  console.log("Prefer self-documenting code.");
-  console.log(
-    `Remove each comment, or justify it inline with a ${markers.map((m) => `'${m}'`).join(" or ")} marker.`
+    "\nEvery comment on a changed line fails this gate, whether you added or edited it. Remove them and let the code document itself."
   );
   process.exit(1);
 }
@@ -18894,7 +18884,9 @@ function registerVerify(program2) {
     "Write scripts to package.json instead of assist.yml"
   ).action(init3);
   verifyCommand.command("hardcoded-colors").description("Check for hardcoded hex colors in src/").action(hardcodedColors);
-  verifyCommand.command("comment-policy").description("Check for undocumented comments added on changed lines").action(commentPolicy);
+  verifyCommand.command("block-comments").description(
+    "Fail on any comment on a changed line, whether added or edited"
+  ).action(blockComments);
   verifyCommand.command("no-venv").description("Check that no venv folders exist in the repo").action(noVenv);
   verifyCommand.command("forbidden-strings").description(
     "Check configured JSON files for values matching forbiddenStrings rules"

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@staff0rd/assist",
-	"version": "0.323.1",
+	"version": "0.324.0",
 	"type": "module",
 	"main": "dist/index.js",
 	"bin": {