notes

type Categories map[string]*Category

type CategoriesCmd struct {
	Config *Config
	// Out is a writer to write output of this command. Kind of stdout is expected
	Out io.Writer
	// contains filtered or unexported fields
}

type Category struct {
	// Path is a path to the category directory
	Path string
	// Name is a name of category
	Name string
	// NotePaths are paths to notes of the category
	NotePaths []string
}

type CategoryCollectMode uint

type Cmd interface {
	Do() error
}

type Config struct {
	// HomePath is a file path to directory of home of notes command. If $NOTES_HOME is set, it is used.
	// Otherwise, notes directory in XDG data directory is used. This directory is automatically created
	// when config is created
	HomePath string
	// GitPath is a file path to `git` executable. If $NOTES_GIT is set, it is used.
	// Otherwise, `git` is used by default. This is optional and can be empty. When empty, some command
	// and functionality which require Git don't work
	GitPath string
	// EditorCmd is a command of your favorite editor. If $NOTES_EDITOR is set, it is used. This value is
	// similar to $EDITOR environment variable and can contain command arguments like "vim -g". Otherwise,
	// this value will be empty. When empty, some functionality which requires an editor to open note doesn't
	// work
	EditorCmd string
	// PagerCmd is a command for paging output from 'list' subcommand. If $NOTES_PAGER is set, it is used.
	PagerCmd string
	// SortBy is the default sort order for list and find commands. If $NOTES_SORT_BY is set, it is used.
	// Valid values: "created", "modified", "filename", "category". Default is "created".
	SortBy string
}

type ConfigCmd struct {
	Config *Config
	// Name is a name of configuration. Must be one of "", "home", "git", "editor", "pager" or "sort_by"
	Name string
	// Out is a writer to write output of this command. Kind of stdout is expected
	Out io.Writer
	// contains filtered or unexported fields
}

type EditCmd struct {

	// Category is the category of the note to edit
	Category string
	// File is the filename of the note to edit
	File   string
	Config *Config
	// contains filtered or unexported fields
}

type ExternalCmd struct {
	// ExePath is a path to executable of the external subcommand
	ExePath string
	// Args is arguments passed to external subcommand. Arguments specified to `notes` are forwarded
	Args []string
	// NotesPath is an executable path of the `notes` command. This is passed to the first argument of external subcommand
	NotesPath string
}

type FindCmd struct {
	Config *Config
	// Query is a query string for searching notes
	Query string
	// Relative is a flag equivalent to --relative
	Relative bool
	// SortBy is a string indicating how to sort the list. This value is equivalent to --sort option
	SortBy string
	// Edit is a flag equivalent to --edit
	Edit bool
	// TopOne is a flag equivalent to --topone
	TopOne bool
	// Full is a flag equivalent to --full
	Full bool
	// JSON is a flag equivalent to --json
	JSON bool
	// Out is a writer to write output of this command. Kind of stdout is expected
	Out io.Writer
	// contains filtered or unexported fields
}

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

type ListCmd struct {
	Config *Config
	// Full is a flag equivalent to --full
	Full bool
	// Category is a regex string equivalent to --cateogry
	Category string
	// Tag is a regex string equivalent to --tag
	Tag string
	// Relative is a flag equivalent to --relative
	Relative bool
	// Oneline is a flag equivalent to --oneline
	Oneline bool
	// Tag is a string indicating how to sort the list. This value is equivalent to --sort option
	SortBy string
	// Edit is a flag equivalent to --edit
	Edit bool
	// JSON is a flag equivalent to --json
	JSON bool
	// Out is a writer to write output of this command. Kind of stdout is expected
	Out io.Writer
	// contains filtered or unexported fields
}

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

type MoveCmd struct {

	// Category is the current category of the note
	Category string
	// File is the filename of the note
	File string
	// NewCategory is the destination category
	NewCategory string
	Config      *Config
	// contains filtered or unexported fields
}

type NewCmd struct {
	Config *Config
	// Category is a category name of the new note. This must be a name allowed for directory name
	Category string
	// Filename is a file name of the new note
	Filename string
	// Tags is a comma-separated string of tags of the new note
	Tags string
	// NoInline is a flag equivalent to --no-inline-input
	NoInline bool
	// NoEdit is a flag equivalent to --no-edit
	NoEdit bool
	// contains filtered or unexported fields
}

type Note struct {
	// Config is a configuration of notes command which was created by NewConfig()
	Config *Config
	// Category is a category string. It must not be empty
	Category string
	// Tags is tags of note. It can be empty and cannot contain comma
	Tags []string
	// Created is a datetime when note was created
	Created time.Time
	// File is a file name of the note
	File string
	// Title is a title string of the note. When the note is not created yet, it may be empty
	Title string
}

type PagerWriter struct {

	// Cmdline is a string of command line which was spawned
	Cmdline string
	// Err is an error instance which occurred while paging.
	Err error
	// contains filtered or unexported fields
}

type RmCmd struct {

	// Category is the category of the note to remove
	Category string
	// File is the filename of the note to remove
	File   string
	Config *Config
	// contains filtered or unexported fields
}

type SaveCmd struct {
	Config *Config
	// Message is a message of Git commit which will be created to save notes. If this value is empty,
	// automatically generated message will be used.
	Message string
	// contains filtered or unexported fields
}

type SelfupdateCmd struct {

	// Dry is a flag equivalent to --dry
	Dry bool
	// Slug is a "user/repo" string where releases are put. This field is useful when you forked
	// notes into your own repository.
	Slug string
	// Out is a writer to write output of this command. Kind of stdout is expected
	Out io.Writer
	// contains filtered or unexported fields
}

type TagsCmd struct {
	Config *Config
	// Category is a category name of tags. If this value is empty, tags of all categories will be output
	Category string
	// Out is a writer to write output of this command. Kind of stdout is expected
	Out io.Writer
	// contains filtered or unexported fields
}