From a573cc11e034c5532b8356db9e1f2d2de71d7f58 Mon Sep 17 00:00:00 2001 From: Krzysztof kuhy Rudnicki Date: Fri, 14 Aug 2026 14:25:43 +0200 Subject: [PATCH] Add refactor_claude_todo.md: 250-line file-length cap A ready-to-use prompt describing the goal (every file at most 250 lines, code and prose alike), this repo's actual violations ranked by Fowler ROI (lines x commits/yr), how to split each kind, and the requirement to wire in the shared pre-commit gate so files stay small permanently. Generated from a measured survey of every repo; the gate itself lives in ~/utils (file_length/ + scripts/check_file_length.sh). Co-Authored-By: Claude Opus 5 (1M context) Claude-Session: https://claude.ai/code/session_01C7yZz45ezmzCB89Cv5gAtZ --- app/pubspec.yaml | 2 +- refactor_claude_todo.md | 95 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 96 insertions(+), 1 deletion(-) create mode 100644 refactor_claude_todo.md diff --git a/app/pubspec.yaml b/app/pubspec.yaml index 188356c..788c9ba 100644 --- a/app/pubspec.yaml +++ b/app/pubspec.yaml @@ -2,7 +2,7 @@ name: diet_guard_app description: "Companion phone app for diet_guard: log meals on the go." publish_to: 'none' -version: 1.0.6+1 +version: 1.0.7+1 environment: sdk: ^3.12.2 diff --git a/refactor_claude_todo.md b/refactor_claude_todo.md new file mode 100644 index 0000000..1433d85 --- /dev/null +++ b/refactor_claude_todo.md @@ -0,0 +1,95 @@ +# Refactor TODO — enforce the 250-line file cap + +> **This file is a ready-to-use prompt.** Paste it to Claude, or open this repo +> and say "do refactor_claude_todo". It is self-contained: everything needed to +> execute is below. Generated 2026-08-14 from a measured survey of every repo. + +## Goal + +Every file in this repo must be **at most 250 lines** — source, tests, and +prose (`.md`/`.txt`/`.rst`/`.tex`) alike — and must **stay** that way forever, +enforced by a gate that fails the commit, not by a note anyone can ignore. + +Why: a file that cannot be read in one piece forces re-reads and partial edits, +which is the single largest avoidable cost in an LLM-assisted workflow. Aim by +churn, not size alone — refactoring pays where code is read and changed often +(Fowler, *refactoring economic benefit*). + +## Scope in this repo + +- **56 files** currently exceed 250 lines (of 244 eligible files). +- **22,916 lines** sit in violation; longest file is **1101 lines**. + +Exempt (do NOT split these): +- generated files — `*.g.dart`, `*.freezed.dart`, `*.gr.dart`, `**/l10n/generated/**`, + anything with a `GENERATED` header +- markup — `.html`, `.css`, `.scss` +- data files — `.json`, `.yaml`, `.csv`, wordlists and other data-ish `.txt` + (mean line length under 25 chars) + +## Violations, highest ROI first + +ROI = lines x commits in the last year. Work top-down; a long file nobody edits +has near-zero payoff and should not be first. + +| lines | commits/yr | kind | file | +|------:|-----------:|:-----|:-----| +| 1101 | 12 | prose | `CLAUDE.md` | +| 440 | 15 | code | `app/lib/screens/log_meal_screen.dart` | +| 1052 | 6 | code | `app/lib/screens/history_screen.dart` | +| 1017 | 6 | code | `app/test/screens/history_screen_test.dart` | +| 498 | 10 | code | `diet_guard/_sync.py` | +| 286 | 16 | code | `app/lib/screens/settings_screen.dart` | +| 482 | 9 | code | `diet_guard/tests/test_sync.py` | +| 694 | 5 | code | `app/test/services/sync_merge_test.dart` | +| 472 | 7 | code | `diet_guard/_gatelock_ui.py` | +| 466 | 7 | code | `diet_guard/_cli.py` | +| 282 | 11 | code | `diet_guard/tests/conftest.py` | +| 274 | 11 | code | `app/test/screens/settings_screen_test.dart` | +| 362 | 8 | code | `app/test/screens/log_meal_screen_test.dart` | +| 357 | 8 | code | `diet_guard/_state.py` | +| 475 | 6 | code | `app/lib/services/sync_merge.dart` | + +_(41 further files over 250 lines not listed — re-run the survey for the full set.)_ + +## How to split + +- **Python** — extract cohesive helpers into sibling modules; keep the public + API and imports stable. +- **Shell** — split into `lib/*.sh` sourced by a thin entry script. Keep + `set -euo pipefail` in each. +- **Dart / TypeScript** — extract widgets/components into their own files. +- **Tests** — split by test-group into sibling files + (`foo.test.ts` -> `foo.parsing.test.ts`, `foo.render.test.ts`). Coverage must + not drop. +- **Docs** — split into topic files under `docs/` with an index. For an + oversized `CLAUDE.md`, move detail into referenced docs so the + always-loaded part shrinks. + +**Do not** game the cap: no one-lining, no deleting tests, no moving code into +an exempt extension, no `# noqa`-style suppressions. + +## Make it permanent (required — this is the point) + +A refactor without a gate silently regrows. Before this task is done: + +1. Wire the shared gate `~/utils/scripts/check_file_length.sh` into this repo's + `.pre-commit-config.yaml` as a local hook. If the repo has no pre-commit + config, add a minimal one. +2. The hook checks **files in the commit** (not the whole tree), so unrelated + commits never break, and it **fails** — exit 1, not a warning. +3. No baseline file and no allowlist. Those are suppressions. +4. If this repo has CI (`.github/workflows`), add the same check there so it + also fails on push. + +## Done condition + +- `bash ~/utils/scripts/check_file_length.sh --all` from this repo root exits 0. +- The repo's own test suite and coverage bar are still green. +- `pre-commit run --files ` passes. +- A deliberately over-250-line test file, staged, makes `git commit` **fail**. +- For a deployed daemon/app: the entry point still actually runs. + +## Verify + +Run the Python suite AND the Flutter app tests. Verify the companion app on the phone via the `phone-deploy` skill (`adb install -r`, never uninstall).