docs: add todo edit/done and --show-future documentation
Document the new todo command features: - Numbered task display - `streamd todo N edit` for editing tasks - `streamd todo N done` for marking tasks done - `--show-future` flag for including future tasks - Add R21 specification for todo command behavior
This commit is contained in:
parent
e05e9cfd90
commit
926a239d7e
2 changed files with 39 additions and 3 deletions
|
|
@ -387,11 +387,40 @@ Provide recursive search through the shard tree:
|
|||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `streamd new` | Create new timestamped file, open editor, rename with markers on close |
|
||||
| `streamd todo` | List all shards with `task: "open"` |
|
||||
| `streamd todo` | List all shards with `task: "open"`, numbered, hiding future tasks |
|
||||
| `streamd todo --show-future` | Include tasks with future dates in the todo listing |
|
||||
| `streamd todo N edit` | Edit task N in editor, cursor positioned at task line |
|
||||
| `streamd todo N done` | Mark task N as done by inserting `@Done` after `@Task` |
|
||||
| `streamd edit [n]` | Edit nth file (supports negative indexing for recent files) |
|
||||
| `streamd timesheet` | Generate formatted timesheet report with expected/actual hours |
|
||||
| `streamd completions <shell>` | Generate shell completions (bash, zsh, fish, elvish, powershell) |
|
||||
|
||||
### R21: Todo Command Behavior
|
||||
|
||||
**Task Numbering:**
|
||||
- Tasks are numbered starting from 1 (oldest task = 1)
|
||||
- Tasks are sorted by their `moment` field in ascending order
|
||||
- Output format: `[N] --- file.md:line ---` followed by task content
|
||||
|
||||
**Future Task Filtering:**
|
||||
- By default, tasks with `moment > now` are hidden from the listing
|
||||
- The `--show-future` flag includes all tasks regardless of their moment
|
||||
- When using `todo N edit` or `todo N done`, all tasks (including future) are considered for number lookup
|
||||
|
||||
**Edit Action (`todo N edit`):**
|
||||
- Opens the task's file in `$EDITOR` (defaults to `vi`)
|
||||
- Uses `+LINE` argument to position cursor at task's start line
|
||||
- Errors if N is 0 or exceeds the task count
|
||||
|
||||
**Done Action (`todo N done`):**
|
||||
- Reads the file and modifies the line at task's start_line
|
||||
- Inserts ` @Done` immediately after `@Task`
|
||||
- Preserves trailing newline if the original file had one
|
||||
- Errors if:
|
||||
- N is 0 or exceeds the task count
|
||||
- Multiple `@Task` markers found on the same line
|
||||
- No `@Task` marker found on the expected line
|
||||
|
||||
---
|
||||
|
||||
## Application Configuration
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue