Liking cljdoc? Tell your friends :D

rewrite-clj

cljdoc Unit Tests Native Image Tests Code Coverage Join chat Clojars project

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.

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.

Licences

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

Code has been merged/adapted from:

Can you improve this documentation? These fine people already did:
lread & Lee Read
Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close