Skip to content

Commit

Permalink
meta: release 0.0.2
Browse files Browse the repository at this point in the history
fix: scope derive cram tests to derive package
fix: clean up deps
  • Loading branch information
leostera committed Apr 12, 2024
1 parent 2b7380e commit 2ab29c2
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 6 deletions.
24 changes: 24 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
# 0.0.2

Complete rewrite of the Serde library with a heavy focus on usability and
maintainability.

* Support writing manual serializers and deserializers with an ergonomic API.

* Introduce a new CPS-style de/serialization mechanism.

* Configurable de/serializers including options to:
* rename all fields on records – thanks to @tjdevries :sparkles:
* ignore unknown fields – thanks to @tjdevries :clap:
* rename specific fields – thanks to @tjdevries :zap:
* adjacently tagged variants – thanks to @sabine
* out of order fields

* Better derivation support now including:
* records
* variants (unit, newtype, tuple, and record variants)
* lists and options
* floats – thanks to @wesleimp :clap:

* Support nix flakes for development and installation – thanks to @metame :sparkles:

# 0.0.1

Introduce the library with a few standard serde formats:
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ The main goals for `serde.ml` are:
structures of the user's choice with maximum efficiency.

```ocaml
type rank = Captain | Chief_petty_officer [@@deriving serializer, deserializer]
type t = { name : string; rank : rank } [@@deriving serializer, deserializer]
type rank = Captain | Chief_petty_officer [@@deriving serialize, deserialize]
type t = { name : string; rank : rank } [@@deriving serialize, deserialize]
let obrien = { name = "Miles O'Brien"; rank = Chief_petty_officer }
let sisko = { name = "Benjamin Sisko"; rank = Captain }
Expand Down
1 change: 1 addition & 0 deletions derive/dune
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
(pps ppxlib.metaquot)))

(cram
(package serde_derive)
(deps
(package serde)
(package serde_derive)
Expand Down
5 changes: 2 additions & 3 deletions dune-project
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
(rio (>= "0.0.8"))
(spices :with-test)
dune))


(package
(name serde_derive)
Expand All @@ -35,8 +34,8 @@
(ppx_deriving (>= "5.2.1"))
(ppxlib (>= "0.28.0"))
(serde (= :version))
(serde_json (and :with-test (= :version)))
dune))


(package
(name serde_json)
Expand All @@ -47,7 +46,7 @@
(qcheck :with-test)
(rio (>= "0.0.8"))
(serde (= :version))
(serde_derive (= :version))
(serde_derive (and :with-test (= :version)))
(spices :with-test)
(yojson (>= "2.1.0"))
dune))
Expand Down
1 change: 1 addition & 0 deletions serde_derive.opam
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ depends: [
"ppx_deriving" {>= "5.2.1"}
"ppxlib" {>= "0.28.0"}
"serde" {= version}
"serde_json" {with-test & = version}
"dune" {>= "3.12"}
"odoc" {with-doc}
]
Expand Down
2 changes: 1 addition & 1 deletion serde_json.opam
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ depends: [
"qcheck" {with-test}
"rio" {>= "0.0.8"}
"serde" {= version}
"serde_derive" {= version}
"serde_derive" {with-test & = version}
"spices" {with-test}
"yojson" {>= "2.1.0"}
"dune" {>= "3.12"}
Expand Down

0 comments on commit 2ab29c2

Please sign in to comment.