ee355e1 · 72c769d
@@ -1,12 +1,36 @@
[
  "scripts/cold-read.ts",
  "src/actions/model_grant.ts",
  "src/actions/pinned.ts",
  "src/boards/starting.ts",
  "src/checks/scan_rules.ts",
  "src/core/runs.ts",
  "src/crew/brief.ts",
  "src/crew/hot_history.ts",
  "src/crew/week_read.ts",
  "src/flow/hot_trend.ts",
  "src/flow/keeper.ts",
  "src/flow/kpis.ts",
  "src/flows/view.ts",
  "src/main.ts",
  "src/packs/deploy.ts",
  "src/tui/screens/resilience.ts",
  "src/web/studio/home_cache.ts",
  "test/app-tell-fit.test.ts",
  "test/ask-to-live-batched.test.ts",
  "test/cut-wave.test.ts",
  "test/flow-public-only.test.ts",
  "test/forge-webspec.test.ts",
  "test/home-frame.test.ts",
  "test/hot-reads-indexed.test.ts",
  "test/metrics-cells.test.ts",
  "test/pull-actions.test.ts",
  "test/pull-quiet.test.ts",
  "test/route-timing-coverage.test.ts",
  "test/shared-red.test.ts",
  "test/shelf-forty.test.ts",
  "test/spawn-cell.test.ts",
  "test/thread-render-timing.test.ts",
  "test/traffic-truth.test.ts"
  "test/traffic-truth.test.ts",
  "test/vitals.test.ts"
]
@@ -1,8 +1,9 @@
/**
 * Rule `header-width`: a file's leading `/** … */` comment keeps every line
 * within MAX_WIDTH columns. Reviewers kept asking to "wrap the header comment,
 * it is now one very long line" (#8162, #8084, #9716, #8264); this says it
 * for them (#9960). Files already over are listed in `header-width-allow.json`
 * Rule `header-width`: a file's comments (the leading block and every comment-only
 * line after it) keep every line within MAX_WIDTH columns. Reviewers kept
 * asking to "wrap the header comment, it is now one very long line" (#8162,
 * #8084, #9716, #8264) and to rewrap long comment lines (#8957, #9222, #9627,
 * #9943); this says it for them (#9960, #10140). Files already over are listed in `header-width-allow.json`
 * and only leave it: a new offender fails, and so does a listed file that
 * is now clean, so the list shrinks and never grows.
 */
@@ -11,15 +12,22 @@
import { Glob } from "bun";
export const MAX_WIDTH = 160;
/** Lines of the leading block comment longer than MAX_WIDTH, as `file:line`. */
/**
 * Lines of comment longer than MAX_WIDTH, as `file:line`: the leading block
 * and every later comment-only line (`//` or inside a block comment), the
 * "this comment line runs far past the others" finding (#8957, #9222, #9627,
 * #9943). A line holding a URL is exempt: it cannot be wrapped.
 */
export function longHeaderLines(file: string, text: string): string[] {
  const lines = text.split("\n");
  const out: string[] = [];
  if (!lines[0]?.startsWith("/**")) return out;
  for (let i = 0; i < lines.length; i++) {
    if (lines[i]!.length > MAX_WIDTH) out.push(`${file}:${i + 1}`);
    if (lines[i]!.trimEnd().endsWith("*/")) break;
  }
  let inBlock = false;
  text.split("\n").forEach((line, i) => {
    const t = line.trim();
    const starts = inBlock || t.startsWith("//") || t.startsWith("/*");
    if (!inBlock && t.startsWith("/*") && !t.includes("*/")) inBlock = true;
    else if (inBlock && t.includes("*/")) inBlock = false;
    if (starts && line.length > MAX_WIDTH && !/https?:\/\//.test(line)) out.push(`${file}:${i + 1}`);
  });
  return out;
}
@@ -36,6 +44,6 @@
export async function offenders(root = "."): Promise<Map<string, string[]>> {
if (import.meta.main) {
  const allowed = new Set<string>(await Bun.file("scripts/header-width-allow.json").json());
  const bad = [...(await offenders())].filter(([f]) => !allowed.has(f));
  for (const [, hits] of bad) console.error(`header-width: wrap to ${MAX_WIDTH} columns: ${hits.join(", ")}`);
  for (const [, hits] of bad) console.error(`header-width: comment line over ${MAX_WIDTH} columns, rewrap it: ${hits.join(", ")}`);
  process.exit(bad.length ? 1 : 0);
}
@@ -1,7 +1,6 @@
[
  "src/apps/cloud.ts",
  "src/boards/machine.ts",
  "src/core/teams_words.ts",
  "src/crew/governor_log.ts",
  "src/crew/tries.ts",
  "src/flow/alarm_drift.ts",
@@ -6,9 +6,11 @@
test("a header line over the width is named, a wrapped one is not", () => {
  const long = `/**\n * ${"word ".repeat(40)}\n */\nconst x = 1;\n`;
  expect(longHeaderLines("a.ts", long)).toEqual(["a.ts:2"]);
  expect(longHeaderLines("a.ts", "/**\n * short\n */\n")).toEqual([]);
  // only the leading comment counts; code after it does not
  expect(longHeaderLines("a.ts", `/**\n * ok\n */\n// ${"x".repeat(200)}\n`)).toEqual([]);
  expect(longHeaderLines("a.ts", `// ${"x".repeat(200)}\n`)).toEqual([]);
  // later comment-only lines count (#8957, #9222, #9627, #9943); code and URLs do not
  expect(longHeaderLines("a.ts", `/**\n * ok\n */\n// ${"x ".repeat(100)}\n`)).toEqual(["a.ts:4"]);
  expect(longHeaderLines("a.ts", `x();\n  /* ${"x ".repeat(100)}\n  ${"y ".repeat(100)}*/\n`)).toEqual(["a.ts:2", "a.ts:3"]);
  expect(longHeaderLines("a.ts", `const s = "${"x".repeat(200)}";\n`)).toEqual([]);
  expect(longHeaderLines("a.ts", `// see https://e.com/${"x".repeat(200)}\n`)).toEqual([]);
});
test("rule header-width: wrap a file's header comment to the width; the allow list only shrinks", async () => {
		@@ -1,7 +1,6 @@
1	1	[
2	2	"src/apps/cloud.ts",
3	3	"src/boards/machine.ts",
4		"src/core/teams_words.ts",
5	4	"src/crew/governor_log.ts",
6	5	"src/crew/tries.ts",
7	6	"src/flow/alarm_drift.ts",