Skip to content

Latest commit

 

History

History
470 lines (343 loc) · 15.8 KB

editor-integration.md

File metadata and controls

470 lines (343 loc) · 15.8 KB
Raw

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.

For Spacemacs, check here or get flymake-kondor if you are using flymake.

clojure-lsp

The clojure-lsp project bundles clj-kondo as its analyzer and linter. It completes clj-kondo with the following features:

  • project initialization (analyze dependencies first, copy library configurations)
  • navigation
  • refactoring (renaming, etc)
  • lens-mode (see the number of references and tests), enable with: (setq lsp-lens-enable t)
  • call hierarchy

and more.

This section assumes that you are using the lsp-mode emacs package and mentions lsp--mode specific settings. If you are usign eglot, a different emacs lsp client, those settings don't apply.

As of 26th of March 2023, some of the below recommendations are only availably via the clojure-lsp master branch. See the end of this section how to run that locally.

When using clojure-lsp, there is no need to install clj-kondo separately, although you can still do that via flycheck-clj-kondo. You may do this for the following reasons:

  • Linting still works for files outside of projects
  • You can use a newer version of clj-kondo than what is bundled with clojure-lsp (e.g. for development, also see bash script below to accomplish this with clojure-lsp + clj-kondo in a JVM)
  • More immediate feedback (can be tuned with lsp-mode, read below)
  • Squiggles are less noisy (can be tuned with clojure-lsp, read below)

When doing so, it's recommended to disable diagnostics via lsp-mode:

(setq lsp-diagnostics-provider :none)

When you find that clj-kondo's feedback via clojure-lsp is less instantaneous, try tuning the following setting in emacs:

(setq lsp-idle-delay 0.05) ;; defaults to 0.2

When you find that the squiggles are a bit too much, tune the clojure-lsp config.edn (not clj-kondo's config.edn!) as follows:

{:diagnostics {:range-type :simple}}

Personally, I found the breadcrumb too distracting and I disabled it with:

(setq lsp-headerline-breadcrumb-enable nil)

On the other hand, I find lens-mode pretty useful:

(setq lsp-lens-enable t)

See the clj-kondo section in clojure-lsp's documentation for more info. Also see lsp-mode settings.

To run a specific combination of clojure-lsp and clj-kondo in a JVM, rather than in a native binary, you can make a script like the following and add it to your path. Change the paths as necessary.

~/bin/clojure-lsp-dev:

#!/usr/bin/env bash

clj -Sdeps '{:aliases
              {:lsp
                {:replace-paths []
                 :replace-deps
                  {org.clojure/clojure {:mvn/version "1.11.1"}
                   clj-kondo/clj-kondo {:local/root "/Users/borkdude/dev/clj-kondo"}
                   clojure-lsp/clojure-lsp {:local/root "/Users/borkdude/dev/clojure-lsp/cli"}
                   cider/cider-nrepl {:mvn/version "0.28.6"}}}}}' \
                       -M:lsp -m clojure-lsp.main "$@"

The configure the following in emacs:

