Skip to main content

Module service

Module service 

Source
Expand description

Use case (application service).

High-level operations called from CLI/TUI. Combine the domain layer and persistence layer.

Structs§

AddItemOutcome
Result of adding a PBI, including warning-only dependency-cycle information.
Board
Board data with columns ordered according to config.toml.
BoardColumn
One board column with its status and PBIs in ascending rank order.
BoardQuery
Filtering, scope, and sorting options for board. The default includes all PBIs and columns.
BoardSnapshot
A complete read-only snapshot of all board data exposed by export --json.
Burndown
Sprint burndown summary.
BurndownDay
Observation points for one day of burndown.
CycleTimeFilter
Optional filters for Cycle/Lead Time aggregation.
CycleTimeReport
Results of Cycle Time / Lead Time analysis.
DependencyOutcome
Result of add_dependency, including the updated PBI and any cycle warning.
DisplaySettings
Display settings for the show command.
DoctorFix
One safe mechanical change applied by doctor –fix.
DoctorIssue
One actionable board-integrity finding.
DoctorReport
Result of a board integrity scan.
DurationSummary
Summary statistics for a Duration sample.
Forest
Parent/child forest over a set of items, classified by membership in that set.
ItemDetail
Result of item_detail, with bidirectional links in ascending rank order.
ItemEdit
Fields to update with edit_item. A None field remains unchanged.
LinkOutcome
Result of link_commits or unlink_commits, including the updated PBI and changed SHAs.
ListFilter
Filters for list_items. Empty fields do not filter their corresponding property.
MoveOutcome
Result of moving a PBI, including the computed Acceptance Criteria progress.
NewItem
Optional fields for add_item. Unspecified fields use their domain defaults.
NextFilter
Filters for next_items.
RebalanceOutcome
Result of rebalance. Indicates the status of resolution of rank bloat.
SearchFilter
A validated search filter over a PBI and its assigned sprint metadata.
SprintLoadWarning
A non-blocking warning produced when a Sprint’s assigned points exceed a threshold.
SyncOutcome
Result of sync_commits, listing new (PBI ID, SHA) links.
TuiSettings
Settings required to launch the interactive Kanban view.
UndoOutcome
The result of a successful undo.
VelocityReport
Velocity summary for the selected recent sprints.
VelocitySprint
Velocity and estimate coverage for one sprint.
WipViolation
A column whose item count exceeds its WIP limit.

Enums§

BurndownMetric
The metric a burndown chart tracks.
DoctorIssueKind
Category of an integrity issue.
EditOutcome
Result of apply_item_edit.
ImportOutcome
Result of import_board.
InitOutcome
Result of init_board.
LabelMatch
Matching mode for a multi-label filter.
MigrateOutcome
Result of migrate_storage.
RemoveOutcome
Result of remove_item.
ReorderTarget
Specify the destination of reorder_item (how to change rank).
SearchMode
Search interpretation used by list, board, and Kanban filters.
SortKey
Sort key used within a board column.
SprintCloseAction
How unfinished PBIs are handled when their sprint closes.
SprintLoadWarningKind
The source of a non-blocking Sprint load warning.

Functions§

