gurnel

package

v1.2.3 Latest Latest Go to latest Published: Apr 25, 2022 License: MIT Imports: 25 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/mikeraimondi/gurnel

Links

Open Source Insights

Documentation ¶

Index ¶

func Do(r io.Reader, w io.Writer, conf *Config) error
func IsEntry(path string) bool
type Config
- func (c *Config) Load(path ...string) error
type Entry
- func NewEntry(dir string, t time.Time) (*Entry, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Do ¶

func Do(r io.Reader, w io.Writer, conf *Config) error

func IsEntry ¶

func IsEntry(path string) bool

IsEntry returns true if path refers to a file with an Entry-like name, false otherwise.

Types ¶

type Config ¶ added in v1.2.0

type Config struct {
	BeeminderEnabled   bool
	BeeminderUser      string
	BeeminderTokenFile string
	BeeminderGoal      string
	MinimumWordCount   int
	Editor             string
	// contains filtered or unexported fields
}

func (*Config) Load ¶ added in v1.2.0

func (c *Config) Load(path ...string) error

type Entry ¶

type Entry struct {
	Seconds     uint16
	LowMood     uint8
	HighMood    uint8
	AverageMood uint8
	Body        []byte    `yaml:"-"`
	Path        string    `yaml:"-"`
	ModTime     time.Time `yaml:"-"`
}

Entry represents a single journal entry.

func NewEntry ¶

func NewEntry(dir string, t time.Time) (*Entry, error)

NewEntry reads the directory named by dir and either returns an existing Entry in that directory, or creates a new one if none exist.

func (*Entry) Date ¶

func (p *Entry) Date() (time.Time, error)

Date returns the date of the entry

func (*Entry) Load ¶

func (p *Entry) Load() (modified bool, err error)

Load reads the file named by p.Path and populates the Entry

func (*Entry) PromptForMetadata ¶

func (p *Entry) PromptForMetadata(reader io.Reader, w io.Writer) error

PromptForMetadata prints questions to w and sets the values of p based on values read from reader.

func (*Entry) Save ¶

func (p *Entry) Save() (err error)

Save writes the Entry to the file named by p.Path

func (*Entry) Words ¶

func (p *Entry) Words() [][]byte

Words returns the number of words in p.body

Source Files ¶

View all Source files

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