https://github.com/bbatsov/lein-annotations

Display comment annotations in your project
https://github.com/bbatsov/lein-annotations

Last synced: 10 months ago
JSON representation

Display comment annotations in your project

• Host: GitHub
• URL: https://github.com/bbatsov/lein-annotations
• Owner: bbatsov
• Created: 2013-06-03T13:54:11.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2020-01-29T12:44:38.000Z (almost 6 years ago)
• Last Synced: 2024-09-28T02:59:47.513Z (over 1 year ago)
• Language: Clojure
• Size: 4.88 KB
• Stars: 13
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# lein-annotations

A Leiningen plugin to display all comment annotations(`TODO`, `FIXME`,

`OPTIMIZE`, etc) in your Clojure project.

It's inspired by the similar `rake notes` functionality available in Ruby on Rails.

## Usage

Put `[lein-annotations "0.2.0"]` into the `:plugins` vector

of your `project.clj`.

Afterwards just run:

    $ lein annotations

You'll see a summary like:

```

test.clj:  8: ;; FIXME this blows up from time to time

test.clj: 11: ;; OPTIMIZE this is doing a lot of useless computations right now

```

You can also specify exactly what annotations to display:

    $ lein annotations FIXME REFACTOR HACK

## License

Copyright © 2013-2020 Bozhidar Batsov

Distributed under the Eclipse Public License, the same as Clojure.