(setq lsp-clojure-custom-server-command '("/Users/borkdude/bin/clojure-lsp-dev"))

I use the above to always run my local version of clj-kondo and clojure-lsp, along with an nREPL server for hacking from a REPL.

Visual Studio Code

clj-kondo extension

Install the clj-kondo extension. It requires no additional installation (except Java).

The clj-kondo extension will also be installed together with Calva.

clojure-lint extension

If you do not have Java installed you can still get clj-kondo linting using the Clojure Lint extension, by @marcomorain, which uses the clj-kondo standalone executable.

Atom

Atom requires clj-kondo to be on your $PATH. In Atom, there are a few ways to install:

  1. apm install linter-kondo linter linter-ui-default intentions busy-signal
  2. Install from the Atom package page.
  3. From inside Atom, go to Preferences > Extensions. Search for "linter-kondo" and click "Install" on the extension.

Vim / Neovim

ALE

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.

    To enable both clj-kondo and joker, add:

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

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

COC.NVIM

Follow instructions to install COC.NVIM https://github.com/neoclide/coc.nvim

Follow instructions to install coc diagnostic https://github.com/iamcco/coc-diagnostic

Add the diagnostic-languageserver.linter and the diagnostic-languageserver.filetypes to the coc-settings.json. CocConfig command can be used to open the coc-settings.json file.

{
    "diagnostic-languageserver.linters": {
        "clj_kondo_lint": {
            "command": "clj-kondo",
            "debounce": 100,
            "args": [ "--lint", "%filepath"],
            "offsetLine": 0,
            "offsetColumn": 0,
            "sourceName": "clj-kondo",
            "formatLines": 1,
            "formatPattern": [
                "^[^:]+:(\\d+):(\\d+):\\s+([^:]+):\\s+(.*)$",
                {
                    "line": 1,
                    "column": 2,
                    "message": 4,
                    "security": 3
                }
            ],
            "securities": {
                    "error": "error",
                    "warning": "warning",
                    "note": "info"
            } 

        }
    },
    "diagnostic-languageserver.filetypes": {"clojure":"clj_kondo_lint"}
}

Neomake

Neomake has built-in support for clj-kondo. It will be enabled automatically when using neomake, no configuration required.

Vanilla way

Create this file in ~/.config/nvim/compiler/clj-kondo.vim or ~/.vim/compiler/clj-kondo.vim.

if exists("current_compiler")
  finish
endif
let current_compiler="clj-kondo"

if exists(":CompilerSet") != 2
  command -nargs=* CompilerSet setlocal <args>
endif

CompilerSet errorformat=%f:%l:%c:\ Parse\ %t%*[^:]:\ %m,%f:%l:%c:\ %t%*[^:]:\ %m
CompilerSet makeprg=clj-kondo\ --lint\ %

Usage

You can populate the quickfix list like so:

:compiler clj-kondo
:make

See romainl's vanilla linting for how to automatically execute linting and automatically open the quickfix.

If you have vim-dispatch installed, you can use this command to be both async and more convenient:

:Dispatch -compiler=clj-kondo

nvim-lint (Neovim 0.5+ only)

nvim-lint has built-in support for clj-kondo.

Configuration using packer.nvim

use {
  "mfussenegger/nvim-lint",
  config = function()
    require("lint").linters_by_ft = {
      clojure = {"clj-kondo"},
      -- ... other linters
    }
  end,
}

IntelliJ IDEA

Currently there are three ways to get clj-kondo integration in IntelliJ. All three methods work well and have equivalent features. Select your preferred plugin/version management preference between:

  • Clojure Extras IntelliJ Plugin
  • LSP (Language Server Protocol) plugin to run clj-kondo from a jar
  • Cursive or ClojureKit + File Watchers plugin to run an installed binary clj-kondo

Clojure Extras Plugin

Install the plugin from IntelliJ IDEA Plugins Marketplace. You can setup a custom binary from the settings screen or just use the built-in version.

LSP server

The clj-kondo LSP server provides diagnostics via the LSP protocol. To get it working in IntelliJ follow these steps:

  1. Download the latest clj-kondo LSP server jar to your system. Go to the Github releases and look for clj-kondo-lsp-server-<version>-standalone.jar. The jar is provided since version 2019.11.23.

  2. Install the LSP Support plugin by gtache, either from the marketplace of via a zipfile downloaded from the a Github release. Version 1.6.0 or later is required.

  3. Configure the LSP Support plugin.

    • Go to Preferences / Languages & Frameworks / Language Server Protocol / Server definitions. Select Raw command.
    • In the Extension field enter clj;cljs;cljc;edn.
    • In the command field enter java -jar <path> where <path> matches the downloaded jar file, e.g. /Users/clj-kondo/clj-kondo-lsp-server-2019.11.23-standalone.jar.

Now, when editing a Clojure file, you should get linting feedback.

File Watchers + installed binary

Requires a syntax aware plugin such as Cursive or ClojureKit installed for best results.

Install the File Watchers plugin. This plugin is available for installation in the Community Edition, even though it is bundled in Ultimate, you don't need Ultimate to install it.

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

  1. Under Preferences (File/Settings... in GNU/Linux) / 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. Scope: Current file
  5. In the Program field, type clj-kondo
  6. In the Arguments field, type --lint $FilePath$
    You may use a custom config E.g --lint $FilePath$ --config "{:lint-as {manifold.deferred/let-flow clojure.core/let}}"
  7. In the Working directory field, type $FileDir$
  8. Enable Create output file from stdout
  9. Show console: Never
  10. In output filters put $FILE_PATH$:$LINE$:$COLUMN$: $MESSAGE$
  11. The newly created file-watcher "level" defaults to "Project". Change it to "Global" so that clj-kondo is active for all future projects

1 See Reader Conditionals for more information on the .cljc extension. CLJX (.cljx) is an extension that was used prior to CLJC but is no longer in wide use.

Spacemacs

Ensure that:

  1. syntax-checking is present in dotspacemacs-configuration-layers.
  2. clj-kondo is available on PATH.

In the .spacemacs file:

Installing on master branch

When using the stable master branch:

  1. In dotspacemacs-additional-packages add flycheck-clj-kondo.

  2. In the dotspacemacs/user-config function add the following:

    (use-package clojure-mode
 :ensure t
 :config
 (require 'flycheck-clj-kondo))

To install it alongside joker:

  1. In dotspacemacs-additional-packages add flycheck-clj-kondo and flycheck-joker.

  2. In the dotspacemacs/user-config function add the following:

    (use-package clojure-mode
 :ensure t
 :config
 (require 'flycheck-joker)
 (require 'flycheck-clj-kondo)
 (dolist (checker '(clj-kondo-clj clj-kondo-cljs clj-kondo-cljc clj-kondo-edn))
   (setq flycheck-checkers (cons checker (delq checker flycheck-checkers))))
 (dolist (checkers '((clj-kondo-clj . clojure-joker)
                     (clj-kondo-cljs . clojurescript-joker)
                     (clj-kondo-cljc . clojure-joker)
                     (clj-kondo-edn . edn-joker)))
   (flycheck-add-next-checker (car checkers) (cons 'error (cdr checkers)))))

Installing on develop branch

If using the develop branch, clj-kondo is available as a part of the standard clojure layer. This will become the way to install in the next stable release of spacemacs.

To enable it:

  1. Ensure the clojure layer is in the dotspacemacs-configuration-layers.
  2. Add a variable called clojure-enable-linters with the value 'clj-kondo.

It should look like this:

dotspacemacs-configuration-layers
'(...
    (clojure :variables
             clojure-enable-linters 'clj-kondo)
 )

Reload the config to enable clj-kondo.

Kakoune

Manual Linting

Add the following to ~/.config/kak/kakrc:

hook global WinSetOption filetype=clojure %{
    set-option window lintcmd 'clj-kondo --lint'
}

The :lint command will run clj-kondo and annotate the buffer with lint warnings and errors.

Automatic Linting on Idle

clj-kondo is fast enough to lint as you code! If you want to do this, use the following configuration:

hook global WinSetOption filetype=clojure %{
    set-option window lintcmd 'clj-kondo --lint'
    lint-enable
    hook -group lint-diagnostics window NormalIdle .* %{ lint; lint-show }
}

This works well, but tends to clear the message line too frequently. The following work-around prevents linting from displaying the warning and error counts on the message line:

define-command -hidden -override lint-show-counters %{}

Sublime Text

Requires Sublime Text 3 or 4. Install SublimeLinter and SublimeLinter-contrib-clj-kondo with Package Control. clj-kondo must be available on the $PATH to work.