Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/borkdude/flycheck-clj-kondo
Emacs integration for clj-kondo via flycheck
https://github.com/borkdude/flycheck-clj-kondo
clojure clojurescript flycheck-extension linter
Last synced: 2 months ago
JSON representation
Emacs integration for clj-kondo via flycheck
- Host: GitHub
- URL: https://github.com/borkdude/flycheck-clj-kondo
- Owner: borkdude
- Created: 2019-04-03T12:50:48.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-21T18:26:33.000Z (11 months ago)
- Last Synced: 2024-10-23T09:21:49.202Z (2 months ago)
- Topics: clojure, clojurescript, flycheck-extension, linter
- Language: Emacs Lisp
- Size: 22.5 KB
- Stars: 94
- Watchers: 6
- Forks: 17
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# flycheck-clj-kondo
[](https://stable.melpa.org/#/flycheck-clj-kondo)
[](https://melpa.org/#/flycheck-clj-kondo)
This package integrates [clj-kondo](https://github.com/borkdude/clj-kondo) with Emacs via [flycheck](https://www.flycheck.org).
## Installation
Before installing the Emacs package, make sure the `clj-kondo` is on your
path. For installation instructions, see https://github.com/borkdude/clj-kondo.
### MELPA
Install from [MELPA](https://melpa.org/#/flycheck-clj-kondo):
```
M-x package-install flycheck-clj-kondo
```
Then add the following to your init.el:
```
(require 'flycheck-clj-kondo)
```
### use-package
Install via [use-package](https://jwiegley.github.io/use-package/):
```emacs-lisp
;; First install the package:
(use-package flycheck-clj-kondo
:ensure t)
;; then install the checker as soon as `clojure-mode' is loaded
(use-package clojure-mode
:ensure t
:config
(require 'flycheck-clj-kondo))
```
### el-get
Install via [el-get](https://github.com/dimitri/el-get):
``` emacs-lisp
(el-get-bundle flycheck-clj-kondo
:url "https://raw.githubusercontent.com/borkdude/flycheck-clj-kondo/master/flycheck-clj-kondo.el"
(require 'flycheck-clj-kondo))
```
## Multiple linters
To set up multiple linters, e.g. in combination with
[flycheck-joker](https://github.com/candid82/flycheck-joker), add this after you required the linter packages:
``` emacs-lisp
(dolist (checker '(clj-kondo-clj clj-kondo-cljs clj-kondo-cljc clj-kondo-edn))
(setq flycheck-checkers (cons checker (delq checker flycheck-checkers))))
```
This ensures that the clj-kondo checkers are the first ones in the `flycheck-checkers` list. This is needed to make the chain work. To create the chain, also add the following code:
``` emacs-lisp
(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))))
```
## Project Setup
To lint across namespaces in a project, clj-condo needs a directory to store cached data. Create a `.clj-kondo` directory and lint the entire classpath from the [command line](https://github.com/clj-kondo/clj-kondo#project-setup).
## Testing
Make sure [Eldev](https://github.com/doublep/eldev) is installed and
run `eldev test` for testing, `eldev lint` for linting.
## Troubleshooting
### clj-kondo is on my PATH but Flycheck still says it's disabled (M-x flycheck-verify-setup)
Check your PATH according to Emacs: `M-x shell`, then `echo $PATH`. If there are any differences between that PATH and the one you are able to run clj-kondo from (e.g., your PATH according to Terminal on macOS), add them by including them in your Emacs config. For example, if you needed to include `/usr/local/bin`, you could add to init.el:
```emacs-lisp
(setenv "PATH" (concat (getenv "PATH") ":/usr/local/bin"))
(setq exec-path (append exec-path '("/usr/local/bin")))
```
Then, restart Emacs.