Documentation
¶
Index ¶
- Constants
- Variables
- func AddNote(nc *noteConfig) (string, error)
- func GetProject() (string, error)
- func InitializeProject(directory string) (string, error)
- func NewNoteConfig(message string, path string, options ...noteConfigOption) (*noteConfig, error)
- func WithIsSticky(isSticky bool) noteConfigOption
- func WithLineNo(lineNo int) noteConfigOption
- type InitConfig
Constants ¶
View Source
const ( RootDir = ".codenotes" NotesDir = "notes" )
Variables ¶
View Source
var ( ErrProjectNotFound = errors.New("project not found") ErrDirectoryDoesNotExist = errors.New("directory does not exist") )
Functions ¶
func GetProject ¶
GetProject get the closest codenotes projects. can be used in subdirectories
func InitializeProject ¶
InitializeProject creates the required directories necessary for a codenotes project
func NewNoteConfig ¶
func WithIsSticky ¶
func WithIsSticky(isSticky bool) noteConfigOption
func WithLineNo ¶
func WithLineNo(lineNo int) noteConfigOption
Types ¶
type InitConfig ¶
type InitConfig struct {
Directory string
}
Click to show internal directories.
Click to hide internal directories.