backlog.md 1.33.0 β†’ 1.35.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +49 -24
  2. package/package.json +6 -6
package/README.md CHANGED
@@ -26,6 +26,7 @@
26
26
  * πŸ” **Powerful search** -- fuzzy search across tasks, docs & decisions with `backlog search`
27
27
 
28
28
  * πŸ“‹ **Rich query commands** -- view, list, filter, or archive tasks with ease
29
+ * βœ… **Definition of Done defaults** -- add a reusable checklist to every new task
29
30
 
30
31
  * πŸ“€ **Board export** -- `backlog board export` creates shareable markdown reports
31
32
 
@@ -194,7 +195,10 @@ You can rerun the wizard anytime with `backlog config`. All existing CLI flags (
194
195
  | Create with priority | `backlog task create "Feature" --priority high` |
195
196
  | Create with plan | `backlog task create "Feature" --plan "1. Research\n2. Implement"` |
196
197
  | Create with AC | `backlog task create "Feature" --ac "Must work,Must be tested"` |
198
+ | Add DoD items on create | `backlog task create "Feature" --dod "Run tests"` |
199
+ | Create without DoD defaults | `backlog task create "Feature" --no-dod-defaults` |
197
200
  | Create with notes | `backlog task create "Feature" --notes "Started initial research"` |
201
+ | Create with final summary | `backlog task create "Feature" --final-summary "PR-style summary"` |
198
202
  | Create with deps | `backlog task create "Feature" --dep task-1,task-2` |
199
203
  | Create with refs | `backlog task create "Feature" --ref https://docs.example.com --ref src/api.ts` |
200
204
  | Create with docs | `backlog task create "Feature" --doc https://design-docs.example.com --doc docs/spec.md` |
@@ -207,18 +211,25 @@ You can rerun the wizard anytime with `backlog config`. All existing CLI flags (
207
211
  | Edit | `backlog task edit 7 -a @sara -l auth,backend` |
208
212
  | Add plan | `backlog task edit 7 --plan "Implementation approach"` |
209
213
  | Add AC | `backlog task edit 7 --ac "New criterion" --ac "Another one"` |
214
+ | Add DoD | `backlog task edit 7 --dod "Ship notes"` |
210
215
  | Remove AC | `backlog task edit 7 --remove-ac 2` (removes AC #2) |
211
216
  | Remove multiple ACs | `backlog task edit 7 --remove-ac 2 --remove-ac 4` (removes AC #2 and #4) |
212
217
  | Check AC | `backlog task edit 7 --check-ac 1` (marks AC #1 as done) |
218
+ | Check DoD | `backlog task edit 7 --check-dod 1` (marks DoD #1 as done) |
213
219
  | Check multiple ACs | `backlog task edit 7 --check-ac 1 --check-ac 3` (marks AC #1 and #3 as done) |
214
220
  | Uncheck AC | `backlog task edit 7 --uncheck-ac 3` (marks AC #3 as not done) |
221
+ | Uncheck DoD | `backlog task edit 7 --uncheck-dod 3` (marks DoD #3 as not done) |
215
222
  | Mixed AC operations | `backlog task edit 7 --check-ac 1 --uncheck-ac 2 --remove-ac 4` |
223
+ | Mixed DoD operations | `backlog task edit 7 --check-dod 1 --uncheck-dod 2 --remove-dod 4` |
216
224
  | Add notes | `backlog task edit 7 --notes "Completed X, working on Y"` (replaces existing) |
217
225
  | Append notes | `backlog task edit 7 --append-notes "New findings"` |
226
+ | Add final summary | `backlog task edit 7 --final-summary "PR-style summary"` |
227
+ | Append final summary | `backlog task edit 7 --append-final-summary "More details"` |
228
+ | Clear final summary | `backlog task edit 7 --clear-final-summary` |
218
229
  | Add deps | `backlog task edit 7 --dep task-1 --dep task-2` |
219
230
  | Archive | `backlog task archive 7` |
220
231
 
221
- #### Multi‑line input (description/plan/notes)
232
+ #### Multi‑line input (description/plan/notes/final summary)
222
233
 
223
234
  The CLI preserves input literally; `\n` sequences are not auto‑converted. Use one of the following to insert real newlines:
224
235
 
@@ -227,6 +238,8 @@ The CLI preserves input literally; `\n` sequences are not auto‑converted. Use
227
238
  - Plan: `backlog task edit 7 --plan $'1. Research\n2. Implement'`
228
239
  - Notes: `backlog task edit 7 --notes $'Completed A\nWorking on B'`
229
240
  - Append notes: `backlog task edit 7 --append-notes $'Added X\nAdded Y'`
241
+ - Final summary: `backlog task edit 7 --final-summary $'Shipped A\nAdded B'`
242
+ - Append final summary: `backlog task edit 7 --append-final-summary $'Added X\nAdded Y'`
230
243
  - **POSIX sh (printf)**
231
244
  - `backlog task create "Feature" --desc "$(printf 'Line1\nLine2\n\nFinal paragraph')"`
232
245
  - **PowerShell (backtick)**
@@ -376,6 +389,7 @@ Whenever you revisit `backlog init` or rerun `backlog config`, the wizard pre-po
376
389
  |-------------------|--------------------|-------------------------------|
377
390
  | `defaultAssignee` | Pre‑fill assignee | `[]` |
378
391
  | `defaultStatus` | First column | `To Do` |
392
+ | `definition_of_done` | Default DoD checklist items for new tasks | `(not set)` |
379
393
  | `statuses` | Board columns | `[To Do, In Progress, Done]` |
380
394
  | `dateFormat` | Date/time format | `yyyy-mm-dd hh:mm` |
381
395
  | `timezonePreference` | Timezone for dates | `UTC` |
@@ -405,6 +419,19 @@ Whenever you revisit `backlog init` or rerun `backlog config`, the wizard pre-po
405
419
 
406
420
  > **Date/Time Support**: Backlog.md now supports datetime precision for all dates. New items automatically include time (YYYY-MM-DD HH:mm format in UTC), while existing date-only entries remain unchanged for backward compatibility. Use the migration script `bun src/scripts/migrate-dates.ts` to optionally add time to existing items.
407
421
 
422
+ ### Definition of Done defaults
423
+
424
+ Set project-wide DoD items in the Web UI (Settings β†’ Definition of Done Defaults) or edit `backlog/config.yml` directly:
425
+
426
+ ```yaml
427
+ definition_of_done:
428
+ - Tests pass
429
+ - Documentation updated
430
+ - No regressions introduced
431
+ ```
432
+
433
+ These items are added to every new task by default. You can add more on create with `--dod`, or disable defaults per task with `--no-dod-defaults`. Array values like `definition_of_done` must be edited in the config file or via the Web UI.
434
+
408
435
  ---
409
436
 
410
437
  ## πŸ’‘ Shell Tab Completion
@@ -462,36 +489,34 @@ Perfect for sharing project status, creating reports, or storing snapshots in ve
462
489
 
463
490
  <!-- BOARD_START -->
464
491
 
465
- ## πŸ“Š Backlog.md Project Status (v1.32.0)
492
+ ## πŸ“Š Backlog.md Project Status (v1.34.0)
466
493
 
467
494
  This board was automatically generated by [Backlog.md](https://backlog.md)
468
495
 
469
- Generated on: 2026-01-17 21:04:35
496
+ Generated on: 2026-01-18 13:48:13
470
497
 
471
498
  | To Do | In Progress | Done |
472
499
  | --- | --- | --- |
473
- | **BACK-366** - Evaluate and replace prompts library with clack in CLI wizards [@codex] | | **BACK-352** - Include subtask list in plain task output (CLI + MCP) [@codex] |
474
- | └─ **BACK-366.03** - Refactor remaining CLI prompt flows and tests to clack [@codex] | | **BACK-353** - Add documentation field to task domain object [@codex] |
475
- | └─ **BACK-366.01** - Refactor init wizard prompts to clack [@codex] | | **BACK-356** - Add references field to task domain object [@codex] |
476
- | └─ **BACK-366.02** - Refactor advanced config wizard prompts to clack [@codex] | | **BACK-351** - Strengthen MCP task creation guidance for standalone tasks [@codex] |
477
- | **BACK-361** - Add label-based filtering to TUI and web UI task list views<br>*#tui #web #enhancement* | | **BACK-362** - Include completed tasks in MCP task_search results [@codex]<br>*#mcp #enhancement* |
478
- | **BACK-355** - Add task type field (bug, feature, enhancement, etc.)<br>*#enhancement #core #cli #mcp #web* | | **BACK-358** - Rename Task Completion Guide to Task Finalization Guide [@codex]<br>*#documentation #workflow* |
479
- | └─ **BACK-355.06** - Web UI: Display and edit task type<br>*#web* | | **BACK-365** - Fix acceptance criteria insertion adding blank lines [@codex] |
480
- | └─ **BACK-355.01** - Core: Add type field to task domain model and persistence<br>*#core* | | **BACK-364** - Fix getTask() to use configured prefix for numeric ID lookups [@codex]<br>*#bug #mcp* |
481
- | └─ **BACK-355.02** - CLI: Add --type flag to task create and edit commands<br>*#cli* | | **BACK-363** - Fix localById case mismatch in cross-branch task loading [@codex]<br>*#core #bug* |
482
- | └─ **BACK-355.03** - MCP: Add type parameter to task_create and task_edit tools<br>*#mcp* | | **BACK-360** - Fix cross-branch index case mismatch for custom prefixes [@codex]<br>*#bug #cross-branch #prefix-config* |
483
- | └─ **BACK-355.04** - Filtering: Add type-based filtering to task list and search<br>*#core #cli #mcp* | | **BACK-359** - Pass configured task prefix to cross-branch loading functions [@codex]<br>*#bug #cross-branch #prefix-config* |
484
- | └─ **BACK-355.05** - TUI: Display task type in board and detail views<br>*#tui* | | └─ **BACK-345.10** - Fix ID generation bugs and cleanup prefix-config leftovers [@codex]<br>*#bug #refactor #tdd* |
485
- | **BACK-354** - Project Definition of Done defaults [@codex] | | |
486
- | └─ **BACK-354.02** - CLI + MCP: DoD create options and outputs [@codex] | | |
487
- | └─ **BACK-354.03** - Web UI: DoD in task modal and create flow [@codex] | | |
488
- | └─ **BACK-354.04** - TUI: DoD in task detail and kanban popup [@codex] | | |
489
- | └─ **BACK-354.05** - Web UI: edit Definition of Done defaults in Settings [@codex] | | |
490
- | └─ **BACK-354.01** - Core: Definition of Done defaults and persistence [@codex] | | |
491
- | **BACK-349** - Publish Backlog.md as an Agent Skill with bundled guidance (no MCP resources required for instructions) [@codex]<br>*#agent-skills #mcp #docs #distribution* | | |
492
- | └─ **BACK-24.02** - CLI TUI: Add milestone swimlanes to interactive board view<br>*#cli #tui #enhancement* | | |
500
+ | **BACK-367** - Add Final Summary field to tasks for PR-style completion notes<br>*#enhancement #core #cli #mcp #workflow* | | **BACK-354** - Project Definition of Done defaults [@codex] |
501
+ | └─ **BACK-367.01** - CLI and plain text formatter integration for Final Summary field<br>*#cli #enhancement* | | └─ **BACK-354.01** - Core: Definition of Done defaults and persistence [@codex] |
502
+ | └─ **BACK-367.02** - MCP tools and schemas integration for Final Summary field<br>*#mcp #enhancement* | | └─ **BACK-354.02** - CLI + MCP: DoD create options and outputs [@codex] |
503
+ | └─ **BACK-367.03** - Web UI integration for Final Summary field<br>*#web #enhancement* | | └─ **BACK-354.03** - Web UI: DoD in task modal and create flow [@codex] |
504
+ | └─ **BACK-367.04** - TUI task viewer integration for Final Summary field<br>*#tui #enhancement* | | └─ **BACK-354.04** - TUI: DoD in task detail and kanban popup [@codex] |
505
+ | **BACK-366** - Evaluate and replace prompts library with clack in CLI wizards [@codex] | | └─ **BACK-354.05** - Web UI: edit Definition of Done defaults in Settings [@codex] |
506
+ | └─ **BACK-366.03** - Refactor remaining CLI prompt flows and tests to clack [@codex] | | **BACK-346** - Add milestone completion/archival workflow [@codex]<br>*#milestones #enhancement #ux* |
507
+ | └─ **BACK-366.01** - Refactor init wizard prompts to clack [@codex] | | **BACK-352** - Include subtask list in plain task output (CLI + MCP) [@codex] |
508
+ | └─ **BACK-366.02** - Refactor advanced config wizard prompts to clack [@codex] | | **BACK-353** - Add documentation field to task domain object [@codex] |
509
+ | **BACK-361** - Add label-based filtering to TUI and web UI task list views<br>*#tui #web #enhancement* | | **BACK-356** - Add references field to task domain object [@codex] |
510
+ | **BACK-355** - Add task type field (bug, feature, enhancement, etc.)<br>*#enhancement #core #cli #mcp #web* | | **BACK-351** - Strengthen MCP task creation guidance for standalone tasks [@codex] |
511
+ | └─ **BACK-355.06** - Web UI: Display and edit task type<br>*#web* | | **BACK-362** - Include completed tasks in MCP task_search results [@codex]<br>*#mcp #enhancement* |
512
+ | └─ **BACK-355.01** - Core: Add type field to task domain model and persistence<br>*#core* | | **BACK-358** - Rename Task Completion Guide to Task Finalization Guide [@codex]<br>*#documentation #workflow* |
513
+ | └─ **BACK-355.02** - CLI: Add --type flag to task create and edit commands<br>*#cli* | | **BACK-365** - Fix acceptance criteria insertion adding blank lines [@codex] |
514
+ | └─ **BACK-355.03** - MCP: Add type parameter to task_create and task_edit tools<br>*#mcp* | | **BACK-364** - Fix getTask() to use configured prefix for numeric ID lookups [@codex]<br>*#bug #mcp* |
515
+ | └─ **BACK-355.04** - Filtering: Add type-based filtering to task list and search<br>*#core #cli #mcp* | | **BACK-363** - Fix localById case mismatch in cross-branch task loading [@codex]<br>*#core #bug* |
516
+ | └─ **BACK-355.05** - TUI: Display task type in board and detail views<br>*#tui* | | **BACK-360** - Fix cross-branch index case mismatch for custom prefixes [@codex]<br>*#bug #cross-branch #prefix-config* |
517
+ | **BACK-349** - Publish Backlog.md as an Agent Skill with bundled guidance (no MCP resources required for instructions) [@codex]<br>*#agent-skills #mcp #docs #distribution* | | **BACK-359** - Pass configured task prefix to cross-branch loading functions [@codex]<br>*#bug #cross-branch #prefix-config* |
518
+ | └─ **BACK-24.02** - CLI TUI: Add milestone swimlanes to interactive board view<br>*#cli #tui #enhancement* | | └─ **BACK-345.10** - Fix ID generation bugs and cleanup prefix-config leftovers [@codex]<br>*#bug #refactor #tdd* |
493
519
  | **BACK-239** - Feature: Auto-link tasks to documents/decisions + backlinks [@codex]<br>*#web #enhancement #docs* | | |
494
- | **BACK-346** - Add milestone completion/archival workflow<br>*#milestones #enhancement #ux* | | |
495
520
  | **BACK-347** - Add milestone editing in Web UI<br>*#milestones #web-ui #enhancement* | | |
496
521
  | **BACK-348** - Redesign All Tasks page with table layout<br>*#web-ui #design #enhancement #ux* | | |
497
522
  | **BACK-310** - Strengthen Backlog workflow overview emphasis on reading detailed guides [@codex] | | |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "backlog.md",
3
- "version": "1.33.0",
3
+ "version": "1.35.0",
4
4
  "module": "src/cli.ts",
5
5
  "files": [
6
6
  "cli.js",
@@ -14,11 +14,11 @@
14
14
  "backlog": "cli.js"
15
15
  },
16
16
  "optionalDependencies": {
17
- "backlog.md-linux-x64": "1.33.0",
18
- "backlog.md-linux-arm64": "1.33.0",
19
- "backlog.md-darwin-x64": "1.33.0",
20
- "backlog.md-darwin-arm64": "1.33.0",
21
- "backlog.md-windows-x64": "1.33.0"
17
+ "backlog.md-linux-x64": "1.35.0",
18
+ "backlog.md-linux-arm64": "1.35.0",
19
+ "backlog.md-darwin-x64": "1.35.0",
20
+ "backlog.md-darwin-arm64": "1.35.0",
21
+ "backlog.md-windows-x64": "1.35.0"
22
22
  },
23
23
  "scripts": {
24
24
  "postuninstall": "node postuninstall.cjs"