pkg

Documentation

Index

• func Contains(slice []string, val string) bool
• func ConvertTagsToString(tags []string) string
• func ParseTags(inputTags string) []string
• func Start(templatePath string, tags string, outputDirPath string, docType string)
• type Content
  • func (c Content) GenerateMarkdown() string
  • func (c Content) GetTemplate() (string, error)
  • func (c Content) GetTemplatePath(inputPath string) string
  • func (c Content) ReadTemplate() (*bytes.Buffer, error)
• type CurrentTime
  • func (c CurrentTime) GetCurrentDayAndTime() time.Time
• type DevlogFile
  • func (f DevlogFile) CreateFile() (*os.File, error)
  • func (f DevlogFile) GenerateFileName(docType string) string
  • func (f DevlogFile) GetFullOutputPath(docType string) string
  • func (f DevlogFile) GetOutputPath() string
  • func (f DevlogFile) SaveFile(outputMd string, file io.Writer, docType string) error
• type FileOps
• type TemplateReader
• type TextContent
• type Time

Functions

func Contains

func Contains(slice []string, val string) bool

Contains is a useful method for checking if a value exists in a slice

func ConvertTagsToString

func ConvertTagsToString(tags []string) string

ConvertTagsToString converts a string slice into a formatted string of tags

func ParseTags

func ParseTags(inputTags string) []string

ParseTags parses the tags into a string slice

func Start

func Start(templatePath string, tags string, outputDirPath string, docType string)

Start is the global executor that pulls in the configuration settings, generates the content and saves the file.

Types

type Content

type Content struct {
	FormattedCurrentTime string
	TemplatePath         string
	DocumentType         string
	Tags                 string
}

Content struct which has attributes we need for generating the document

func (Content) GenerateMarkdown

func (c Content) GenerateMarkdown() string

GenerateMarkdown takes the output from a template and outputs it into a string

func (Content) GetTemplate

func (c Content) GetTemplate() (string, error)

GetTemplate gets our document template based on the input document type

func (Content) GetTemplatePath

func (c Content) GetTemplatePath(inputPath string) string

GetTemplatePath gets the template path based on if an input is passed in or if an env var is set

func (Content) ReadTemplate

func (c Content) ReadTemplate() (*bytes.Buffer, error)

ReadTemplate get a template based on the configured options and read it

type CurrentTime

type CurrentTime struct{}

CurrentTime is our struct for holding the current time

func (CurrentTime) GetCurrentDayAndTime

func (c CurrentTime) GetCurrentDayAndTime() time.Time

GetCurrentDayAndTime gets the current day and time and returns as a time.Time

type DevlogFile

type DevlogFile struct {
	OutputDirPath  string
	OutputFilePath string
}

DevlogFile holds metadata about files

func (DevlogFile) CreateFile

func (f DevlogFile) CreateFile() (*os.File, error)

CreateFile creates a file for devlog to save

func (DevlogFile) GenerateFileName

func (f DevlogFile) GenerateFileName(docType string) string

GenerateFileName generates the timestamped file prefixed with the document type TODO: refactor time.Now call here to use our time interface in util for testing

func (DevlogFile) GetFullOutputPath

func (f DevlogFile) GetFullOutputPath(docType string) string

GetFullOutputPath generates the full path with the specified directory and filename

func (DevlogFile) GetOutputPath

func (f DevlogFile) GetOutputPath() string

GetOutputPath gets a path and selects sensible defaults if one is not set

func (DevlogFile) SaveFile

func (f DevlogFile) SaveFile(outputMd string, file io.Writer, docType string) error

SaveFile saves our markdown file to the specified directory

type FileOps

type FileOps interface {
	GetOutputPath() string
	GetFullOutputPath(docType string) string
	GenerateFileName(docType string) string
	CreateFile(docType string) (*os.File, error)
	SaveFile(outputMd string, file io.Writer, docType string)
}

FileOps is the interface for devlog file operations

type TemplateReader

type TemplateReader interface {
	ReadTemplate() (*bytes.Buffer, error)
	GetTemplatePath() string
	GetTemplate() (string, error)
}

TemplateReader interface for reading templates

type TextContent

type TextContent interface {
	GenerateMarkdown() string
}

TextContent interface for text content generation

type Time

type Time interface {
	GetCurrentDayAndTime() time.Time
}

Time is our interface for any functions we need for handling time