render

package
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 6, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package render produces CLI output: human, --plain, and --json.

--plain is stable, tab/line-oriented text for scripts; --json is the structured Task map shape. The default is friendlier human output. North is agent-driven, so machine-readable output is first-class.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Board

func Board(counts []tasks.StatusCount, drafts, archived int, warnings []tasks.Warning, plain, asJSON bool) (string, error)

Board renders a board summary: per-status counts plus draft/archive totals. JSON mode also carries any board warnings.

func DoctorReport

func DoctorReport(issues []tasks.Issue, plain, asJSON bool) (string, error)

DoctorReport renders doctor issues. Human/plain: one line per issue ("board is healthy" when clean); JSON: {"issues": [...]} with structured fields.

func TaskDetail

func TaskDetail(task *models.Task, plain, asJSON bool) (string, error)

TaskDetail renders one task (frontmatter fields + body).

func TaskList

func TaskList(taskList []*models.Task, warnings []tasks.Warning, plain, asJSON bool) (string, error)

TaskList renders a list of tasks. In JSON mode the payload is an object carrying the tasks plus any board warnings; human/plain modes print tasks only (warnings go to stderr in the CLI).

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL