naudachu
62c8ff976d
A checkbox is the one part of a body that is state and not prose.
Everything else is written once; boxes get ticked as the work goes, and
until now the only ways to tick one were a human with an editor or a
model rewriting the whole body. The second is worse: the rewrite re-flows
lines and re-words sentences, so the issue's diff swells around a change
that means one character. Progress was invisible too — issue_index.py
builds INDEX.md from metadata and never looked inside a body, so "3 of 7
done" required opening the file.
All three pieces are domain: a checkbox is body syntax, which is part of
the answer to "what is an issue". The parser goes in issue.py so the sync
layer can reuse it instead of redefining the format on its own side.
issue.py gains checkboxes(text) -> [Checkbox(index, line, end_line,
checked, text, section)], plus set_checkbox(text, item, checked) and
checkbox_progress(text). All pure, no I/O, importable from another layer.
The scan covers the whole text, in any section: the type/feature template
keeps child issues as checkboxes under `## Issues`, so binding the parser
to `## Acceptance criteria` would silently lose half of them; the heading
is recorded, never required. Only a marker line opens an item, so a
wrapped continuation line belongs to the item above it rather than
counting as one of its own. A `- [ ]` inside a code fence is an example
of the markup and is skipped. Line numbers are relative to the text
given, which is what lets a caller work on a body or on a whole file.
issue_ac.py lists the items numbered, grouped by heading, and ticks one
by number or by substring. An ambiguous substring is an error that prints
the matches — a coin flip would tick the wrong box and look like it
worked. It patches the file rather than round-tripping through
Issue.to_text(), so exactly one character changes: metadata order,
wording, wrapping, trailing whitespace and CRLF endings all come back
byte for byte, proven by a diff in the tests.
INDEX.md gains a progress column: `3/7` for an issue with checkboxes,
blank for one without. Counted off the body at build time and stored in
no field — a second copy of the state would be wrong by the next edit.
issue_check.py is unchanged and stays that way on purpose: an unticked
box is work not done yet, not a malformed issue, and validate() carries a
comment saying so.
Delivering a tick to the tracker is out of scope — that is push.py
--update in /tea:sync.
format.md gets one clarifying bullet. It said acceptance criteria are
checkboxes but never said what a checkbox is, so the parser had to settle
questions the format left open: any section, wrapped items, fenced
examples. Those rules are now written down where the parser and the sync
layer can both point at them.
tests/ is new, and is the convention: plain stdlib unittest, no pytest
and no third-party deps, since the code under test may not have
dependencies either. Scripts are imported via sys.path.insert and every
fixture is built in a TemporaryDirectory, never in tmp/.
python3 -m unittest discover -s tests -v 32 tests, OK
skills/issue/scripts/ still imports stdlib only, with no subprocess.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
104 lines
3.5 KiB
Python
104 lines
3.5 KiB
Python
#!/usr/bin/env python3
|
|
"""
|
|
issue_index.py — rebuild tmp/issues/INDEX.md from what is on disk. Offline.
|
|
|
|
A map of the local store, nothing else. The `origin` column is the only place
|
|
the index acknowledges that a tracker exists: `local` means the issue has never
|
|
left this machine, `gitea` means the sync layer has pushed or pulled it. Both
|
|
are ordinary issues here.
|
|
|
|
Usage:
|
|
issue_index.py [--out tmp/issues]
|
|
"""
|
|
import argparse
|
|
import os
|
|
import re
|
|
import sys
|
|
|
|
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
|
|
import issue # noqa: E402
|
|
|
|
|
|
def cell(v):
|
|
if isinstance(v, (list, tuple)):
|
|
return ", ".join(str(x) for x in v) or "—"
|
|
v = str(v or "").strip()
|
|
return v.replace("|", "\\|") or "—"
|
|
|
|
|
|
def progress(body):
|
|
"""`3/7` for a body with checkboxes, "" for one without.
|
|
|
|
Counted from the body every time the index is built and stored nowhere —
|
|
the boxes are the state, and a second copy of it in a metadata field would
|
|
be wrong by the next edit."""
|
|
done, total = issue.checkbox_progress(body)
|
|
return "%d/%d" % (done, total) if total else ""
|
|
|
|
|
|
def build(root):
|
|
issues = issue.load_all(root)
|
|
rows = []
|
|
for i in sorted(issues):
|
|
iss = issues[i]
|
|
rest = [l for l in iss.labels if not l.startswith("type/")]
|
|
rows.append({
|
|
"id": i,
|
|
"state": cell(iss.state),
|
|
"progress": progress(iss.body),
|
|
"type": cell(iss.type),
|
|
"labels": cell(rest),
|
|
"title": cell(iss.title),
|
|
"milestone": cell(iss.milestone),
|
|
"depends": cell(iss.depends),
|
|
"origin": cell(iss.origin),
|
|
})
|
|
|
|
listing = os.listdir(root) if os.path.isdir(root) else []
|
|
trees = sorted(f for f in listing if re.match(r'^tree-.+\.md$', f))
|
|
|
|
out = ["# Issue store", "",
|
|
"Every issue this project knows about. `origin: local` means it "
|
|
"exists nowhere else — a complete state, not a pending one. Any "
|
|
"other value names the tracker it also lives in; the handle is in "
|
|
"the file. `progress` counts the body's checkboxes, ticked over "
|
|
"total, and is blank for an issue that has none — read off the "
|
|
"body at build time, stored nowhere. Rebuild with `issue_index.py`; "
|
|
"tick a box with `issue_ac.py`.", ""]
|
|
if rows:
|
|
out += ["| id | state | progress | type | labels | title | milestone | depends | origin |",
|
|
"|---|---|---|---|---|---|---|---|---|"]
|
|
out += ["| [%s](%s.md) | %s | %s | %s | %s | %s | %s | %s | %s |" % (
|
|
r["id"], r["id"], r["state"], r["progress"], r["type"], r["labels"],
|
|
r["title"], r["milestone"], r["depends"], r["origin"]) for r in rows]
|
|
else:
|
|
out.append("_empty_")
|
|
|
|
if trees:
|
|
out += ["", "## Dependency trees", ""]
|
|
out += ["- [%s](%s)" % (t, t) for t in trees]
|
|
|
|
cycles = issue.find_cycles(issue.graph(issues))
|
|
if cycles:
|
|
out += ["", "## Dependency cycles", ""]
|
|
out += ["- %s" % " -> ".join(c) for c in cycles]
|
|
|
|
out.append("")
|
|
path = os.path.join(root, "INDEX.md")
|
|
os.makedirs(root, exist_ok=True)
|
|
with open(path, "w") as f:
|
|
f.write("\n".join(out))
|
|
return path, len(rows)
|
|
|
|
|
|
def main():
|
|
ap = argparse.ArgumentParser(description="Rebuild the local issue index (offline)")
|
|
ap.add_argument("--out", default=issue.ISSUE_ROOT, help="store root (default: tmp/issues)")
|
|
args = ap.parse_args()
|
|
path, n = build(args.out)
|
|
print("%s — %d issue(s)" % (path, n))
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|