add_dependency
Add dependency dep to the PBI id and return DependencyOutcome.
add_item
Add a PBI to the board in project_dir and return the saved BacklogItem.
add_item_with_outcome
Add a PBI and report warning-only dependency cycles.
apply_item_edit
Validate Markdown edited with $EDITOR, apply permitted fields to PBI id, and save it.
archived_item_detail
Load archived PBI id with bidirectional links.
assign_sprint
Assign PBI item_id to sprint sprint_id and return the saved BacklogItem.
assign_sprint_by_status
Assign matching PBIs to a sprint in backlog rank order.
assign_sprint_raw
Assign a PBI from a raw CLI sprint ID, validating its grammar and existence before saving.
board
Load the board in project_dir, grouping PBIs in the column order from config.toml.
build_forest
Classify items into a Forest by parent membership within the same set.
burndown
Calculate the burndown for sprint sprint_id in project_dir.
check_wip
Load the board in project_dir and return the columns that exceed the WIP limit.
clear_common_dod
Delete a board’s common DoD. true if it exists, false (idempotent) if it does not exist.
close_sprint
Close the sprint (activeclosed) and return the saved Sprint.
common_dod
Load the board’s common DoD, returning None when the file is absent or empty.
create_sprint
Create a sprint on the board in project_dir and return the saved Sprint.
cycle_time
Aggregate Cycle/Lead Time for completed PBIs matching filter in project_dir.
delete_sprint
Delete a sprint and clear its assignment from every PBI that references it.
display_settings
Read display settings from the board. Return crate::error::Error::NotInitialized when it is uninitialized.
doctor
Inspect a board and optionally apply safe, mechanical repairs.
edit_item
Update the specified fields of PBI id, refresh updated, and return the saved BacklogItem.
edit_sprint
Update the title, goal, and/or planned period of an existing sprint.
export_snapshot
Load one read-only snapshot containing the board PBIs, Sprints, configuration, and common DoD.
hierarchical
Reorder items into canonical hierarchical priority order.
hierarchical_order
Pre-order traversal of the fully-expanded forest: every root in input order, each parent immediately followed by its subtree (children in input order). Cycle-only items are appended at the end so no item is lost.
import_board
Restore the board in project_dir from snapshot.
init_board
Initialize .pinto/ (config.toml and tasks/) in project_dir.
item_detail
Load PBI id with backward links (children and dependents).
item_edit_template
Format PBI id as the Markdown template used for $EDITOR editing.
link_commits
Add commit SHAs in shas to PBI id and return LinkOutcome.
list_items
Return PBIs from project_dir in canonical hierarchical priority order.
list_sprints
Return sprints from project_dir in ascending creation-time order.
lock_board
Acquire the board write lock for a caller that needs a consistent board snapshot.
migrate_storage
Migrate from the current backend to target and switch the save location of config.toml.
move_item
Move PBI id to workflow status to and return the saved BacklogItem.
move_item_with_outcome
Move PBI id and return the metadata needed by user interfaces for transition warnings.
next_items
Return the highest-ranked PBIs that are ready to start without modifying the board.
rebalance
Reassign oversized or duplicated ranks within each (status, parent) sibling scope.
remove_dependency
Remove dependency dep from PBI id and return the saved BacklogItem.
remove_item
Delete PBI with id. The default is archive backup, and if permanent is true, physical deletion is performed.
reorder_item
Sort the PBI by id within its sibling group and return the saved BacklogItem. Change only rank; keep status and parent.
restore_item
Restore archived PBI id to the active backlog and return the unchanged item.
set_common_dod
Replace the board’s common DoD and return the written file path.
set_sprint_capacity
Update sprint capacity settings and return the calculated capacity.
show_archived_item
Load archived PBI id from the board in project_dir.
show_item
Load PBI id from the board in project_dir.
sprint_capacity
Return the configured capacity for a sprint.
sprint_load_warnings
Calculate the current load warnings for a Sprint without changing board data.
start_sprint
Start a sprint (plannedactive). Returns the saved Sprint.
sync_commits
Synchronize commit links from git log by associating commits whose messages contain a PBI ID.
template_body
Read .pinto/templates/<kind>/<name>.md as plain text.
tui_settings
Read TUI settings from the board. Return crate::error::Error::NotInitialized when it is uninitialized.
unassign_sprint
Remove PBI item_id from sprint sprint_id and return the saved BacklogItem.
undo_last_mutation
Revert the most recent completed board mutation.
unlink_commits
Remove commits matching the SHA prefixes in shas from PBI id and return LinkOutcome.
velocity
Aggregate velocity for the most recent recent sprints in project_dir.
wip_violations
Compare each column limit in config with the corresponding item count and return the columns that exceed their limits.