lib

package
v0.0.6 Latest Latest
Warning

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

 Go to latest Published: Aug 3, 2021 License: MIT Imports: 18 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	MetadataStartSequence = "---\n"
	MetadataEndSequence   = "...\n"
)

Variables

This section is empty.

Functions

func GenerateAlfredJson added in v0.0.6 

func GenerateAlfredJson(i AlfredItem) (j string, err error)

func GetCleanActions added in v0.0.1 

func GetCleanActions() map[string]CleanAction

func MakePathFromTime added in v0.0.4 

func MakePathFromTime(basePath string, t time.Time) (filename string)

func TimeFromPath added in v0.0.4 

func TimeFromPath(path string) (t time.Time, err error)

func ZettelIdFromPath added in v0.0.4 

func ZettelIdFromPath(path string) (zi string, err error)

Types

type AlfredItem added in v0.0.6 

type AlfredItem struct {
	Title        string         `json:"title"`
	Arg          string         `json:"arg"`
	Subtitle     string         `json:"subtitle"`
	Match        string         `json:"match"`
	Icon         AlfredItemIcon `json:"icon"`
	Uid          string         `json:"uid"`
	ItemType     string         `json:"type"`
	QuicklookUrl string         `json:"quicklookurl"`
	Text         AlfredItemText `json:"text"`
}

type AlfredItemIcon added in v0.0.6 

type AlfredItemIcon struct {
	Type string `json:"type"`
	Path string `json:"path"`
}

type AlfredItemText added in v0.0.6 

type AlfredItemText struct {
	Copy string `json:"copy"`
}

type CleanAction 

type CleanAction struct {
	Check   CleanActionCheck
	Perform CleanActionPerform
}

type CleanActionCheck 

type CleanActionCheck func(z *Zettel) bool

TODO swithch to p rintable description

type CleanActionPerform 

type CleanActionPerform func(z *Zettel) (bool, error)

type Env added in v0.0.4 

type Env struct {
	BasePath string
	ZettelPool
}

func GetDefaultEnv added in v0.0.4 

func GetDefaultEnv() (e *Env, err error)

func (*Env) GetAllZettels added in v0.0.4 

func (e *Env) GetAllZettels() (zettels []string, err error)

func (*Env) GetNormalizedPath added in v0.0.4 

func (e *Env) GetNormalizedPath(a string) (b string, err error)

type FormatFunc added in v0.0.4 

type FormatFunc func(*Zettel) string

func MakePrintfFormatFunc added in v0.0.4 

func MakePrintfFormatFunc(format string) FormatFunc

type Formatter added in v0.0.4 

type Formatter interface {
	Format(*Zettel) string
}

func MakePrintfFormatter added in v0.0.4 

func MakePrintfFormatter(format string) Formatter

type Index added in v0.0.4 

type Index struct {
}

type IndexZettel added in v0.0.4 

type IndexZettel struct {
}

type Metadata added in v0.0.4 

type Metadata []string

type MetadataFieldReadWriterArray added in v0.0.3 

type MetadataFieldReadWriterArray struct {
	ValueGetFunc func(z *Zettel) []string
	ValueSetFunc func(z *Zettel, v []string)
}

func GetMetadataFieldReadWriterNull added in v0.0.3 

func GetMetadataFieldReadWriterNull() MetadataFieldReadWriterArray

func GetMetadataFieldReadWriterTags added in v0.0.3 

func GetMetadataFieldReadWriterTags() MetadataFieldReadWriterArray

type OnZettelWriteFunc added in v0.0.4 

type OnZettelWriteFunc func(*Zettel, error) error

func AddFileOnWrite added in v0.0.4 

func AddFileOnWrite(oldPath string) OnZettelWriteFunc

func AddUrlOnWrite added in v0.0.4 

func AddUrlOnWrite(u string, t time.Time) OnZettelWriteFunc

type Zettel 

type Zettel struct {
	Env       *Env
	Path      string
	Id        int64
	IndexData ZettelIndexData
	Data      ZettelData
}

func (*Zettel) Edit added in v0.0.4 

func (z *Zettel) Edit() (err error)

func (*Zettel) FilePath added in v0.0.4 

func (z *Zettel) FilePath() string

func (*Zettel) Format added in v0.0.6 

func (z *Zettel) Format(f string) string

func (*Zettel) GenerateMetadataYaml added in v0.0.4 

func (z *Zettel) GenerateMetadataYaml() (err error)

func (*Zettel) HasFile added in v0.0.4 

func (z *Zettel) HasFile() bool

func (*Zettel) HasUrl added in v0.0.4 

func (z *Zettel) HasUrl() bool

func (*Zettel) HydrateFromFilePath 

func (z *Zettel) HydrateFromFilePath(readBody bool) (err error)

func (*Zettel) InitFromTime added in v0.0.4 

func (z *Zettel) InitFromTime(t time.Time)

func (*Zettel) Open added in v0.0.4 

func (z *Zettel) Open() (err error)

func (*Zettel) ParseMetadata 

func (z *Zettel) ParseMetadata() (err error)

func (*Zettel) ReadMetadata 

func (zettel *Zettel) ReadMetadata() (err error)

func (*Zettel) ReadMetadataAndBody 

func (zettel *Zettel) ReadMetadataAndBody() (err error)

func (*Zettel) Write 

func (z *Zettel) Write(onWriteFunc OnZettelWriteFunc) (err error)

type ZettelData added in v0.0.4 

type ZettelData struct {
	MetadataYaml string
	Body         string
}

type ZettelIndexData added in v0.0.4 

type ZettelIndexData struct {
	Date         string   `yaml:"-" json:"date,omitempty"`
	Description  string   `yaml:"description,omitempty" json:"description,omitempty"`
	Tags         []string `yaml:"tags,omitempty" json:"tags,omitempty"`
	ExpandedTags []string `yaml:"-" json:"expanded_tags,omitempty"`
	Url          string   `yaml:"url,omitempty" json:"url,omitempty"`
	File         string   `yaml:"file,omitempty" json:"file,omitempty"`
}

func (ZettelIndexData) ToMetadata added in v0.0.4 

func (id ZettelIndexData) ToMetadata() (md Metadata)

type ZettelPool 

type ZettelPool interface {
	Get() *Zettel
	Put(*Zettel)
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.