astitodo

README

This is a Golang library and CLI to parse TODOs in your GO code.

It parses the comments from the AST and extract their TODOs. It can provide valuable information such as the TODO's assignee which can be filtered afterwards.

Most IDEs allow parsing TODOs but they usually have problems with multi line TODOs, can't parse assignees, etc.

This is also a good start for people who want to use AST.

Installation

Run

go get -u github.com/asticode/go-astitodo/...

Usage

$ astitodo -h
Usage of astitodo:
-a string
    Only TODOs assigned to this username(s) will be displayed
-e value
    Path that will be excluded from the process
-f string
    Format to use when outputting TODOs (supported formats: text, csv, json) (default "text")
-o string
    Destination for output (can be stdout, stderr or a file) (default "stdout")

Formatting

A todo is formatted this way:

    // TODO<line 1>
    // <line 2>
    // ...

You can also add an assignee:

    // TODO(this is the assignee)<message>

Examples

Basic

Assume the following file:

    package mypackage

    // TODO Damn this package seems useless

    // Here is a dummy comment
    // TODO(asticode) This variable should be dropped
    var myvariable int

    // TODO(username) This should be renamed
    var oops bool

    // TODO Damn this function should be rewritten
    // Or maybe it should be dropped as well
    func UselessFunction() {
    	var a = 1
    	a++
    }

Running

go-astitodo <paths to files or dirs>

will give

Message: Damn this package seems useless
File: mypackage/main.go:3

Assignee: asticode
Message: This variable should be dropped
File: mypackage/main.go:6

Assignee: username
Message: This variable should be renamed
File: mypackage/main.go:9

Message: Damn this function should be rewritten
Or maybe it should be dropped  as well
File: mypackage/main.go:12

Filter by assignee

Running

go-astitodo -a asticode <paths to files or dirs>

will output

Assignee: asticode
Message: This variable should be dropped
File: mypackage/main.go:6

Filter by multiple assignees

Running

astitodo -a user,anotheruser <paths to files or dirs>

will output

Assignee: asticode
Message: This variable should be dropped
File: mypackage/main.go:6

Assignee: username
Message: This variable should be renamed
File: mypackage/main.go:9

Exclude paths

You can exclude paths by running

go-astitodo -e path/to/exclude/1 -e path/to/exclude/2 <paths to files or dirs>

Change output format

You can output CSV by running

go-astitodo -f csv <path to files or dirs>

You can output JSON by running

$ astitodo -f json testdata/ | jq '[limit(1;.[])]'

    [
      {
        "Assignee": "",
        "Filename": "testdata/excluded.go",
        "Line": 3,
        "Message": [
          "This todo should be ignored as it is in the excluded path"
        ]
      }
    ]

Use the json support to filter the data with jq, then use text templating to output text content.

astitodo -f json . | jq '.[] | select(.Assignee=="") | "\(.Filename):\(.Line): \(.Message[0])"'
"encoder.go:33: It does not escape separators from the encoded data."
...

Output to a file

You can output to a file by running

go-astitodo -o <path to output file> <path to files or dirs>

Contributions

You know you want to =D

Documentation

Index

• type TODO
• type TODOs
  • func Extract(path string, excludedPaths ...string) (todos TODOs, err error)
  • func (todos TODOs) AssignedTo(assignees ...string) (filteredTODOs TODOs)
  • func (todos TODOs) WriteCSV(w io.Writer) (err error)
  • func (todos TODOs) WriteJSON(w io.Writer) (err error)
  • func (todos TODOs) WriteText(w io.Writer) (err error)

Types

type TODO

type TODO struct {
	Assignee string
	Filename string
	Line     int
	Message  []string
}

TODO represents a todo

type TODOs

type TODOs []*TODO

TODOs represents a set of todos

func Extract

func Extract(path string, excludedPaths ...string) (todos TODOs, err error)

Extract walks through an input path and extracts TODOs from all files it encounters

func (TODOs) AssignedTo

func (todos TODOs) AssignedTo(assignees ...string) (filteredTODOs TODOs)

AssignedTo returns TODOs which are assigned to the specified assignee

func (TODOs) WriteCSV

func (todos TODOs) WriteCSV(w io.Writer) (err error)

WriteCSV writes the TODOs as CSV to the specified writer The columns are "Filename", "Line", "Assignee" and "Message" (which can contain newlines)

func (TODOs) WriteJSON

func (todos TODOs) WriteJSON(w io.Writer) (err error)

WriteJSON writes the TODOs as JSON to the specified writer

func (TODOs) WriteText

func (todos TODOs) WriteText(w io.Writer) (err error)

WriteText writes the TODOs as text to the specified writer