api-diff

api-diff copied to clipboard

Distinguish lang (aka platform aka dialect, i.e. Clojure, ClojureScript)

4

**Scenario** One var can be defined differently for different langs. A contrived example: ```Clojure #?(:cljs (defn mixed [a cljs sig]) :clj (defn mixed [a different clj sig])) ``` A real-world...

lread

## Context It is a common desire/need to avoid inflicting breakage to one's downstream consumers. It can be hard to consistently avoid this in authoring / code review phases. ##...

vemv

Consider optionally returning result as edn

4

**Proposal** Optionally return api-diff result as a map. - the code would benefit from separating reporting from analysis - the user would benefit from being able to use the result...

lread

Consider reporting on callable <-> not-callable change

3

If v1 has ```Clojure (defn becomes-def []) ``` And v2 has: ```Clojure (def becomes-def 42) ``` An arity 0 deletion is currently reported. This is an indicator of breakage and...

lread

Consider showing additions

5

**Proposal** Api-diff currently shows what has been removed. The (very worthy) focus, it seems, is on discovering breakages. It can also be interesting to see what was added to an...

lread

Consider reporting on variadic arity

1

When v1 has ```Clojure (defn variadic-loss [a b c & more]) ``` And v2 has ```Clojure (defn variadic-loss [a b]) ``` The loss of the variadic signature could be reported,...

lread

Optionally compare by Clojure dialect

1

**Proposal** Some libraries expose a different API for different dialects of Clojure. It could be interesting to allow comparison of API by Clojure dialect. Vested interest examples: - How does...

lread

Clarification: What is considered a breaking change?

1

It would be nice to add to the README a few words about what is considered a breaking change.

viebel