|
1 |
| -# Revision history for cuddle |
| 1 | +# Changelog for `cuddle` |
2 | 2 |
|
3 |
| -## 0.1.0.0 -- YYYY-mm-dd |
| 3 | +## 0.5.0.0 |
4 | 4 |
|
5 |
| -* First version. Released on an unsuspecting world. |
6 |
| - |
7 |
| -## 0.3.0.0 --2024-07-25 |
| 5 | +* Implement a validator for CBOR terms. |
8 | 6 |
|
9 |
| -* Rationalise the choice operators. Drop (//) and provide detailed comments |
10 |
| - explaining the use of (/). |
| 7 | +## 0.4.0.0 |
11 | 8 |
|
12 |
| -## 0.3.0.1 -- 2024-07-31 |
| 9 | +* Rewrote the prettyprinter to make the output more human-readable. |
| 10 | +* Added `collectFromInit` to make it possible to specify the order of |
| 11 | + definitions manually. `collectFrom` and `collectFromInit` now expect |
| 12 | + `HuddleItem`s in their arguments |
| 13 | +* More Huddle terms now accept comments (e.g. `ArrayEntry`, `ArrayChoice`) |
| 14 | +* Parser now preserves most comments. |
13 | 15 |
|
14 |
| -* Improvements in the pretty printer - various groups should be formatted more |
15 |
| - cleanly |
| 16 | +## 0.3.6.0 |
16 | 17 |
|
17 |
| -## 0.3.1.0 -- 2024-08-15 |
| 18 | +* Support having keys in group entries. This is needed when using a group to |
| 19 | + define a map, or when wishing to include keys in for-use-in-array groups for |
| 20 | + documentation purposes. This may introduce problems with existing specifications |
| 21 | + where some type hints (using 'a') are needed to properly type entries in groups, |
| 22 | + where previously they were unambiguous. |
18 | 23 |
|
19 |
| -* `collectFrom` now adds a first definition in the generated Huddle referencing |
20 |
| - the top level elements, to be compatible with the CDDL spec. |
| 24 | + Note that it is not yet supported to use a group inside a map, where the |
| 25 | + issue of merging keys arises. |
21 | 26 |
|
22 |
| -## 0.3.2.0 -- 2024-09-11 |
| 27 | +## O.3.5.0 |
23 | 28 |
|
24 |
| -* Leading rather than trailing commas in the pretty printer. |
| 29 | +* Add support for constraints on references and generic references. |
| 30 | +* Add support for using references as range bounds. Note that this breaks |
| 31 | + backwards compatibility - because the range arguments are now more generic, |
| 32 | + additional hints are required to type literal numerics correctly. Typically |
| 33 | + this is most easily fixed by adding a call `int` for any numeric literals in |
| 34 | + ranges. An example is shown in `example/Conway.hs` |
25 | 35 |
|
26 |
| -## 0.3.3.0 -- 2024-11-13 |
| 36 | +## 0.3.3.0 |
27 | 37 |
|
28 | 38 | * Introduce HuddleM, another way to define a Huddle spec. This allows total
|
29 | 39 | control over the order that items are presented in the CDDL, at the cost
|
30 | 40 | of making it somewhat harder to re-use items (they need to be returned from
|
31 | 41 | the monad).
|
32 | 42 |
|
33 |
| -## O.3.5.0 -- 2024-11-25 |
| 43 | +## 0.3.2.0 |
34 | 44 |
|
35 |
| -* Add support for constraints on references and generic references. |
36 |
| -* Add support for using references as range bounds. Note that this breaks |
37 |
| - backwards compatibility - because the range arguments are now more generic, |
38 |
| - additional hints are required to type literal numerics correctly. Typically |
39 |
| - this is most easily fixed by adding a call `int` for any numeric literals in |
40 |
| - ranges. An example is shown in `example/Conway.hs` |
| 45 | +* Leading rather than trailing commas in the pretty printer. |
41 | 46 |
|
42 |
| -## 0.3.6.0 -- 2024-12-02 |
43 |
| -* Support having keys in group entries. This is needed when using a group to |
44 |
| - define a map, or when wishing to include keys in for-use-in-array groups for |
45 |
| - documentation purposes. This may introduce problems with existing specifications |
46 |
| - where some type hints (using 'a') are needed to properly type entries in groups, |
47 |
| - where previously they were unambiguous. |
| 47 | +## 0.3.1.0 |
48 | 48 |
|
49 |
| - Note that it is not yet supported to use a group inside a map, where the |
50 |
| - issue of merging keys arises. |
| 49 | +* `collectFrom` now adds a first definition in the generated Huddle referencing |
| 50 | + the top level elements, to be compatible with the CDDL spec. |
51 | 51 |
|
52 |
| -## 0.4.0.0 -- 2025-05-02 |
53 |
| -* Rewrote the prettyprinter to make the output more human-readable. |
54 |
| -* Added `collectFromInit` to make it possible to specify the order of |
55 |
| - definitions manually. `collectFrom` and `collectFromInit` now expect |
56 |
| - `HuddleItem`s in their arguments |
57 |
| -* More Huddle terms now accept comments (e.g. `ArrayEntry`, `ArrayChoice`) |
58 |
| -* Parser now preserves most comments. |
| 52 | +## 0.3.0.1 |
59 | 53 |
|
60 |
| -## 0.5.0.0 -- 2025-06-03 |
| 54 | +* Improvements in the pretty printer - various groups should be formatted more |
| 55 | + cleanly |
| 56 | + |
| 57 | +## 0.3.0.0 |
| 58 | + |
| 59 | +* Rationalise the choice operators. Drop (//) and provide detailed comments |
| 60 | + explaining the use of (/). |
| 61 | + |
| 62 | +## 0.1.0.0 |
| 63 | + |
| 64 | +* First version. Released on an unsuspecting world. |
61 | 65 |
|
62 |
| -* Implement a validator for CBOR terms. |
|
0 commit comments