utils

Documentation

Index

• Constants
• func AskConfirmation(question string) (bool, error)
• func ChangeBook(bookName string) error
• func CheckFileExists(filepath string) bool
• func GenerateConfigFile() error
• func GenerateNoteID() string
• func GetBooks() ([]string, error)
• func GetConfigPath() (string, error)
• func GetCurrentBook() (string, error)
• func GetDnotePath() (string, error)
• func GetDnoteUpdatePath() (string, error)
• func GetYAMLDnoteArchivePath() (string, error)
• func ReadNoteContent() ([]byte, error)
• func TouchDnoteFile() error
• func TouchDnoteUpgradeFile() error
• func WriteConfig(config Config) error
• func WriteDnote(dnote Dnote) error
• type Book
• type Config
  • func ReadConfig() (Config, error)
• type Dnote
  • func GetDnote() (Dnote, error)
• type Note
• type YAMLDnote
  • func GetNote() (YAMLDnote, error)

Constants

const DnoteUpdateFilename = ".dnote-upgrade"

const Version = "0.1.0"

Functions

func AskConfirmation

func AskConfirmation(question string) (bool, error)

func ChangeBook

func ChangeBook(bookName string) error

ChangeBook replaces the book name in the dnote config file

func CheckFileExists

func CheckFileExists(filepath string) bool

CheckFileExists checks if the file exists at the given path

func GenerateConfigFile

func GenerateConfigFile() error

func GenerateNoteID

func GenerateNoteID() string

func GetBooks

func GetBooks() ([]string, error)

func GetConfigPath

func GetConfigPath() (string, error)

func GetCurrentBook

func GetCurrentBook() (string, error)

func GetDnotePath

func GetDnotePath() (string, error)

func GetDnoteUpdatePath

func GetDnoteUpdatePath() (string, error)

func GetYAMLDnoteArchivePath

func GetYAMLDnoteArchivePath() (string, error)

func ReadNoteContent

func ReadNoteContent() ([]byte, error)

ReadNoteContent reads the content of dnote

func TouchDnoteFile

func TouchDnoteFile() error

func TouchDnoteUpgradeFile

func TouchDnoteUpgradeFile() error

func WriteConfig

func WriteConfig(config Config) error

func WriteDnote

func WriteDnote(dnote Dnote) error

WriteDnote persists the state of Dnote into the dnote file

Types

type Book

type Book []Note

type Config

type Config struct {
	Book   string
	APIKey string
}

func ReadConfig

func ReadConfig() (Config, error)

type Dnote

type Dnote map[string]Book

func GetDnote

func GetDnote() (Dnote, error)

GetDnote reads and parses the dnote

type Note

type Note struct {
	UID     string
	Content string
	AddedOn int64
}

type YAMLDnote

type YAMLDnote map[string][]string

Deprecated. See upgrade/migrate.go

func GetNote

func GetNote() (YAMLDnote, error)

Deprecated. See upgrade/upgrade.go