Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ertugrulcetin/lein-nsort
Leiningen plugin that checks that order of namespace declarations for Clojure and ClojureScript
https://github.com/ertugrulcetin/lein-nsort
clojure clojurescript leiningen linter namespace
Last synced: 26 days ago
JSON representation
Leiningen plugin that checks that order of namespace declarations for Clojure and ClojureScript
- Host: GitHub
- URL: https://github.com/ertugrulcetin/lein-nsort
- Owner: ertugrulcetin
- License: mit
- Created: 2020-11-08T21:33:11.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-05-13T16:34:09.000Z (over 3 years ago)
- Last Synced: 2025-01-03T06:54:37.094Z (29 days ago)
- Topics: clojure, clojurescript, leiningen, linter, namespace
- Language: Clojure
- Homepage:
- Size: 27.3 KB
- Stars: 18
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# lein-nsort
Leiningen plugin that checks that order of namespace declarations for Clojure and ClojureScript
## Usage
[](https://clojars.org/lein-nsort)
### Adding the dependency to `:plugins`
Add `[lein-nsort "0.1.14"]` into the `:plugins` vector of your
`project.clj` or `~/.lein/profiles.clj`.
```clj
(defproject my-project
:plugins [[lein-nsort "0.1.14"]])
```
### Running the checker
Run the nsort like this:
```
lein nsort
```
This will check `ns` declaration forms for all Clojure and ClojureScript source files in
the `{:nsort {:source-paths ["src"]}}` of your project (default `./src/`).
### Output
```clj
(ns bloom.report.utils.citeproc
(:require [clojure.data.json :as json]
[bloom.server.config :refer [config]]
[clj-http.client :as http]))
;; After running check
--- bloom.report.utils.citeproc :require form should be sorted like this:
(:require
[bloom.server.config :refer [config]]
[clj-http.client :as http]
[clojure.data.json :as json])
```
## Automatically replacing namespace declarations in source files
```
lein nsort --replace
```
OR
```
lein nsort -r
```
## Configuration (Optional)
Add a `:nsort` key to your `project.clj` to customize the checker.
```clj
(defproject my-project
:nsort {:require :asc ;;(default)
:import :desc
:source-paths ["src"] ;;(default)
:ignored-nses [my.app.core]
})
```
There are 4 pre-defined sorting checks for `:require` and 2 for `:import`.
**require**: `:asc`, `:desc`, `:alias-bottom-asc` and `:alias-bottom-desc`
**import**: `:asc` and `:desc`
`:alias-bottom-asc` and `:alias-bottom-desc` keep namespaces without aliases at the bottom and sort rest of the namespace declarations:
```clj
;; :alias-bottom-asc
(:require
[clojure.java.io :as io]
[clojure.pprint :as pp]
[clojure.tools.namespace.find :as ns-find]
[clojure.string])
```
Also you can **define** your own sorting functions like:
```clj
{...
:nsort {:require {:sort-fn (juxt #(.indexOf % :as) first)}
:import {:sort-fn first
:comp #(compare %2 %1)}} ;; converting to (sort-by first #(compare %2 %1) namespace-decls)
...}
```
## License
MIT License
Copyright (c) 2020 Ertuğrul Çetin
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.