A library that reads and writes Clojure, ClojureScript and EDN from Clojure and ClojureScript in a whitespace and comment preserving way.

Status

Warning: v1 Alpha Release

• Migration from rewrite-cljc-playground complete. Rewrite-cljc-playground is where I first merged rewrite-clj v0 and rewrite-cljs.

• We are automatically testing against popular libraries. We patch them to use rewrite-clj v1 and then run their test suites. Only a minor failure on zprint v1.1.1 was found due to intentional breaking changes in namespaced maps.

• Please review change log for an overview of all v1 changes.

• I am very conservative on making any further v0→v1 breaking changes, but am open to breaking changes to any of the new v1 work.

We’ll move out of alpha after folks have had a chance to give rewrite-clj v1 alpha a good shake. Things look solid but I would be very surprised if there are no issues and/or feedback.

See project page for current priorities.

Docs

• User Guide

• Developer Guide

• Design

  • Merging rewrite-clj and rewrite-cljs

• FAQ

Used In…​

Some projects using rewrite-clj v1

• antq ^🐥

• carve ^🐥 (in dev)

• cljfmt ^🐥 (in dev)

• clojure-lsp ^🐥

• rewrite-edn ^🐥

• test-doc-blocks ^🐥

Some projects using rewrite-clj v0 and/or rewrite-cljs

• atom-chlorine ^📍

• cljstyle ^{🐥 🩹}

• depot ^{🐥 🩹}

• kibit ^🐥

• lein-ancient ^🐥

• mranderson ^🐥

• mutant ^🐥

• pack (alpha) ^📍

• refactor-nrepl ^🐥

• repl-tooling ^📍

• update-leiningen-dependencies-skill ^📍

• zprint ^{🐥 🩹}

Have an update? Let us know!

^🐥 canary tested against rewrite-clj v1 lib test suite
^🩹 source required minor change to work with rewrite-clj v1
^📍 no easy to run unit tests found for this project

Versioning

Rewrite-clj versioning scheme is: major.minor.patch-test-qualifier

• major increments when a non alpha release API has been broken - something, as a rule, we’d like to avoid.

• minor increments to convey significant new features have been added.

• patch indicates bug fixes - it is the total number of commits in the repo.

• test-qualifier is absent for stable releases. Can be alpha, beta, rc1, etc.

People

Contributors

Founders

Current maintainers

Changes

Licences

We honor the original MIT license from rewrite-clj v0.

Code has been merged/adapted from:

• rewrite-cljs which has an MIT license

• clojure zip which is covered by Eclipse Public License 1.0