file

package

v0.0.0-...-d10edc5 Latest Latest Go to latest Published: Dec 14, 2024 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/SublimeIbanez/todor

Documentation ¶

Index ¶

Constants
type Parser
- func NewParser(output_path string) (*Parser, error)
- func (parser *Parser) Shutdown()
- func (parser *Parser) WalkDir(input_path string) error
type ToDo

Constants ¶

View Source

const DEFAULT_OUTPUT_FILE_NAME string = "todos.md"

TODO: Create a config file and have these constants placed there

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Parser ¶

type Parser struct {
	Input      chan ToDo
	Output     chan string
	OutputFile *os.File
	Context    context.Context
	Cancel     context.CancelFunc
	WaitGroup  sync.WaitGroup
	Config     configuration.ConfigOptions
}

func NewParser ¶

func NewParser(output_path string) (*Parser, error)

Generates a new parser to manage i/o of the requisite data. Returns error if file operations fail

func (*Parser) Shutdown ¶

func (parser *Parser) Shutdown()

func (*Parser) WalkDir ¶

func (parser *Parser) WalkDir(input_path string) error

Recursively walk through the directory and read through all items

type ToDo ¶

type ToDo struct {
	RelativePath string
	ToDo         []string
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL