releasing 1.0

Author: gelisam

CHANGELOG.md

@@ -1,7 +1,24 @@
-# next release
-* you can now call a function expecting (xs ~ rewritten-expr) given
-  (xs ~ expr). previously you could only call a function expecting
-  (xs ~ expr) given (xs ~ rewritten-expr).
+# 1.0
+* Now supports ghc-8.10! Unfortunately, ghc-8.6 and ghc-8.8 are no longer
+  supported.
+* Now using ghc's builtin iteration limit instead of a hardcoded internal
+  limit. Since ghc's limit is much smaller than our internal limit was, you may
+  need to add something like `{-# OPTIONS_GHC -fconstraint-solver-iterations=100 #-}`
+  if ghc recommends you to do so.
+* Now making use of givens. That is, you can now call a function expecting
+  (xs ~ rewritten-expr) given (xs ~ expr). Previously, you could only call a
+  function expecting (xs ~ expr) given (xs ~ rewritten-expr).
+* Now supports instance constraints. That is, you can now call a function which
+  requires an `Eq (Vec rewritten-expr)` given an `Eq (Vec expr)`. Previously,
+  we only supported equality constraints (`expr ~ rewritten-expr`).
+* Now works with type variables of kind Nat and Symbol.
+* The generated code now passes ghc's core-lint check.
+* Error messages involving rewritten constraints now include the relevant
+  rewrite rules.
+* Bugfix: a spurious "the substitution forms a cycle" message was sometimes
+  emitted even when the substitution rules did not form a cycle (see #15).
+* Bugfix: rewrite rules were sometimes not firing (see #21).
+* Bugfix: error messages were sometimes missing the error location (see #17).
 
 # 0.1
 * initial release

package.yaml

@@ -1,5 +1,5 @@
 name:                typelevel-rewrite-rules
-version:             0.1
+version:             1.0
 synopsis:            Solve type equalities using custom type-level rewrite rules
 description:         A typechecker plugin which allows the user to specify a set of domain-specific rewrite rules. These get applied whenever the compiler is unable to solve a type equality constraint, in the hope that the rewritten equality constraint will be easier to solve.
 homepage:            https://github.com/gelisam/typelevel-rewrite-rules#readme

typelevel-rewrite-rules.cabal

@@ -4,10 +4,10 @@ cabal-version: 1.12
 --
 -- see: https://github.com/sol/hpack
 --
--- hash: 9f48bb7a095b5c1013eea7fd9a710bcd26767997c67b53ced080af167cd221bd
+-- hash: 7433f0d507fa4c45ff48ddb8ea9bd1de4b7e5ce7ea203fbd5abd344eead851ec
 
 name:           typelevel-rewrite-rules
-version:        0.1
+version:        1.0
 synopsis:       Solve type equalities using custom type-level rewrite rules
 description:    A typechecker plugin which allows the user to specify a set of domain-specific rewrite rules. These get applied whenever the compiler is unable to solve a type equality constraint, in the hope that the rewritten equality constraint will be easier to solve.
 category:       Type System