https://github.com/aladhims/universalist

A Universal IDE agnostic highlighter list for annotation like TODO, FIXME etc (or your own custom annotations)
https://github.com/aladhims/universalist

annotation-agnostic annotation-processor go golang highlighter todo tool utility

Last synced: 14 days ago
JSON representation

A Universal IDE agnostic highlighter list for annotation like TODO, FIXME etc (or your own custom annotations)

• Host: GitHub
• URL: https://github.com/aladhims/universalist
• Owner: aladhims
• License: mit
• Created: 2019-07-14T08:45:32.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-07-14T12:45:01.000Z (over 5 years ago)
• Last Synced: 2024-06-20T15:55:39.503Z (5 months ago)
• Topics: annotation-agnostic, annotation-processor, go, golang, highlighter, todo, tool, utility
• Language: Go
• Homepage:
• Size: 4.88 KB
• Stars: 1
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

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](https://github.com/aladhims/universalist/blob/master/config-sample.json)):

    $ universalist --config ./mycustomconfig.json

----

## Supported Colors

* black

* red

* green

* yellow

* blue

* magenta

* cyan

* white

* 0...255 (256 colors)

For more information, see [here](https://github.com/mgutz/ansi)