https://github.com/cthulhu/go-notes

CLI tool for code annotations generation. Similar to "rake notes" from Ruby On Rails
https://github.com/cthulhu/go-notes

cli golang notes tools

Last synced: 6 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/cthulhu/go-notes
• Owner: cthulhu
• License: mit
• Created: 2017-06-30T15:17:58.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-08-20T08:57:32.000Z (almost 2 years ago)
• Last Synced: 2024-08-20T10:36:29.513Z (almost 2 years ago)
• Topics: cli, golang, notes, tools
• Language: Go
• Homepage:
• Size: 34.2 KB
• Stars: 9
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Actions Status](https://github.com/cthulhu/go-notes/workflows/Go/badge.svg)](https://github.com/cthulhu/go-notes/actions)

  [![Goreport](https://goreportcard.com/badge/github.com/cthulhu/go-notes)](https://goreportcard.com/report/github.com/cthulhu/go-notes) [![License MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/cthulhu/go-notes/master/LICENSE)

# 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]  ...

    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)