/go-notes

CLI tool for code annotations generation. Similar to "rake notes" from Ruby On Rails

Primary LanguageGoMIT LicenseMIT

Actions Status Goreport License MIT

go-notes

CLI tool similar to "rake notes" from Ruby On Rails

Installation

go get -u github.com/cthulhu/go-notes

Usage

Usage: go-notes [flags] <Go file or directory> ...

Without options generates all the note types. Defaults are:

// FIXME    - call to fix something
// OPTIMIZE - call for a refactoring
// TODO     - future plans

Options:
  -f - FIXME annotations
  -o - OPTIMIZE annotations
  -t - TODO annotations
  -c CUSTOM - custom annotation label
  -format count - output format aggregated counts
  -format list - output format list with files and annotations (default)