2012-03-04 16:41:53 +00:00
|
|
|
# kibit
|
|
|
|
|
|
|
|
|
|
*There's a function for that!*
|
|
|
|
|
|
|
|
|
|
`kibit` is a static code analyzer for Clojure which uses the
|
|
|
|
|
[`core.logic`](https://github.com/clojure/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 `while` macro instead of `if`.
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
Add
|
|
|
|
|
|
|
|
|
|
:dev-dependencies [...
|
|
|
|
|
[kibit "0.0.1"]
|
|
|
|
|
...]
|
|
|
|
|
|
|
|
|
|
to your `project.clj` file and run
|
|
|
|
|
|
|
|
|
|
lein kibit
|
|
|
|
|
|
|
|
|
|
to analyze your namespaces.
|
|
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
It is very easy to write new patterns for `kibit` to look for. Take a
|
|
|
|
|
look at [`arithmetic.clj`] how new patterns are created. If you know
|
|
|
|
|
of a reaccuring 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
|
2012-03-04 16:43:23 +00:00
|
|
|
* Remove reflection warnings (how?)
|
2012-03-04 16:41:53 +00:00
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
Copyright (C) 2012 Jonas Enlund
|
|
|
|
|
|
|
|
|
|
Distributed under the Eclipse Public License, the same as Clojure.
|
