Skip to content

Commit

Permalink
Release 0.11.0
Browse files Browse the repository at this point in the history
  • Loading branch information
weavejester committed Jul 27, 2023
1 parent 4039054 commit 3aa4fdc
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 10 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
## 0.11.0 (2023-07-27)

- Breaking change: split `:indents` into `:indents` and `:extra-indents`
- Breaking change: removed `--indents` and `--alias-map` CLI options
- Added `--config` CLI option
- Added `#re` data reader for edn configurations

## 0.10.6 (2023-06-30)

- Added active config file to `--help` text
Expand Down
24 changes: 19 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,15 @@ project may be more suitable.
[clojure style guide]: https://github.com/bbatsov/clojure-style-guide
[zprint]: https://github.com/kkinnear/zprint

## Breaking Changes in 0.11.0

The `:indents` key has been split into `:indents` and `:extra-indents`.
The `:indents` key **replaces** all default indents, while the
`:extra-indents` key will **append** to the default indents.

The `--indents` and `--alias-map` keys have been removed from the CLI,
in favor of using a configuration file instead.

## Usage

cljfmt integrates with many existing build tools, or can be used as a
Expand Down Expand Up @@ -54,7 +63,7 @@ Use `--help` for a list of all the command-line options.

For persistent configuration, you can use a [configuration file][].

[zipped up binary]: https://github.com/weavejester/cljfmt/releases/download/0.10.6/cljfmt-0.10.6-win-amd64.zip
[zipped up binary]: https://github.com/weavejester/cljfmt/releases/download/0.11.0/cljfmt-0.11.0-win-amd64.zip
[configuration file]: #configuration

### Clojure Tools
Expand All @@ -63,7 +72,7 @@ The official Clojure CLI supports installation of thirdparty [tools][].
To install cljfmt as a tool, run:

```bash
clj -Ttools install io.github.weavejester/cljfmt '{:git/tag "0.10.6"}' :as cljfmt
clj -Ttools install io.github.weavejester/cljfmt '{:git/tag "0.11.0"}' :as cljfmt
```

To use the tool to check for formatting errors in your project, run:
Expand All @@ -86,7 +95,7 @@ clj -Tcljfmt fix
Leiningen, add the following plugin to your `project.clj` file:

```clojure
:plugins [[dev.weavejester/lein-cljfmt "0.10.6"]]
:plugins [[dev.weavejester/lein-cljfmt "0.11.0"]]
```

To use the plugin to check code for formatting errors, run:
Expand All @@ -113,7 +122,7 @@ cljfmt can be run as a library that formats a string of Clojure code.
First, add the dependency:

```edn
{:deps {dev.weavejester/cljfmt {:mvn/version "0.10.6"}}}
{:deps {dev.weavejester/cljfmt {:mvn/version "0.11.0"}}}
```

Then use the library:
Expand Down Expand Up @@ -181,7 +190,12 @@ In order to load the standard configuration file from Leiningen, add the

* `:indents` -
a map of var symbols to indentation rules, i.e. `{symbol [& rules]}`.
See [INDENTS.md][] for a complete explanation.
See [INDENTS.md][] for a complete explanation. This will **replace**
the default indents.

* `:extra-indents` -
the same as `:indents`, except that this will **append** to the
default indents.

* `:alias-map` -
a map of namespace alias strings to fully qualified namespace
Expand Down
2 changes: 1 addition & 1 deletion cljfmt/project.clj
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(defproject dev.weavejester/cljfmt "0.10.6"
(defproject dev.weavejester/cljfmt "0.11.0"
:description "A library for formatting Clojure code"
:url "https://github.com/weavejester/cljfmt"
:scm {:dir ".."}
Expand Down
2 changes: 1 addition & 1 deletion cljfmt/src/cljfmt/main.clj
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[clojure.tools.cli :as cli])
(:gen-class))

(def ^:const VERSION "0.10.6")
(def ^:const VERSION "0.11.0")

(defn- cli-options [defaults]
[["-h" "--help"]
Expand Down
2 changes: 1 addition & 1 deletion install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

set -euo pipefail

VERSION=0.10.6
VERSION=0.11.0

case $(uname -s) in
Linux*)
Expand Down
4 changes: 2 additions & 2 deletions lein-cljfmt/project.clj
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
(defproject dev.weavejester/lein-cljfmt "0.10.6"
(defproject dev.weavejester/lein-cljfmt "0.11.0"
:description "A library for formatting Clojure code"
:url "https://github.com/weavejester/cljfmt"
:scm {:dir ".."}
:license {:name "Eclipse Public License"
:url "http://www.eclipse.org/legal/epl-v10.html"}
:eval-in-leiningen true
:dependencies [[dev.weavejester/cljfmt "0.10.6"]])
:dependencies [[dev.weavejester/cljfmt "0.11.0"]])

0 comments on commit 3aa4fdc

Please sign in to comment.