borkdude/clj-kondo


A linter for Clojure code that sparks joy.

License: EPL-1.0

Language: Clojure

Keywords: clojure, clojurescript, linter


CircleCI Build status Clojars Project cljdoc badge project chat

A linter for Clojure code that sparks joy.

Rationale

You don't mind the occasional inline def for debugging, but you would like to get rid of them before making your code public. Also, unnecessary do and let nestings don't really add any value to your life. Let clj-kondo help you tidy your code.

Features

clj-kondo detects:

  • inline def expressions
  • redundant do and let wrappings
  • arity errors:
    • within the same namespace and across namespaces
    • of static Java method calls
    • of local let and letfn binding calls
    • of recursive calls (including recur)
  • unused private vars
  • private and deprecated var usage
  • required but unused namespaces
  • referred but unused vars
  • duplicate requires
  • unused function arguments and let bindings
  • unused imports
  • redefined vars
  • unresolved symbols and namespaces
  • misplaced docstrings
  • duplicate map keys and set elements
  • missing map keys
  • invalid number of forms in binding vectors
  • missing assertions in clojure.test/deftest
  • alias consistency
  • type checking
  • Datalog syntax checking

before your REPL knows it.

It suggests several style guide recommendations, such as:

It has support for syntax of commonly used macros like clojure.core.async/alt!!, schema.core/defn and potemkin/import-vars.

It provides analysis data so you build your own custom linters.

This linter is:

  • compatible with .clj, .cljs, .cljc and .edn files
  • build tool and editor agnostic
  • a static code analyzer
  • compiled to native code using GraalVM

Try clj-kondo at the interactive playground.

Installation

Running on the JVM

Running with Docker

Usage

Command line

Lint from stdin:

$ echo '(def x (def x 1))' | clj-kondo --lint -
<stdin>:1:8: warning: inline def

Lint a file:

$ echo '(def x (def x 1))' > /tmp/foo.clj
$ clj-kondo --lint /tmp/foo.clj
/tmp/foo.clj:1:8: warning: inline def

Lint a directory:

$ clj-kondo --lint src
src/clj_kondo/test.cljs:7:1: warning: redundant do
src/clj_kondo/calls.clj:291:3: error: Wrong number of args (1) passed to clj-kondo.calls/analyze-calls

Lint a project classpath:

$ clj-kondo --lint "$(lein classpath)"

Project setup

To detect lint errors across namespaces in your project, a cache is needed. To let clj-kondo know where to create one, make a .clj-kondo directory in the root of your project, meaning on the same level as your project.clj, deps.edn or build.boot. A cache will be created inside of it when you run clj-kondo. Before linting inside your editor, it is recommended to lint the entire classpath to teach clj-kondo about all the libraries you are using, including Clojure and/or ClojureScript itself:

$ clj-kondo --lint "<classpath>"

Build tool specific ways to get a classpath:

  • lein classpath
  • boot with-cp -w -f -
  • clojure -Spath

So for lein the entire command would be:

$ clj-kondo --lint "$(lein classpath)"

Now you are ready to lint single files using editor integration. A simulation of what happens when you edit a file in your editor:

$ echo '(select-keys)' | clj-kondo --lang cljs --lint -
<stdin>:1:1: error: Wrong number of args (0) passed to cljs.core/select-keys

Since clj-kondo now knows about your version of ClojureScript via the cache, it detects that the number of arguments you passed to select-keys is invalid. Each time you edit a file, the cache is incrementally updated, so clj-kondo is informed about new functions you just wrote.

If you want to use a different directory to read and write the cache, use the --cache-dir option. To disable the cache even if you have a .clj-kondo directory, use --cache false.

Configuration

Editor integration

Exit codes

  • 0: no errors or warnings were found
  • 2: more than one warning was found
  • 3: more than one error was found

All other error codes indicate an unexpected error.

Analysis data

Developer documentation

Thanks to:

Support this project

Do you enjoy this project? Consider buying me a hot beverage.

License

Copyright © 2019 Michiel Borkent

Distributed under the EPL License, same as Clojure. See LICENSE.

The directory inlined contains source from tools.reader which is licensed under the EPL license.

The directory parser contains modified source from rewrite-clj which is licensed under the MIT license.

Project Statistics

Sourcerank 8
Repository Size 6.91 MB
Stars 678
Forks 73
Watchers 16
Open issues 76
Dependencies 4
Contributors 32
Tags 34
Created
Last updated
Last pushed

Top Contributors See all

Michiel Borkent sogaiu Marc O'Morain Rahuλ Dé Hannu Hartikainen Dominic Monroe Daniel Barreto Lee Read yuhan0 Marcelo Nomoto Jason Felice Khalid Jebbari Maurits Christian Weilbach Imre Kószó Lauri Oherd Eric Dallo chorin1 saitouena turbo-cafe

Packages Referencing this Repo

clj-kondo
Tidy your code with clj-kondo.
Latest release 2019.12.17-SNAPSHOT - Updated - 678 stars

Recent Tags See all

v2019.12.14 December 14, 2019
v2019.11.23 November 23, 2019
v2019.11.07 November 07, 2019
v2019.11.03 November 03, 2019
v2019.10.26 October 26, 2019
v2019.10.11-alpha October 11, 2019
v2019.10.04-alpha October 04, 2019
v2019.10.04-alpha October 04, 2019
v2019.09.22-alpha September 22, 2019
v2019.08.21-alpha August 21, 2019
v2019.07.31-alpha July 31, 2019
v2019.07.24-alpha July 24, 2019
v2019.07.17-alpha July 17, 2019
v2019.07.05-alpha July 05, 2019
v2019.06.29-alpha June 29, 2019

Something wrong with this page? Make a suggestion

Last synced: 2019-12-19 01:02:42 UTC

Login to resync this repository