Package klein

import "codeberg.org/xyank/klein"

Overview
Index
Subdirectories

Overview

Index

Constants
Variables
func AdjustCell(text string, width int) string
func CommandAdd(conf Config, cmdLine CmdLine) error
func CommandDashboard(conf Config, cmdLine CmdLine) error
func CommandDelete(conf Config, cmdLine CmdLine) error
func CommandEdit(conf Config, cmdLine CmdLine) error
func CommandInit(conf Config, cmdLine CmdLine) error
func CommandReview(conf Config, cmdLine CmdLine) error
func DeduplicateStrings(strings []string) []string
func EnsureRepoExists(repoPath string) error
func GetValidConfidenceValue(text string) (value float64, err error)
func GetValidJudgementValue(text string) (string, error)
func IsValidConfidenceValue(c float64) bool
func IsValidStatus(s string) error
func IsValidUUIDv4String(str string) bool
func MaxInt(vals []int) (index int, max int)
func MustEditBytes(data []byte, extension string) ([]byte, error)
func MustGetTermSize() (int, int, error)
func MustGetUUID4String() string
func RunCmd(name string, args ...string) error
func StrSliceContains(haystack []string, needle string) bool
func StrSliceContainsAll(subset, superset []string) bool
func SumInts(vals ...int) int
type CmdLine
func ParseCmdLine(args ...string) (CmdLine, error)
type Config
func NewConfig() Config
type Decision
func UnmarshalDecision(path string, finfo os.FileInfo, ids IdsMap, status string) (Decision, error)
func (d *Decision) DeleteCopies(repoPath string) error
func (d *Decision) NormaliseFields()
func (d *Decision) SaveToDisk(repoPath string) error
func (d *Decision) ValidateFields() error
type DecisionSet
func NewDecisionSet(repoPath, idsFilePath string, opts ...DecisionSetOpt) (*DecisionSet, error)
func (ds *DecisionSet) DisplayDashboard() error
func (ds *DecisionSet) FilteredDecisions() []Decision
func (ds *DecisionSet) LoadDecision(decision Decision) Decision
func (ds *DecisionSet) MustUpdateDecision(d Decision) error
func (ds *DecisionSet) SavePendingChanges() error
type DecisionSetOpt
func WithIDs(ids ...int) DecisionSetOpt
func WithStatuses(statuses ...string) DecisionSetOpt
func WithTags(tags ...string) DecisionSetOpt
type DecisionSetOpts
type IdsMap
func LoadIds(idsFilePath string) (IdsMap, error)
func (ids *IdsMap) SaveIds(idsFilePath string) error
type RowStyle
type Table
func NewTable(width int, header ...string) *Table
func (t *Table) AddRow(row []string, style RowStyle) error
func (t *Table) Render() (err error)

Package files

cmdline.go commands.go config.go const.go data.go decision.go decisionset.go display.go localstate.go table.go util.go

Constants

const (
    CMD_INIT    = "init"
    CMD_EDIT    = "edit"
    CMD_ADD     = "add"
    CMD_HELP    = "help"
    CMD_VERSION = "version"
    CMD_REVIEW  = "review"
    CMD_DELETE  = "delete"

    STATUS_PENDING  = "pending"  // to review
    STATUS_REVIEWED = "reviewed" // reviewed, may re-review later
    STATUS_DELETED  = "deleted"  // moved to deleted folder

    TABLE_MAX_WIDTH  = 160
    TABLE_COL_GAP    = 2
    ANSI_CODE_HEADER = 1 // Bold the header by default

    UUIDv4_LEN = 36

    // TODO After implementing status, rename this constant
    MAX_DECISIONS = 10000
)

Variables

var ALL_CMDS = []string{
    CMD_INIT,
    CMD_EDIT,
    CMD_ADD,
    CMD_HELP,
    CMD_VERSION,
    CMD_REVIEW,
    CMD_DELETE,
}

var ALL_STATUSES = []string{
    STATUS_PENDING,
    STATUS_REVIEWED,
    STATUS_DELETED,
}

var NON_RESOLVED_STATUSES = []string{
    STATUS_PENDING,
    STATUS_REVIEWED,
}

func AdjustCell

func AdjustCell(text string, width int) string

format cell text to conform to the specified width

func CommandAdd

func CommandAdd(conf Config, cmdLine CmdLine) error

func CommandDashboard

func CommandDashboard(conf Config, cmdLine CmdLine) error

Print a tree style dashboard of unresolved decisions Default command

func CommandDelete

func CommandDelete(conf Config, cmdLine CmdLine) error

func CommandEdit

func CommandEdit(conf Config, cmdLine CmdLine) error

Edit a decision using an editor

func CommandInit

func CommandInit(conf Config, cmdLine CmdLine) error

Create data dir and init git repository

func CommandReview

func CommandReview(conf Config, cmdLine CmdLine) error

func DeduplicateStrings

func DeduplicateStrings(strings []string) []string

func EnsureRepoExists

func EnsureRepoExists(repoPath string) error

func GetValidConfidenceValue

func GetValidConfidenceValue(text string) (value float64, err error)

func GetValidJudgementValue

func GetValidJudgementValue(text string) (string, error)

func IsValidConfidenceValue

func IsValidConfidenceValue(c float64) bool

func IsValidStatus

