Documentation
¶
Overview ¶
Package archive provides terminal output functions for the archive command.
Index ¶
- func DryRun(cmd *cobra.Command, archivableCount, pendingCount int, ...)
- func NoCompleted(cmd *cobra.Command)
- func SkipIncomplete(cmd *cobra.Command, skippedCount int)
- func Skipping(cmd *cobra.Command, taskText string)
- func SnapshotContent(name, created, separator, nl, body string) string
- func SnapshotSaved(cmd *cobra.Command, snapshotPath string)
- func Success(cmd *cobra.Command, archivedCount int, archiveFilePath string, ...)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DryRun ¶
DryRun prints the dry-run preview for task archiving.
Parameters:
- cmd: Cobra command for output. Nil is a no-op.
- archivableCount: number of tasks that would be archived.
- pendingCount: number of pending tasks remaining.
- preview: the archived content preview string.
- separator: the separator string for framing the preview.
func NoCompleted ¶
NoCompleted prints a message when there are no completed tasks to archive.
Parameters:
- cmd: Cobra command for output. Nil is a no-op.
func SkipIncomplete ¶
SkipIncomplete prints a summary when no tasks could be archived due to incomplete children.
Parameters:
- cmd: Cobra command for output. Nil is a no-op.
- skippedCount: number of skipped task blocks.
func Skipping ¶
Skipping prints a notice that a task block was skipped due to incomplete children.
Parameters:
- cmd: Cobra command for output. Nil is a no-op.
- taskText: the parent task description.
func SnapshotContent ¶
SnapshotContent builds the snapshot file content with header and body.
Parameters:
- name: snapshot name.
- created: RFC3339 formatted creation timestamp.
- separator: the separator string.
- nl: newline string.
- body: the original TASKS.md content.
Returns:
- string: formatted snapshot content.
func SnapshotSaved ¶
SnapshotSaved prints the result of a successful task snapshot.
Parameters:
- cmd: Cobra command for output. Nil is a no-op.
- snapshotPath: path to the created snapshot file.
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.