lib

package
v0.0.12 Latest Latest
Warning

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

 Go to latest Published: Sep 8, 2021 License: MIT Imports: 22 Imported by: 0

Documentation

Index

Constants

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

Variables

View Source 
var (
	RegexTag *regexp.Regexp
)

Functions

func DefaultConfigPath added in v0.0.11 

func DefaultConfigPath() (p string, err error)

func GenerateAlfredItemsJson added in v0.0.7 

func GenerateAlfredItemsJson(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 Config added in v0.0.11 

type Config struct {
	ConfigTagForNewZettels

	Tags          map[string]TagConfig
	Kasten        map[string]KastenConfig
	DefaultKasten string `toml:"default-kasten"`
}

func DefaultConfig added in v0.0.11 

func DefaultConfig() (c Config, err error)

func LoadConfig added in v0.0.11 

func LoadConfig(p string) (c Config, err error)

func LoadDefaultConfig added in v0.0.11 

func LoadDefaultConfig() (c Config, err error)

func (Config) Umwelt added in v0.0.11 

func (c Config) Umwelt() (e Umwelt, err error)

type ConfigTagForNewZettels added in v0.0.11 

type ConfigTagForNewZettels struct {
	TagForNewZettels string `toml:"tag-for-new-zettels"`
}

type FilesAndGit added in v0.0.11 

type FilesAndGit struct {
	BasePath        string
	Index           Index
	GitEnabled      bool
	GitAnnexEnabled bool
}
var (
	FilesAndGitInstance *FilesAndGit
)

func (*FilesAndGit) GetAll added in v0.0.11 

func (e *FilesAndGit) GetAll() (zettels []string, err error)

func (*FilesAndGit) GetNormalizedPath added in v0.0.11 

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

func (*FilesAndGit) InitFromOptions added in v0.0.11 

func (k *FilesAndGit) InitFromOptions(o map[string]interface{}) (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 {
	Zettels map[int64]IndexZettel
	Files   ZettelIdMap
	Urls    ZettelIdMap
	Tags    ZettelIdMap
	*sync.Mutex
}

func MakeIndex added in v0.0.10 

func MakeIndex() Index

func (Index) Add added in v0.0.10 

func (i Index) Add(z *Zettel) error

func (Index) Get added in v0.0.10 

func (m Index) Get(k int64) (IndexZettel, bool)

func (Index) HydrateZettel added in v0.0.10 

func (i Index) HydrateZettel(z *Zettel, zb IndexZettel)

func (Index) Set added in v0.0.10 

func (m Index) Set(k int64, z IndexZettel)

func (Index) ZettelsForUrl added in v0.0.10 

func (i Index) ZettelsForUrl(u string) (o []IndexZettel)

type IndexZettel added in v0.0.4 

type IndexZettel struct {
	Path     string
	Id       int64
	Metadata Metadata
}

type KastenConfig added in v0.0.11 

type KastenConfig struct {
	ConfigTagForNewZettels

	Implementation string `toml:"type"`
	Options        map[string]interface{}
}

type KastenImplementation added in v0.0.11 

type KastenImplementation interface {
	GetAll() (zs []int64, err error)
	Hydrate(readBody bool) (err error)
	ReadMetadata() (err error)
	ParseMetadata() (err error)
	ReadMetadataAndBody() (err error)
	Write(onWriteFunc OnZettelWriteFunc) (err error)
}

type Metadata added in v0.0.4 

type Metadata 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 (Metadata) ToMetadata added in v0.0.11 

func (id Metadata) ToMetadata() (md MetadataList)

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 MetadataList added in v0.0.11 

type MetadataList []string

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 TagConfig added in v0.0.11 

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

type Umwelt added in v0.0.11 

type Umwelt struct {
	DefaultKasten kasten.Implementation
	Kasten        map[string]kasten.Implementation
}

func (Umwelt) FilesAndGit added in v0.0.11 

func (u Umwelt) FilesAndGit() *FilesAndGit

type Zettel 

type Zettel struct {
	Umwelt   Umwelt
	Id       int64
	Metadata Metadata
	Body     string

	Path string
	Data ZettelData
}

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) FromMetadata added in v0.0.10 

func (z *Zettel) FromMetadata(md MetadataList) (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) Hydrate added in v0.0.11 

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

func (*Zettel) InitAndAssignUniqueId added in v0.0.10 

func (z *Zettel) InitAndAssignUniqueId(currentTime time.Time, i int) (err error)

func (*Zettel) InitFromTime added in v0.0.4 

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

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
}

type ZettelIdMap added in v0.0.10 

type ZettelIdMap struct {
	*sync.Mutex
	// contains filtered or unexported fields
}

func MakeZettelIdMap added in v0.0.10 

func MakeZettelIdMap() ZettelIdMap

func (ZettelIdMap) Add added in v0.0.10 

func (m ZettelIdMap) Add(k string, id int64)

func (ZettelIdMap) Get added in v0.0.10 

func (m ZettelIdMap) Get(k string) ([]int64, bool)

func (ZettelIdMap) Set added in v0.0.10 

func (m ZettelIdMap) Set(k string, ids []int64)

Source Files

View all Source files

Directories

Path Synopsis

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.