func IsValidStatus(s string) error

func IsValidUUIDv4String

func IsValidUUIDv4String(str string) bool

func MaxInt

func MaxInt(vals []int) (index int, max int)

func MustEditBytes

func MustEditBytes(data []byte, extension string) ([]byte, error)

func MustGetTermSize

func MustGetTermSize() (int, int, error)

func MustGetUUID4String

func MustGetUUID4String() string

func RunCmd

func RunCmd(name string, args ...string) error

func StrSliceContains

func StrSliceContains(haystack []string, needle string) bool

func StrSliceContainsAll

func StrSliceContainsAll(subset, superset []string) bool

Return true iff superset contains entire subset

func SumInts

func SumInts(vals ...int) int

type CmdLine

Struct of all possible elements in a command line (after the command itself)

type CmdLine struct {
    Cmd         string
    IDs         []int
    Tags        []string
    Confidence  float64
    Text        string
    Judgement   string
    Reason      string
    Review      string
    Status      string
    Description string
}

func ParseCmdLine

func ParseCmdLine(args ...string) (CmdLine, error)

type Config

type Config struct {
    // Path to git repository (not the .git/ directory but the work tree) used for yaml files
    Repo string

    // Path to persistent storage of ephemeral IDs
    IDsFile string
}

func NewConfig

func NewConfig() Config

type Decision

Decisions are statements that are "backed" (that is, associated with) predictions. Computationally this means that it contains a list of predictions.

type Decision struct {
    // not stored in file -- rather filename and directory
    UUID   string `yaml:"-"`          // yaml ignores this field
    Status string `yaml:",omitempty"` // show status when editing via edit command

    // is new or has changed. Need to write to disk.
    WritePending bool `yaml:"-"`

    // Mark decision for deletion
    Deleted bool `yaml:"-"`

    // ephemeral
    ID int `yaml:"-"`

    Decision    string
    Description string `yaml:",omitempty"`
    Confidence  float64
    Tags        []string
    Reason      string `yaml:",omitempty"`

    // Use string so that "false" judgements are also written to reviewed decisions
    Judgement string `yaml:",omitempty"`
    Review    string `yaml:",omitempty"`

    Created  time.Time
    Reviewed time.Time `yaml:",omitempty"`
    // contains filtered or unexported fields
}

func UnmarshalDecision

func UnmarshalDecision(path string, finfo os.FileInfo, ids IdsMap, status string) (Decision, error)

Unmarshall a Decision, given a YAML file path

func (*Decision) DeleteCopies

func (d *Decision) DeleteCopies(repoPath string) error

func (*Decision) NormaliseFields

func (d *Decision) NormaliseFields()

Mutate and sort fields to a common format Makes git diffs more useful

func (*Decision) SaveToDisk

func (d *Decision) SaveToDisk(repoPath string) error

func (*Decision) ValidateFields

func (d *Decision) ValidateFields() error

TODO Add more validation for fields if necessary here

type DecisionSet

type DecisionSet struct {
    Decisions []*Decision
    // contains filtered or unexported fields
}

func NewDecisionSet

func NewDecisionSet(repoPath, idsFilePath string, opts ...DecisionSetOpt) (*DecisionSet, error)

func (*DecisionSet) DisplayDashboard

func (ds *DecisionSet) DisplayDashboard() error

func (*DecisionSet) FilteredDecisions

func (ds *DecisionSet) FilteredDecisions() []Decision

func (*DecisionSet) LoadDecision

func (ds *DecisionSet) LoadDecision(decision Decision) Decision

Add a decision to DecisionSet, keeping in mind the DecisionSet's state This means this function adjusts the ID of the decision (only if necessary), adds a UUID if none exists, and adds the Created time if it isn't there either

func (*DecisionSet) MustUpdateDecision

func (ds *DecisionSet) MustUpdateDecision(d Decision) error

replace decision in set with the new one

func (*DecisionSet) SavePendingChanges

func (ds *DecisionSet) SavePendingChanges() error

save pending changes to disk

type DecisionSetOpt

type DecisionSetOpt func(opts *DecisionSetOpts)

func WithIDs

func WithIDs(ids ...int) DecisionSetOpt

func WithStatuses

func WithStatuses(statuses ...string) DecisionSetOpt

func WithTags

func WithTags(tags ...string) DecisionSetOpt

type DecisionSetOpts

type DecisionSetOpts struct {
    // contains filtered or unexported fields
}

type IdsMap

persistent DB of UUID -> ID Ensures that decision have a persistent ID local to the machine for their lifetime Ensures the correct decision is targeted between operations

type IdsMap map[string]int

func LoadIds

func LoadIds(idsFilePath string) (IdsMap, error)

func (*IdsMap) SaveIds

func (ids *IdsMap) SaveIds(idsFilePath string) error

type RowStyle

type RowStyle struct {
    // ansi mode
    Mode int
}

type Table

type Table struct {
    Header    []string
    Rows      [][]string
    RowStyles []RowStyle
    Width     int
}

func NewTable

func NewTable(width int, header ...string) *Table

func (*Table) AddRow

func (t *Table) AddRow(row []string, style RowStyle) error

func (*Table) Render

func (t *Table) Render() (err error)

Subdirectories

Name	Synopsis

klein

codeberg.org/xyank/klein

klein