6cfc992
@@ -0,0 +1,12 @@
[
  "scripts/cold-read.ts",
  "src/boards/starting.ts",
  "test/ask-to-live-batched.test.ts",
  "test/hot-reads-indexed.test.ts",
  "test/metrics-cells.test.ts",
  "test/pull-actions.test.ts",
  "test/pull-quiet.test.ts",
  "test/shelf-forty.test.ts",
  "test/thread-render-timing.test.ts",
  "test/traffic-truth.test.ts"
]
@@ -0,0 +1,41 @@
/**
 * 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`
 * 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.
 */
import { Glob } from "bun";
export const MAX_WIDTH = 160;
/** Lines of the leading block comment longer than MAX_WIDTH, as `file:line`. */
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;
  }
  return out;
}
/** Every source file with an over-wide header line, by path. */
export async function offenders(root = "."): Promise<Map<string, string[]>> {
  const found = new Map<string, string[]>();
  for (const f of new Glob("{src,scripts,test}/**/*.ts").scanSync(root)) {
    const hits = longHeaderLines(f, await Bun.file(`${root}/${f}`).text());
    if (hits.length) found.set(f, hits);
  }
  return found;
}
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));
      
        junipercrew
        5d ago
        
      
      Next: this only filters new offenders; the test also fails on stale allow-list entries. Share one function so both agree.
    
  for (const [, hits] of bad) console.error(`header-width: wrap to ${MAX_WIDTH} columns: ${hits.join(", ")}`);
  process.exit(bad.length ? 1 : 0);
}
@@ -0,0 +1,21 @@
import { expect, test } from "bun:test";
import allowed from "../scripts/header-width-allow.json";
import { longHeaderLines, MAX_WIDTH, offenders } from "../scripts/header-width.ts";
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([]);
});
test("rule header-width: wrap a file's header comment to the width; the allow list only shrinks", async () => {
  const found = await offenders();
  const ok = new Set<string>(allowed);
  const fresh = [...found].filter(([f]) => !ok.has(f)).flatMap(([, h]) => h);
  expect(fresh, `rule header-width: header comment lines over ${MAX_WIDTH} columns, wrap them: ${fresh.join(", ")}`).toEqual([]);
  const stale = [...ok].filter((f) => !found.has(f));
  expect(stale, `rule header-width: now wrapped, remove from scripts/header-width-allow.json: ${stale.join(", ")}`).toEqual([]);
});