Files
msd-core/get-shit-done/workflows/check-todos.md
Tom Boucher 54e6da3126 fix(#2767): pass paths via --files to gsd-sdk query commit + lint guard (#2781)
* fix(#2767): pass paths via --files to gsd-sdk query commit + lint guard

Workflows, agents, commands, and references passed file paths positionally
to `gsd-sdk query commit`, which silently appended them to the commit
subject and triggered the `.planning/` wholesale-stage fallback in
sdk/src/query/commit.ts:136. Regression of #733/#798.

Inserted `--files` before the path list at every site (81 invocations
across 50 files). Added tests/bug-2767-gsd-sdk-commit-files-flag.test.cjs
as a permanent lint that scans every shipped .md file and asserts each
`gsd-sdk query commit[-to-subrepo]` invocation either uses `--files` or
carries no path arguments.

Closes #2767

* test(#2767): replace source-grep with behavioral SDK test

The original test walked every shipped .md file and regex-tokenized
`gsd-sdk query commit` invocations to assert `--files` was present.
CONTRIBUTING.md prohibits this source-grep pattern.

Rewrite as behavioral SDK tests against `sdk/dist/cli.js` over a real
tmp git project (createTempGitProject helper). Cover both the
well-formed (`--files <paths>`) form — clean subject, exactly-staged
files, .planning/ left untouched — and the buggy positional form,
asserting the documented misbehavior (paths leak into subject + the
`.planning/` wholesale-stage fallback at commit.ts:136). Also asserts
`commit-to-subrepo` rejects when `--files` is omitted (commit.ts:258).

The doc-lint is retained as a supplementary defense-in-depth guard
since agent-prompt markdown invocations cannot be exercised end-to-end
— but it is no longer the primary contract.

* docs(#2767): correct contradictory --files guidance in zh-CN/en docs + fix test docstring
2026-04-27 12:31:43 -04:00

4.8 KiB

List all pending todos, allow selection, load full context for the selected todo, and route to appropriate action.

<required_reading> Read all files referenced by the invoking prompt's execution_context before starting. </required_reading>

Load todo context:
INIT=$(gsd-sdk query init.todos)
if [[ "$INIT" == @file:* ]]; then INIT=$(cat "${INIT#@file:}"); fi

Extract from init JSON: todo_count, todos, pending_dir.

If todo_count is 0:

No pending todos.

Todos are captured during work sessions with /gsd-add-todo.

---

Would you like to:

1. Continue with current phase (/gsd-progress)
2. Add a todo now (/gsd-add-todo)

Exit.

Check for area filter in arguments: - `/gsd-check-todos` → show all - `/gsd-check-todos api` → filter to area:api only Use the `todos` array from init context (already filtered by area if specified).

Parse and display as numbered list:

Pending Todos:

1. Add auth token refresh (api, 2d ago)
2. Fix modal z-index issue (ui, 1d ago)
3. Refactor database connection pool (database, 5h ago)

---

Reply with a number to view details, or:
- `/gsd-check-todos [area]` to filter by area
- `q` to exit

Format age as relative time from created timestamp.

Wait for user to reply with a number.

If valid: load selected todo, proceed. If invalid: "Invalid selection. Reply with a number (1-[N]) or q to exit."

Read the todo file completely. Display:
## [title]

**Area:** [area]
**Created:** [date] ([relative time] ago)
**Files:** [list or "None"]

### Problem
[problem section content]

### Solution
[solution section content]

If files field has entries, read and briefly summarize each.

Check for roadmap (can use init progress or directly check file existence):

If .planning/ROADMAP.md exists:

  1. Check if todo's area matches an upcoming phase
  2. Check if todo's files overlap with a phase's scope
  3. Note any match for action options
**If todo maps to a roadmap phase:**

Text mode (workflow.text_mode: true in config or --text flag): Set TEXT_MODE=true if --text is present in $ARGUMENTS OR text_mode from init JSON is true. When TEXT_MODE is active, replace every AskUserQuestion call with a plain-text numbered list and ask the user to type their choice number. This is required for non-Claude runtimes (OpenAI Codex, Gemini CLI, etc.) where AskUserQuestion is not available. Use AskUserQuestion:

  • header: "Action"
  • question: "This todo relates to Phase [N]: [name]. What would you like to do?"
  • options:
    • "Work on it now" — move to done, start working
    • "Add to phase plan" — include when planning Phase [N]
    • "Brainstorm approach" — think through before deciding
    • "Put it back" — return to list

If no roadmap match:

Use AskUserQuestion:

  • header: "Action"
  • question: "What would you like to do with this todo?"
  • options:
    • "Work on it now" — move to done, start working
    • "Create a phase" — /gsd-add-phase with this scope
    • "Brainstorm approach" — think through before deciding
    • "Put it back" — return to list
**Work on it now:** ```bash mv ".planning/todos/pending/[filename]" ".planning/todos/completed/" ``` Update STATE.md todo count. Present problem/solution context. Begin work or ask how to proceed.

Add to phase plan: Note todo reference in phase planning notes. Keep in pending. Return to list or exit.

Create a phase: Display: /gsd-add-phase [description from todo] Keep in pending. User runs command in fresh context.

Brainstorm approach: Keep in pending. Start discussion about problem and approaches.

Put it back: Return to list_todos step.

After any action that changes todo count:

Re-run init todos to get updated count, then update STATE.md "### Pending Todos" section if exists.

If todo was moved to done/, commit the change:
git rm --cached .planning/todos/pending/[filename] 2>/dev/null || true
gsd-sdk query commit "docs: start work on todo - [title]" --files .planning/todos/completed/[filename] .planning/STATE.md

Tool respects commit_docs config and gitignore automatically.

Confirm: "Committed: docs: start work on todo - [title]"

<success_criteria>

  • All pending todos listed with title, area, age
  • Area filter applied if specified
  • Selected todo's full context loaded
  • Roadmap context checked for phase match
  • Appropriate actions offered
  • Selected action executed
  • STATE.md updated if todo count changed
  • Changes committed to git (if todo moved to done/) </success_criteria>