Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/immoh/nsorg-cli
Organize ns form using Clojure CLI
https://github.com/immoh/nsorg-cli
clojure code-style ns-forms
Last synced: 4 months ago
JSON representation
Organize ns form using Clojure CLI
- Host: GitHub
- URL: https://github.com/immoh/nsorg-cli
- Owner: immoh
- License: epl-1.0
- Created: 2019-03-07T19:46:14.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-11-03T05:43:30.000Z (about 2 years ago)
- Last Synced: 2024-09-28T17:40:55.071Z (4 months ago)
- Topics: clojure, code-style, ns-forms
- Language: Clojure
- Homepage:
- Size: 15.6 KB
- Stars: 8
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nsorg-cli [](https://travis-ci.org/immoh/nsorg-cli)
Organize `ns` form in a way that whitespace and comments are preserved, using the [Clojure CLI](https://clojure.org/guides/deps_and_cli).
Rules to apply are fully customizable; the default implementation
* sorts `:require`, `:require-macros`, `:use` and `:use-macros` libspecs alphabetically and removes duplicates
* sorts `:import` class names alphabetically and removes duplicates
* sorts `:exclude`, `:only`, `:refer`, `:refer-macros` and `:rename` options alphabetically and removes duplicates
Also available as Clojure library [nsorg](https://github.com/immoh/nsorg)
and Leiningen plugin [lein-nsorg](https://github.com/immoh/lein-nsorg).
## Usage
You can try it out with this one liner:
```
$ clojure -Sdeps '{:deps {nsorg-cli/nsorg-cli {:mvn/version "0.3.1"}}}' -m nsorg.cli
```
Or add it as an alias in your `deps.edn` file:
```clj
{:aliases {:nsorg {:extra-deps {nsorg-cli {:mvn/version "0.3.1"}}
:main-opts ["-m" "nsorg.cli"]}}}
```
and run it with:
```
$ clojure -Ansorg
```
Example output:
```
...
in ./src/perf/clojure/clojure/java/perf_jdbc.clj:
These test compare the raw performance (against an in-memory H2 database)
for hand-crafted Java JDBC calls and various `query` and `reducible-query`
calls."
- (:require [criterium.core :as cc]
- [clojure.java.jdbc :as sql])
- (:import (java.sql Connection PreparedStatement ResultSet Statement ResultSetMetaData)))
+ (:require [clojure.java.jdbc :as sql]
+ [criterium.core :as cc])
+ (:import (java.sql Connection PreparedStatement ResultSet ResultSetMetaData Statement)))
(defn calibrate []
;; 840ms
...
Checked 5 files, found problems in 3 files
```
### Paths
Paths to check can be given as arguments:
```
$ clojure -Ansorg src dev/src
```
If no locations are given default location is current directory.
### Ignoring files
You can ignore a specific file or directory by excluding it from command-line:
```
$ clojure -Ansorg --exclude src/my-project/broken_file.clj --exclude test
```
### Apply changes automatically
By default lein-nsorg prints diffs for suggested changes. Changes can be applied automatically to source files with the
following option:
```
$ clojure -Ansorg --replace
```
### Interactive mode
Instead of applying changes automatically interactive mode asks for each file if suggestions should be applied or not:
```
$ clojure -Ansorg --replace --interactive
```
## License
Copyright © 2019 Immo Heikkinen
Distributed under the Eclipse Public License either version 1.0 or (at your option) any later version.