view

Documentation

Overview

Package view persists named "smart views" — saved bundles of the `nt list` filter so a user can capture a query once and recall it by name (T4). Views live in $NT_DIR/views.json, a machine-managed file (like undo.jsonl), kept separate from the hand-edited, read-only config.toml so `nt view save` never rewrites a user's annotated config. The package is surface-agnostic: it knows only the filter shape, not how any front-end renders a list, so the CLI, TUI, and web can all share these specs.

Index

• Constants
• func Load(dir string) (map[string]Spec, error)
• func Names(views map[string]Spec) []string
• func Save(dir string, views map[string]Spec) error
• func ValidName(s string) error
• type Spec
  • func (s Spec) Args() []string
  • func (s Spec) Summary() string

Constants

const FileName = "views.json"

FileName is the views file's basename within $NT_DIR.

Functions

func Load

func Load(dir string) (map[string]Spec, error)

Load reads $NT_DIR/views.json. A missing file yields an empty (non-nil) map and no error, so callers can treat "no views yet" as the normal first run.

func Names

func Names(views map[string]Spec) []string

Names returns the saved view names sorted alphabetically.

func Save

func Save(dir string, views map[string]Spec) error

Save writes the view set atomically. An empty map is written as `{}` rather than removing the file, keeping the path stable.

func ValidName

func ValidName(s string) error

ValidName reports whether s is usable as a view name: non-empty, no spaces or path/glob characters, and not a reserved subcommand word.

Types

type Spec

type Spec struct {
	Status      string `json:"status,omitempty"`
	Tag         string `json:"tag,omitempty"`
	Project     string `json:"project,omitempty"`
	Sort        string `json:"sort,omitempty"`
	All         bool   `json:"all,omitempty"`
	ShowBlocked bool   `json:"showBlocked,omitempty"`
	Tree        bool   `json:"tree,omitempty"`
}

Spec is one saved view: the subset of `nt list` flags that select and order tasks. Output-only choices (e.g. --json) are deliberately excluded — they are a recall-time concern, not part of the saved query.

func (Spec) Args

func (s Spec) Args() []string

Args renders a Spec back into the `nt list` flags it represents, in a stable order. It is the inverse of capturing flags, used both to show a view's definition (`nt view list`) and to document what a recall will run. An empty Spec (the all-open default) renders as no flags.

func (Spec) Summary

func (s Spec) Summary() string

Summary is a one-line human description of a view's flags, e.g. "--status open --sort due", or "(all open tasks)" when it has no filters.