No description

Find a file

Jonas Enlund 4ec52462d3 Added a few rules to test rest patterns		2012-03-05 16:42:41 +02:00
src	Added a few rules to test rest patterns	2012-03-05 16:42:41 +02:00
test/kibit/test	Initial commit	2012-03-04 18:41:53 +02:00
.gitignore	Initial commit	2012-03-04 18:41:53 +02:00
project.clj	fixed README :dev-dependencies code	2012-03-04 21:30:43 +02:00
README.md	README typo	2012-03-05 06:05:53 +02:00

README.md

kibit

There's a function for that!

kibit is a static code analyzer for Clojure which uses the core.logic unifier to search for patterns of code for which there might exist a more idiomatic function or macro. For example if kibit finds the code

(if (some test)
  (some action)
  nil)

it will make the suggestion to use the when macro instead of if.

Usage

Add [jonase/kibit "0.0.1"] to your :plugins vector in your :user profile (Leiningen 2) or if you are using Leiningen 1:

$ lein plugin install jonase/kibit 0.0.1

Then you can run

$ lein kibit

to analyze your namespaces.

Contributing

It is very easy to write new patterns for kibit. Take a look at controle-structures.clj to see how new patterns are created. If you know of a recurring pattern of code that can be simplified, please consider sending me a pull request.

Bugs can be reported using the github bug tracker.

TODO

Figure out how to report line numbers.
More rules
Remove reflection warnings (how?)
Can core.logic be used to its full potential?
Analyse ClojureScript files?

License

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