Skip to content

Commit

Permalink
Clarify maintenance status in README
Browse files Browse the repository at this point in the history
  • Loading branch information
NoahTheDuke committed May 16, 2024
1 parent a7f77b0 commit 5b40c3a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ All notable changes to this project will be documented in this file. This change
* Switch to borkdude/edamame for side-effect free parsing. [#235](https://github.com/clj-commons/kibit/pull/235), [#246](https://github.com/clj-commons/kibit/pull/246)
* Correctly gather options-spec require vectors as maps so we can check for :as and :as-alias. [#238](https://github.com/clj-commons/kibit/pull/238)
* Moved all of the test/resources files to a new corpus folder which isn't loaded by default on test runs.
* Clarify maintenance status in README.

## 0.1.10 / 2024-05-09

Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@ it will suggest using `when` instead:
(some action))
```

## Maintenance Status

`kibit` is currently in maintenance. It will receive bug fixes and support for new versions of Clojure, but there are no plans for major changes or additions to the core functionality. Why not? `core.logic` is very clever but quite slow, and the existing architecture is such that to move away from `core.logic` would be to rewrite almost the entire library.

[Splint](https://github.com/NoahTheDuke/splint) is such a rewrite, built from the ground-up to be fast and extensible. It supports all of `kibit`'s rules (and many others), runs in a fraction of the time, can be configured from a file, and can output warnings in `kibit`-like text and markdown, as well as clj-kondo-compatible, json, and edn.

For other Clojure linters, see [clj-kondo](https://github.com/borkdude/clj-kondo) and [Eastwood](https://github.com/jonase/eastwood).

## Usage

Add `[lein-kibit "0.1.9"]` to your `:plugins` vector in your `:user` profile. Then you can run
Expand Down

0 comments on commit 5b40c3a

Please sign in to comment.