Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/NoahTheDuke/splint
A Clojure linter focused on style and code shape.
https://github.com/NoahTheDuke/splint
clojure linter
Last synced: about 2 months ago
JSON representation
A Clojure linter focused on style and code shape.
- Host: GitHub
- URL: https://github.com/NoahTheDuke/splint
- Owner: NoahTheDuke
- License: mpl-2.0
- Created: 2022-10-01T04:50:28.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-10T21:09:38.000Z (3 months ago)
- Last Synced: 2024-07-11T05:27:17.340Z (3 months ago)
- Topics: clojure, linter
- Language: Clojure
- Homepage: https://cljdoc.org/d/io.github.noahtheduke/splint/
- Size: 977 KB
- Stars: 104
- Watchers: 5
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Splint
[](https://clojars.org/io.github.noahtheduke/splint)
[](https://cljdoc.org/d/io.github.noahtheduke/splint)
**Splint** is a Clojure linter focused on style and code shape. It aims to warn about many of the guidelines in the [Clojure Style Guide][style guide]. It is inspired by the Ruby linter [RuboCop][rubocop] and the Clojure linter [Kibit][kibit].
[style guide]: https://guide.clojure.style
## Installation and Usage
More explicit instructions can be found in the [installation][installation], [usage][usage], and [configuration][configuration] pages, but here's a quick rundown:
[installation]: docs/installation.md
[usage]: docs/usage.md
[configuration]: docs/configuration.md
### Clojure CLI
```clojure
:aliases {:splint {:extra-deps {io.github.noahtheduke/splint {:mvn/version "1.15.2"}
org.clojure/clojure {:mvn/version "1.11.1"}}
:main-opts ["-m" "noahtheduke.splint"]}}
```
Run with `clojure -M:splint [args...]`.
### Leiningen
Add this to `project.clj`:
```clojure
:profiles {:dev {:dependencies [[io.github.noahtheduke/splint "1.15.2"]
[org.clojure/clojure "1.11.1"]]}}
:aliases {"splint" ["run" "-m" "noahtheduke.splint"]})
```
Run with `lein splint [args...]`.
## Rationale
Why another Clojure linter? We have [clj-kondo][clj-kondo], [eastwood][eastwood], and [kibit][kibit], in addition to [clojure-lsp][clojure-lsp]'s capabilities built on top of clj-kondo. I have contributed to most of these, and recently took over maintenance of kibit. However, most of them aren't built to be easily modifiable, and while kibit's rules are simple, the underlying engine (built on [core.logic][core.logic]) is quite slow. This means that adding or updating the various linting rules can be quite frustrating and taxing.
Inspired by [RuboCop][rubocop], I decided to try something new: A "fast enough" linting engine based on linting code shape, built to be easily extended.
[clj-kondo]: https://github.com/clj-kondo/clj-kondo
[eastwood]: https://github.com/jonase/eastwood
[kibit]: https://github.com/clj-commons/kibit
[clojure-lsp]: https://clojure-lsp.io
[core.logic]: https://github.com/clojure/core.logic
[rubocop]: https://rubocop.org
## Non-goals
For speed and simplicity, Splint doesn't run any code, it only works on the provided code as text. As such, it doesn't understand macros or perform any macro-expansion (unlike Eastwood) so it can only lint a given macro call, not the resulting code.
clj-kondo performs lexical analysis and can output usage and binding information, such as unused or incorrectly defined vars. At this time, Splint makes no such efforts. It is only focused on code shape, not code intent or meaning.
Versions are not semantic, they are incremental. Splint is not meant to be infrastructure, so don't rely on it like infrastructure; it is a helpful development tool. It should not be relied on as a library. I make no guarantees about public API, visibility of functions, consistency of data shape, or otherwise. I hope to maintain consistent `json` and `edn` output so users can expect that to stay the same, but everything inside of Splint should be considered implementation detail.
## Speed comparison
```text
$ tokei
===============================================================================
Language Files Lines Code Comments Blanks
===============================================================================
Clojure 172 122744 111266 4421 7057
ClojureC 4 1013 851 36 126
ClojureScript 48 14220 13184 142 894
$ time lein kibit
...
real 34m30.395s
user 35m4.952s
sys 0m2.995s
$ time splint .
...
Linting took 5622ms, checked 223 files, 804 style warnings
real 0m5.969s
user 0m47.830s
sys 0m0.379s
```
## License
Copyright © Noah Bogart
Distributed under the Mozilla Public License version 2.0.