Giter VIP home page Giter VIP logo

kibit's Introduction

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.

Contributors

  • Jonas Enlund
  • Phil Hagelberg
  • Alan Malloy
  • Paul deGrandis

TODO

  • Figure out how to report line numbers.
  • Rules for function definitions (make this more of a lint tool)
  • Rules for collection lookup; "2 is a bad smell" see this blog post
  • Extract the "when to use" rules from Joy of Clojure
  • Leiningen project.clj setting for rule exclusion
  • Leiningen project.clj setting for a directory of rules to include
  • More rules
  • Remove reflection warnings (how?)
  • Can core.logic be used to its full potential?
  • Analyse ClojureScript files?

License

Copyright © 2012 Jonas Enlund

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

kibit's People

Contributors

jonase avatar ohpauleez avatar technomancy avatar amalloy avatar yuanmai avatar

Stargazers

 avatar

Watchers

 avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.