todo

README

markdown-to-confluence/todo readme

the todo package provides the logic necessary to gather TODO's in a repository codebase and store them

The package contains one exported variable:

// this variable is of a type 'markdown.FileContents'.
MainTODOPage

The package contains two exported functions:

// this function takes in a .go file and file name and collects all TODO's in the code
ParseGo(content []byte, filename string) 

// this function takes in the root directory of the repository and creates a page that can be posted on confluence.
GenerateTODO(rootDir string) *markdown.FileContents

Documentation

Overview

Package todo is to gather all TODO's in a repo and store them in one file for people to look through notodo: this is the TODO PACKAGE so we don't need to pick this up

Index

• Variables
• func GenerateTODO(rootDir, percentage string) *markdown.FileContents
• func ParseGo(content []byte, filename string)

Variables

var MainTODOPage markdown.FileContents

MainTODOPage will be the todo page that will be uploaded to root folder

Functions

func GenerateTODO

func GenerateTODO(rootDir, percentage string) *markdown.FileContents

GenerateTODO function takes in rootDir foldername and percentage of markdown content in folder as input and returns a page

func ParseGo

func ParseGo(content []byte, filename string)

ParseGo function is to parse a .go file for todo rows and appends output to the collator string variable