search

Documentation

Overview

TODO: Add --name and --note flags to search command to allow searching in notes (currently only searches in item.Name)

Index

• func CompileRegexp(pattern string, ignoreCase bool) (*regexp.Regexp, error)
• func HighlightMatches(text string, positions []MatchPosition) string
• func SortGroupedResults(groups []GroupedResult, order OrderBy)
• func SortResults(results []Result, order OrderBy)
• func SortTreeNodes(nodes []*TreeNode, order OrderBy)
• type GroupedResult
  • func SearchItemsGroupedBy(items []*workflowy.Item, pattern string, ...) []GroupedResult
  • func (g GroupedResult) String() string
• type GroupingStrategy
  • func ParseGroupBy(value string, pathMaxLen int) (GroupingStrategy, error)
• type MatchPosition
  • func FindMatches(text, pattern string, useRegexp, ignoreCase bool) []MatchPosition
• type OrderBy
  • func ParseOrderBy(value string) (OrderBy, error)
• type Result
  • func SearchItems(items []*workflowy.Item, pattern string, ...) []Result
  • func (r Result) String() string
• type TreeNode
  • func SearchItemsTree(items []*workflowy.Item, pattern string, ...) []*TreeNode
  • func (n *TreeNode) String() string

Functions

func CompileRegexp

func CompileRegexp(pattern string, ignoreCase bool) (*regexp.Regexp, error)

func HighlightMatches

func HighlightMatches(text string, positions []MatchPosition) string

func SortGroupedResults

func SortGroupedResults(groups []GroupedResult, order OrderBy)

SortGroupedResults sorts groups. For parent/path/match it sorts by label; for modified/created it sorts by the max (or min) timestamp among children.

func SortResults

func SortResults(results []Result, order OrderBy)

SortResults sorts a flat result list by the given order.

func SortTreeNodes

func SortTreeNodes(nodes []*TreeNode, order OrderBy)

Types

type GroupedResult

type GroupedResult struct {
	GroupKey   string   `json:"group_key"`
	GroupLabel string   `json:"group_label"`
	Children   []Result `json:"children"`
}

GroupedResult represents search results grouped by a generic key.

func SearchItemsGroupedBy

func SearchItemsGroupedBy(items []*workflowy.Item, pattern string, useRegexp, ignoreCase, includeCompleted bool, strategy GroupingStrategy) []GroupedResult

SearchItemsGroupedBy searches items and groups results using the given strategy.

func (GroupedResult) String

func (g GroupedResult) String() string

type GroupingStrategy

type GroupingStrategy interface {
	GroupKey(item *workflowy.Item, ancestors []*workflowy.Item) string
	GroupLabel(item *workflowy.Item, ancestors []*workflowy.Item) string
}

GroupingStrategy determines how search results are grouped.

func ParseGroupBy

func ParseGroupBy(value string, pathMaxLen int) (GroupingStrategy, error)

ParseGroupBy parses a --group-by value into a GroupingStrategy.

type MatchPosition

type MatchPosition struct {
	Start int `json:"start"`
	End   int `json:"end"`
}

func FindMatches

func FindMatches(text, pattern string, useRegexp, ignoreCase bool) []MatchPosition

type OrderBy

type OrderBy struct {
	Field     string
	Ascending bool
}

OrderBy describes a sort field and direction.

func ParseOrderBy

func ParseOrderBy(value string) (OrderBy, error)

ParseOrderBy parses a --order-by value like "+modified", "-created", "match".

type Result

type Result struct {
	ID              string          `json:"id"`
	Name            string          `json:"name"`
	HighlightedName string          `json:"highlighted_name"`
	URL             string          `json:"url"`
	MatchPositions  []MatchPosition `json:"match_positions"`

	CreatedAt  int64  `json:"-"`
	ModifiedAt int64  `json:"-"`
	ParentName string `json:"-"`
	Path       string `json:"-"`
}

func SearchItems

func SearchItems(items []*workflowy.Item, pattern string, useRegexp, ignoreCase, includeCompleted bool) []Result

func (Result) String

func (r Result) String() string

type TreeNode

type TreeNode struct {
	ID       string      `json:"id"`
	Name     string      `json:"name"`
	URL      string      `json:"url"`
	IsMatch  bool        `json:"is_match,omitempty"`
	Children []*TreeNode `json:"children,omitempty"`

	HighlightedName string          `json:"highlighted_name,omitempty"`
	MatchPositions  []MatchPosition `json:"match_positions,omitempty"`

	CreatedAt  int64 `json:"-"`
	ModifiedAt int64 `json:"-"`
}

func SearchItemsTree

func SearchItemsTree(items []*workflowy.Item, pattern string, useRegexp, ignoreCase, includeCompleted bool) []*TreeNode

func (*TreeNode) String

func (n *TreeNode) String() string