update: deprecate mapN, nel, resultOf

mlms13 · Apr 8, 2023 · 8242290 · 8242290
1 parent c89e464
commit 8242290
Show file tree

Hide file tree

Showing 8 changed files with 20 additions and 0 deletions.
diff --git a/src/Decode_AsOption.re b/src/Decode_AsOption.re
@@ -1,3 +1,4 @@
+[@ocaml.warning "-3"]
 module OptionTransform:
   Decode_ParseError.TransformError with type t('a) = option('a) = {
   type t('a) = option('a);

diff --git a/src/Decode_AsResult_OfParseError.re b/src/Decode_AsResult_OfParseError.re
@@ -1,6 +1,7 @@
 module NonEmptyList = Relude.NonEmpty.List;
 module ParseError = Decode_ParseError;
 
+[@ocaml.warning "-3"]
 module Result =
   ParseError.ResultOf({
     type t = ParseError.base;

diff --git a/src/Decode_AsResult_OfParseError.rei b/src/Decode_AsResult_OfParseError.rei
@@ -1,3 +1,6 @@
+[@deprecated
+  "NonEmptyList helpers shouldn't be needed, but you can find them in Relude"
+]
 module NonEmptyList: Decode_NonEmptyList.Nel;
 module ParseError = Decode_ParseError;
 
@@ -13,6 +16,7 @@ let apply:
   ) =>
   result('b, ParseError.failure);
 
+[@deprecated "Will be removed in 2.0 with the addition of and+"]
 let map2:
   (
     ('a, 'b) => 'c,
@@ -22,6 +26,7 @@ let map2:
   ) =>
   result('c, ParseError.failure);
 
+[@deprecated "Will be removed in 2.0 with the addition of and+"]
 let map3:
   (
     ('a, 'b, 'c) => 'd,
@@ -32,6 +37,7 @@ let map3:
   ) =>
   result('d, ParseError.failure);
 
+[@deprecated "Will be removed in 2.0 with the addition of and+"]
 let map4:
   (
     ('a, 'b, 'c, 'd) => 'e,
@@ -43,6 +49,7 @@ let map4:
   ) =>
   result('e, ParseError.failure);
 
+[@deprecated "Will be removed in 2.0 with the addition of and+"]
 let map5:
   (
     ('a, 'b, 'c, 'd, 'e) => 'f,

diff --git a/src/Decode_AsResult_OfStringNel.re b/src/Decode_AsResult_OfStringNel.re
@@ -22,6 +22,7 @@ module ResultUtil = {
   let pure = Result.pure;
   let flat_map = Result.bind;
 
+  [@ocaml.warning "-3"]
   module Transform:
     ParseError.TransformError with
       type t('a) = result('a, NonEmptyList.t(string)) = {

diff --git a/src/Decode_Base.re b/src/Decode_Base.re
@@ -3,6 +3,7 @@ open BsBastet.Interface;
 
 module ParseError = Decode_ParseError;
 
+[@ocaml.warning "-3"]
 module Make =
        (T: ParseError.TransformError, M: MONAD with type t('a) = T.t('a)) => {
   type t('a) = Js.Json.t => M.t('a);

diff --git a/src/Decode_ParseError.rei b/src/Decode_ParseError.rei
@@ -22,6 +22,7 @@ and objError('a) =
 
 type failure = t(base);
 
+[@deprecated "Extending the result type is deprecated"]
 module type TransformError = {
   type t('a);
   let valErr: (base, Js.Json.t) => t('a);
@@ -42,11 +43,14 @@ let toDebugString:
 
 let failureToDebugString: t(base) => string;
 
+[@deprecated "Extending the result type is deprecated"]
 module type ValError = {
   type t;
   let handle: base => t;
 };
 
+[@deprecated "Extending the result type is deprecated"]
+[@ocaml.warning "-3"]
 module ResultOf:
   (Err: ValError) =>
    {

diff --git a/test/Decode_AsResult_OfCustom_test.re b/test/Decode_AsResult_OfCustom_test.re
@@ -11,6 +11,7 @@ module Sample = Decode_TestSampleData;
 
 type customError = [ ParseError.base | `InvalidColor | `InvalidShape];
 
+[@ocaml.warning "-3"]
 module ResultCustom =
   Decode.ParseError.ResultOf({
     type t = customError;

diff --git a/test/Decode_AsResult_OfParseError_test.re b/test/Decode_AsResult_OfParseError_test.re
@@ -286,6 +286,7 @@ describe("Inner decoders", () => {
 });
 
 describe("Large, nested decoder", () => {
+  [@ocaml.warning "-3"]
   let decodeJob =
     Decode.(
       map4(
@@ -362,18 +363,21 @@ describe("Parse error combinations", () => {
   let objError = Decode.ParseError.(objPure("x", MissingField));
 
   test("combine Val/Val", () =>
+    [@ocaml.warning "-3"]
     expect(Decode.(map2(combine, string, boolean, Sample.jsonNull)))
     |> toEqual(valErr(`ExpectedString, Sample.jsonNull))
   );
 
   test("combine Arr/Val", () =>
+    [@ocaml.warning "-3"]
     expect(
       Decode.(map2(combine, list(boolean), boolean, Sample.jsonArrayString)),
     )
     |> toEqual(Result.error(arrError))
   );
 
   test("combine Obj/Val", () =>
+    [@ocaml.warning "-3"]
     expect(
       Decode.(
         map2(combine, field("x", boolean), boolean, Sample.jsonDictEmpty)