Liking cljdoc? Tell your friends :D

Editor integration

Before setting up your editor, see Project setup on how to configure clj-kondo for your project. TL;DR: this involves creating a .clj-kondo directory in the root of your project.

Emacs

For integrating with Emacs, see flycheck-clj-kondo.

Vim/NeoVim

This section is for Vim 8+ or NeoVim

  1. Install ALE using your favorite plugin manager. This already has in-built support for clj-kondo.
  2. In your .vimrc, add:
    let g:ale_linters = {'clojure': ['clj-kondo']}
    

    to only have clj-kondo as the linter. add:

    let g:ale_linters = {'clojure': ['clj-kondo', 'joker']}
    

    to have both, with clj-kondo being preferred.

  3. Reload your .vimrc and it should start working.

IntelliJ IDEA

This section assumes that you are already using Cursive.

  1. Install the File Watchers plugin.

Repeat the below steps for the file types Clojure (.clj), ClojureScript (.cljs) and CLJC (.cljc).

  1. Under Preferences / Tools / File Watchers click + and choose the <custom> template.
  2. Choose a name. E.g. clj-kondo <filetype> (where <filetype> is one of Clojure, ClojureScript or CLJC).
  3. In the File type field, choose the correct filetype.
  4. In the Program field, type clj-kondo.
  5. In the Arguments field, type --lint $FilePath$ --cache.
  6. In the Working directory field, type $FileDir$.
  7. Enable Create output file from stdout
  8. In output filters put $FILE_PATH$:$LINE$:$COLUMN$: $MESSAGE$.

Can you improve this documentation? These fine people already did:
Michiel Borkent & Rahul De
Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close