No description

Find a file

Paul deGrandis 2602c0335e Refactored core to make it easier to test rules and extend post-processing of matches; also now lazy		2012-03-05 12:40:52 -05:00
src	Refactored core to make it easier to test rules and extend post-processing of matches; also now lazy	2012-03-05 12:40:52 -05:00
.gitignore	A more robust gitignore	2012-03-05 12:37:50 -05:00
project.clj	fixed README :dev-dependencies code	2012-03-04 21:30:43 +02:00
README.md	Fix two typos in README	2012-03-05 00:54:31 -08: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 control-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.