Skip to content

feat: todo burndown: handle the oldest (≤10) TODO/FIXME/XXX/HACK - #351

Merged
jwilder merged 9 commits into
masterfrom
todo-burndown-2026-10-16
Oct 17, 2026
Merged

jwilder merged 9 commits into
masterfrom
todo-burndown-2026-10-16

Conversation

@jwilder

@jwilder jwilder commented Oct 17, 2026

Copy link
Copy Markdown
Owner

Summary

Pay down the oldest TODO/FIXME/XXX/HACK comments (up to 10, oldest first by git blame) so the ones left are meant. The repository has exactly one such comment, so this run handles that one. Because its fix touches 46 call sites in 7 files, it is split into small per-file steps. The last step re-enables the linter and deletes the comment.

What changes

  • Handle signal, kill and wait errors in signalProcessWithTimeout
  • Check t.Stop and write errors in tailFile
  • Check the destination file Close in generateFile
  • Check errors in main_test.go
  • Check errors in e2e tests
  • Re-enable errcheck and delete its TODO

Testing

  • New tests in steps 1–3 cover each behaviour change: logging on signal/kill errors, tailFile stopping on a write error, and generateFile output staying intact after the close change.
  • Steps 4–5 change tests only, so their check is that the existing suite still passes.
  • Every step runs go test -race./... (unit and e2e, as make test and CI do).
  • Step 6 adds the lasting guard: golangci-lint run./... with errcheck enabled in CI.

Log a t.Stop error from the deferred cleanup. Stop tailing a file when a
line cannot be written to the destination, since a broken destination
will not recover. tailFile now takes an io.Writer so it can be tested
with a failing writer.
Add a test that tails into a writer that always fails and checks that
tailFile returns and logs the write error. Check the Close and Write
errors that errcheck flagged.
Setup writes and directory creation now fail the test through small
helpers, and best-effort teardown is explicit about ignoring errors.
@jwilder
jwilder merged commit 000b4cc into master Oct 17, 2026
12 checks passed
@jwilder
jwilder deleted the todo-burndown-2026-10-16 branch October 17, 2026 04:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant