No check enforces the two-line PURPOSE header position in source files #630

New issue

Closed

opened 2026-09-26 00:48:22 +00:00 by claude · 2 comments

claude commented

2026-09-26 00:48:22 +00:00

Member

Found during IW-622 (phase-01-context.md, Scope). No lint, scalafix rule, hook or test checks that a file starts with two // PURPOSE: lines at lines 1-2. IW-622 and its sibling defects (a second PURPOSE line after package, or only one PURPOSE line) went undetected for this reason. A repository-wide check in the lint gate would catch this class of defect.

Found during IW-622 (phase-01-context.md, Scope). No lint, scalafix rule, hook or test checks that a file starts with two `// PURPOSE:` lines at lines 1-2. IW-622 and its sibling defects (a second PURPOSE line after `package`, or only one PURPOSE line) went undetected for this reason. A repository-wide check in the lint gate would catch this class of defect.

claude referenced this issue

2026-09-26 00:50:38 +00:00

IW-622: Move GitTest.scala's second PURPOSE line above the package line #632

claude commented

2026-09-26 01:32:42 +00:00

Author

Member

Intake: needs-input. Before this issue can be analysed, please answer these questions:

Which files must the check cover? The options are: (a) Scala files only (*.scala, *.mill), or (b) also shell, BATS, frontend TS/CSS and Markdown docs. Markdown docs already use  headers at lines 1-2.
Which Scala files are exempt? On origin/main (bcb2d5b5), a check at lines 1-2 fails these files, and no open issue covers them:
- (a) the 27 commands/*.scala shims. They have one PURPOSE line, and docs/testing.md lines 167-168 exempt them on purpose.
- (b) .iw/commands/test.scala, which has a PURPOSE line and then a // USAGE: line. This is the command-script header format.
- (c) 2 files under each of research/approach-3-hybrid/ and research/approach-4-combined/.
For each group, say: exempt, fix in this change, or delete (research/).
How does the check pass while #622, #628 and #629 are still open? These three issues cover the 25 failing core/test files. The options are:
- (a) This change also fixes all 25 files, and the three issues close with it.
- (b) This change adds a baseline or allowlist, and the fixes in the three issues then make it smaller.
- (c) This change waits until #622, #628 and #629 are merged.
#629 also asks whether to delete DebugTest.scala. That decision changes the list of files for option (a).

Intake: needs-input. Before this issue can be analysed, please answer these questions: 1. Which files must the check cover? The options are: (a) Scala files only (`*.scala`, `*.mill`), or (b) also shell, BATS, frontend TS/CSS and Markdown docs. Markdown docs already use `` headers at lines 1-2. 2. Which Scala files are exempt? On origin/main (bcb2d5b5), a check at lines 1-2 fails these files, and no open issue covers them: - (a) the 27 `commands/*.scala` shims. They have one PURPOSE line, and `docs/testing.md` lines 167-168 exempt them on purpose. - (b) `.iw/commands/test.scala`, which has a PURPOSE line and then a `// USAGE:` line. This is the command-script header format. - (c) 2 files under each of `research/approach-3-hybrid/` and `research/approach-4-combined/`. For each group, say: exempt, fix in this change, or delete (research/). 3. How does the check pass while #622, #628 and #629 are still open? These three issues cover the 25 failing `core/test` files. The options are: - (a) This change also fixes all 25 files, and the three issues close with it. - (b) This change adds a baseline or allowlist, and the fixes in the three issues then make it smaller. - (c) This change waits until #622, #628 and #629 are merged. #629 also asks whether to delete `DebugTest.scala`. That decision changes the list of files for option (a).

claude added the

needs-input

label

2026-09-26 01:32:42 +00:00

claude referenced this issue

2026-09-26 02:52:47 +00:00

Command scripts and PhaseMergeHarnessTest.scala do not have exactly two PURPOSE lines #636

claude referenced this issue

2026-09-26 03:32:32 +00:00

Command scripts and PhaseMergeHarnessTest.scala do not have exactly two PURPOSE lines #636

claude referenced this issue

2026-09-28 13:52:04 +00:00