Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clj-kondo/lein-clj-kondo
Leiningen plugin to run clj-kondo
https://github.com/clj-kondo/lein-clj-kondo
clj-kondo leiningen
Last synced: about 1 month ago
JSON representation
Leiningen plugin to run clj-kondo
- Host: GitHub
- URL: https://github.com/clj-kondo/lein-clj-kondo
- Owner: clj-kondo
- License: epl-1.0
- Created: 2021-08-18T15:48:29.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-03-13T13:10:09.000Z (9 months ago)
- Last Synced: 2024-05-02T02:16:55.928Z (8 months ago)
- Topics: clj-kondo, leiningen
- Language: Clojure
- Homepage:
- Size: 55.7 KB
- Stars: 14
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- stars - clj-kondo/lein-clj-kondo - Leiningen plugin to run clj-kondo \[*Eclipse Public License 1.0*\] (⭐️15) (Clojure)
- stars - clj-kondo/lein-clj-kondo - Leiningen plugin to run clj-kondo \[*Eclipse Public License 1.0*\] (⭐️15) (Clojure)
README
[](https://clojars.org/com.github.clj-kondo/lein-clj-kondo)
# lein-clj-kondo
A Leiningen plugin to run [clj-kondo](https://github.com/clj-kondo/clj-kondo).
## Rationale
Running clj-kondo through Leiningen has some advantages, since it can compute for you things that would have to be specified by hand otherwise
(and those things can be forgotten, outdated, etc).
It also provides the ability to express clj-kondo options as Lein project map options, which can work nicely with Lein profiles, plugins, etc.
With using Leiningen, there's the tradeoff of startup speed, which might not be as critical in a CI environment as it is in your CLI.
## Installation
Add the plugin to your `project.clj`:
```clojure
:plugins [[com.github.clj-kondo/lein-clj-kondo "0.2.5"]]
```
## Usage
This plugin accepts one of the following patterns:
* `lein clj-kondo`
* This lints your `:source-paths` and `:test-paths`, as computed by Leiningen.
* It is necessary that you have analysed the project beforehand (see below)
* `lein clj-kondo `
* This is a good place to analyse your project, or to lint directories other than the `:source-paths` and `:test-paths`.
* For more information on all available options, check the [documentation](https://github.com/clj-kondo/clj-kondo/blob/master/doc/config.md).
### Lein CLI
``` bash
$ # 1.- Analyse your project:
$ lein with-profile +test clj-kondo --copy-configs --dependencies --parallel --lint '$classpath'
$ # 2.- Lint your source and test paths:
$ lein with-profile +test clj-kondo
```
Activating the `+test` profile is recommended, so that any `:test` dependencies are analysed, increasing linting accuracy.
(Note that the `:dev` profile is already active by default)
### Aliases
You can configure your project.clj to add custom aliases to run specific clj-kondo tasks, below you can find a simple example which first lints the project dependencies and then lints the project code:
```clojure
,,,
:aliases {"clj-kondo-deps" ["with-profile" "+test" "clj-kondo" "--copy-configs" "--dependencies" "--parallel" "--lint" "$classpath"]
"clj-kondo-lint" ["do" ["clj-kondo-deps"] ["with-profile" "+test" "clj-kondo"]]}
,,,
```
## Config
lein-clj-kondo understands clj-kondo config expressed as `:config` in a Leiningen project map. Example:
```clj
;; Enable a specific linter
:clj-kondo {:config {:linters {:docstring-leading-trailing-whitespace {:level :warning}}}}
```
The traditional ways of specifying options of course keep working:
* You can place a `.clj-kondo/config.edn` file in your project.
* You can use the `--config ...` CLI option.
### Deploy
`bb tag x.y.z` to tag the new release, github actions will do the deploy to clojars automatically.