diff --git a/CHANGELOG.md b/CHANGELOG.md index 1bcf2cb..c436c7b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/README.md b/README.md index e73d16a..41ef8ad 100644 --- a/README.md +++ b/README.md @@ -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