README
¶
Universalist
Universalist is an IDE agnostic annotation-highlighter for annotations like TODO, FIXME or even your own custom annotations.
Installation
From the source:
$ go get github.com/aladhims/universalist/cmd/universalist
Usage
In your current working directory:
annotations will be in color if specified
$ universalist
TODO
- Complete this function main.java:87
- Make the comment below clearer index.js
FIXME
- Improve the algorithm utils.go:25
Specify the directory:
$ universalist --path path/to/your/workdir
Indent the output:
$ universalist --indent
Using custom configurations (see config-example.json):
$ universalist --config ./mycustomconfig.json
Supported Colors
- black
- red
- green
- yellow
- blue
- magenta
- cyan
- white
- 0...255 (256 colors)
For more information, see here
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Option ¶
type Option func(*Universalister)
Option is a type for building the module struct with different parameter
func WithWriter ¶
WithWriter is an optional parameter that specifies the writer that will be used to show the output
type Universalister ¶
type Universalister struct {
Path string `json:"path"`
Keywords []annotation `json:"keywords"`
ExcludedFiles []string `json:"excluded"`
// contains filtered or unexported fields
}
Universalister is a module Universalister
func New ¶
func New(configPath string, options ...Option) (*Universalister, error)
New creates module struct with config path and given parameters
func (*Universalister) Start ¶
func (ul *Universalister) Start() error
Start starts collecting and listing all highlighted list
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.