internal

package

v0.1.1 Latest Latest Go to latest Published: Aug 12, 2021 License: Apache-2.0 Imports: 13 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

This section is empty.

View Source

var (
	Version = "0.1.0"
)

func FileExists(item, filename, dir string) (bool, error)

FileExists checks if a file already exists in the directory.

func OpenNote(note *Note)

OpenNote opens a note in a special terminal editor.

func UnmarshalNote(n *Note, fp string) error

UnmarshalNote parses the data in the specified file path and stores the result in the Note pointed to by n.

type Author struct {
	ID, Name string
	Notes    []string
}

func NewAuthor() (Author, error)

NewAuthor creates and returns a new author. It returns an error if any.

type Note struct {
	ID, AuthorName, Title, Body string
}

func NewNote(id, authorName string) Note

NewNote creates and returns a new note.

func (n *Note) TruncatedBody(length int) string

TruncatedBody truncates the note's body to a given length and returns it.

type Tag struct {
	Name string
}

func NewTag() (Tag, error)

NewTag creates and returns a new tag. It returns an error if any.