zprint-clj


_Node.js wrapper for ZPrint Clojure source code formatter_

Usage

$3

#### Install
``
npm i -g zprint-clj
`

#### Format and write back
`
zprint-clj -i "./src/*/.{clj,cljs,cljc,edn}" -o ./
`

#### Check formatting without writing (useful for CI)
`
zprint-clj --check "./src/*/.{clj,cljs,cljc,edn}"
`

$3

`
npm i zprint-clj
`

`js
const printFile = require('zprint-clj');
const outputText = format(inputText, inputFilePath, opts);
`

$3

* isHangEnabled true|false — enable hang mode (disabled by default), slows down formatting, but results in better formatted output

Difference between output when Hang mode is on and off

`diff
diff --git a/hang.clj b/nohang.clj
index 907120f..965fdfa 100644
--- a/hang.clj
+++ b/nohang.clj
@@ -1,6 +1,7 @@
(ns zprint-clj.core
- (:require [zprint.core :as zprint]
- [goog.object :as gobj]))
+ (:require
+ [zprint.core :as zprint]
+ [goog.object :as gobj]))
@@ -15,8 +16,9 @@

(defn- make-cfg
[opts]
- (cond (false? (gobj/get opts "isHangEnabled")) no-hang
- :else {}))
+ (cond
+ (false? (gobj/get opts "isHangEnabled")) no-hang
+ :else {}))
`

$3

You can configure zprint-clj with a .zprintrc file. The .zprintrc is written in EDN format.

Your .zprintrc file will be resolved if it is found in one of two locations:

1. The current directory where the zprint-clj process was initialized
2. The global HOME directory

If none found, we fall back on zprint-clj default settings.

Building

production

`
clojure scripts/build.clj
`

debug

`
clojure scripts/build_debug.clj
`

Local Development

The following guide outlines how to locally develop zprint-clj. Please make sure you have the clj cli tool installed.

- Install zprint-clj dependencies

`bash
npm install
`

- Make your your code changes in the src directory

- Compile your changes

`bash
clojure scripts/build_debug.clj
`

- Update js-src/index to look like this

`bash
const zp = require("../out/main-debug").zprint_clj.core;
`

> This tells zprint-clj to use the debug version

- Create a test Clojure file with some test code you want to see formatted

- Open the test file in your editor of choice

- Run zprint-clj against your test file

`clojure
js-src/cli.js -i -o
`

> If you are running in a different directory you will have to update above path to js-src/cli.js. The reason we run this instead of main-debug is because cli, or index`, act as the entry points for JS for this library.

Editor plugins

- Atom

License

MIT