Merge pull request #50 from mbarbin/diagnostic-via-ppx

Serialize to reviewdog via ppx yojson conv

Author: mbarbin

crs-dev.opam

@@ -11,9 +11,10 @@ bug-reports: "https://github.com/mbarbin/crs/issues"
 depends: [
   "dune" {>= "3.17"}
   "ocaml" {>= "5.2"}
-  "ocamlformat" {with-dev-setup & = "0.27.0"}
+  "ocamlformat" {= "0.27.0"}
   "base" {>= "v0.17"}
-  "bisect_ppx" {with-dev-setup & >= "2.8.3"}
+  "base_quickcheck" {>= "v0.17"}
+  "bisect_ppx" {>= "2.8.3"}
   "cmdlang" {>= "0.0.9"}
   "conf-git"
   "conf-hg"
@@ -37,10 +38,12 @@ depends: [
   "ppx_expect" {>= "v0.17"}
   "ppx_hash" {>= "v0.17"}
   "ppx_here" {>= "v0.17"}
-  "ppx_js_style" {with-dev-setup & >= "v0.17"}
+  "ppx_js_style" {>= "v0.17"}
   "ppx_let" {>= "v0.17"}
   "ppx_sexp_conv" {>= "v0.17"}
   "ppx_sexp_value" {>= "v0.17"}
+  "ppx_yojson_conv" {>= "v0.17"}
+  "ppx_yojson_conv_lib" {>= "v0.17"}
   "ppxlib" {>= "0.33"}
   "re" {>= "1.12.0"}
   "spawn" {>= "v0.17"}

crs-tests.opam

@@ -12,6 +12,7 @@ depends: [
   "ocaml" {>= "5.2"}
   "ocamlformat" {= "0.27.0"}
   "base" {>= "v0.17"}
+  "base_quickcheck" {>= "v0.17"}
   "cmdlang" {>= "0.0.9"}
   "cmdlang-stdlib-runner" {>= "0.0.9"}
   "conf-git"
@@ -38,6 +39,8 @@ depends: [
   "ppx_let" {>= "v0.17"}
   "ppx_sexp_conv" {>= "v0.17"}
   "ppx_sexp_value" {>= "v0.17"}
+  "ppx_yojson_conv" {>= "v0.17"}
+  "ppx_yojson_conv_lib" {>= "v0.17"}
   "ppxlib" {>= "0.33"}
   "printbox" {>= "0.12"}
   "printbox-md" {>= "0.12"}

crs.opam

@@ -17,8 +17,6 @@ depends: [
   "fpath-base" {>= "0.3.1"}
   "loc" {>= "0.2.2"}
   "pageantty" {>= "0.0.2"}
-  "pbrt" {>= "3.1"}
-  "pbrt_yojson" {>= "3.1"}
   "pp" {>= "2.0.0"}
   "pplumbing" {>= "0.0.14"}
   "ppx_compare" {>= "v0.17"}

dune-project

@@ -42,10 +42,6 @@
    (>= 0.2.2))
   (pageantty
    (>= 0.0.2))
-  (pbrt
-   (>= 3.1))
-  (pbrt_yojson
-   (>= 3.1))
   (pp
    (>= 2.0.0))
   (pplumbing
@@ -95,6 +91,8 @@
    (= 0.27.0))
   (base
    (>= v0.17))
+  (base_quickcheck
+   (>= v0.17))
   (cmdlang
    (>= 0.0.9))
   (cmdlang-stdlib-runner
@@ -147,6 +145,10 @@
    (>= v0.17))
   (ppx_sexp_value
    (>= v0.17))
+  (ppx_yojson_conv
+   (>= v0.17))
+  (ppx_yojson_conv_lib
+   (>= v0.17))
   (ppxlib
    (>= 0.33))
   (printbox
@@ -189,15 +191,13 @@
   (ocaml
    (>= 5.2))
   (ocamlformat
-   (and
-    :with-dev-setup
-    (= 0.27.0)))
+   (= 0.27.0))
   (base
    (>= v0.17))
+  (base_quickcheck
+   (>= v0.17))
   (bisect_ppx
-   (and
-    :with-dev-setup
-    (>= 2.8.3)))
+   (>= 2.8.3))
   (cmdlang
    (>= 0.0.9))
   conf-git
@@ -243,15 +243,17 @@
   (ppx_here
    (>= v0.17))
   (ppx_js_style
-   (and
-    :with-dev-setup
-    (>= v0.17)))
+   (>= v0.17))
   (ppx_let
    (>= v0.17))
   (ppx_sexp_conv
    (>= v0.17))
   (ppx_sexp_value
    (>= v0.17))
+  (ppx_yojson_conv
+   (>= v0.17))
+  (ppx_yojson_conv_lib
+   (>= v0.17))
   (ppxlib
    (>= 0.33))
   (re

lib/crs_cli/src/annotation.ml

@@ -38,7 +38,7 @@ module Severity = struct
     | Info -> Notice
   ;;
 
-  let to_reviewdog : t -> Reviewdog_rdf.severity = function
+  let to_reviewdog : t -> Reviewdog.Severity.t = function
     | Error -> Error
     | Warning -> Warning
     | Info -> Info
@@ -117,13 +117,14 @@ let to_github_annotation t : Github_annotation.t =
     ~message:t.message
 ;;
 
-let to_reviewdog_diagnostic t : Reviewdog_rdf.diagnostic =
-  Reviewdog_rdf.make_diagnostic
-    ~message:t.message
-    ~location:(Cr_comment.whole_loc t.cr |> Reviewdog_utils.make_location |> Option.some)
-    ~severity:(Severity.to_reviewdog t.severity)
-    ~suggestions:[]
-    ~original_output:(Cr_comment.reindented_content t.cr)
-    ~related_locations:[]
-    ()
+let to_reviewdog_diagnostic t : Reviewdog.Diagnostic.t =
+  { Reviewdog.Diagnostic.message = t.message
+  ; location = Cr_comment.whole_loc t.cr |> Reviewdog_utils.make_location
+  ; severity = Some (Severity.to_reviewdog t.severity)
+  ; source = None
+  ; code = None
+  ; suggestions = None
+  ; original_output = Some (Cr_comment.reindented_content t.cr)
+  ; related_locations = None
+  }
 ;;

lib/crs_cli/src/annotation.mli

@@ -36,7 +36,7 @@ module Severity : sig
   val to_string : t -> string
 
   val to_github : t -> Github_annotation.Severity.t
-  val to_reviewdog : t -> Reviewdog_rdf.severity
+  val to_reviewdog : t -> Reviewdog.Severity.t
 end
 
 type t [@@deriving sexp_of]
@@ -69,4 +69,4 @@ val with_user_mention : t -> bool
 (** Export to supported consumers / backend. *)
 
 val to_github_annotation : t -> Github_annotation.t
-val to_reviewdog_diagnostic : t -> Reviewdog_rdf.diagnostic
+val to_reviewdog_diagnostic : t -> Reviewdog.Diagnostic.t

lib/crs_cli/src/cmd__tools__reviewdog__annotate_crs.ml

@@ -49,13 +49,12 @@ This command searches for CRs in the tree and prints Reviewdog Annotations for t
          |> Option.map ~f:Annotation.to_reviewdog_diagnostic)
      in
      let diagnostic_result =
-       Reviewdog_rdf.make_diagnostic_result
-         ~diagnostics
-         ~source:(Some Reviewdog_utils.source)
-         ~severity:Info
-         ()
+       { Reviewdog.Diagnostic_result.source = Some Reviewdog_utils.source
+       ; severity = Some Info
+       ; diagnostics
+       }
      in
-     let json = Reviewdog_rdf.encode_json_diagnostic_result diagnostic_result in
-     print_endline (Yojson.Basic.pretty_to_string ~std:true json);
+     let json = Reviewdog.Diagnostic_result.yojson_of_t diagnostic_result in
+     print_endline (Yojson.Safe.pretty_to_string ~std:true json);
      ())
 ;;

lib/crs_cli/src/dune

@@ -30,7 +30,7 @@
   pp
   pplumbing.err
   pplumbing.pp-tty
-  reviewdog_rdf
+  reviewdog
   stdio
   text_table
   unix

lib/crs_cli/src/reviewdog_utils.ml

@@ -19,20 +19,18 @@
 (*  <http://www.gnu.org/licenses/> and <https://spdx.org>, respectively.        *)
 (********************************************************************************)
 
-let source : Reviewdog_rdf.source =
-  { name = "crs"; url = "https://github.com/mbarbin/crs" }
+let source : Reviewdog.Source.t =
+  { name = "crs"; url = Some "https://github.com/mbarbin/crs" }
 ;;
 
 let make_position (pos : Lexing.position) =
-  let line = Int32.of_int_exn pos.pos_lnum in
-  let column = Int32.of_int_exn (pos.pos_cnum - pos.pos_bol + 1) in
-  Reviewdog_rdf.make_position ~line ~column ()
+  { Reviewdog.Position.line = pos.pos_lnum; column = pos.pos_cnum - pos.pos_bol + 1 }
 ;;
 
 let make_location (loc : Loc.t) =
   let path = Fpath.to_string (Loc.path loc) in
   let start_pos = Loc.start loc |> make_position in
   let end_pos = Loc.stop loc |> make_position in
-  let range = Reviewdog_rdf.make_range ~start:(Some start_pos) ~end_:(Some end_pos) () in
-  Reviewdog_rdf.make_location ~path ~range:(Some range) ()
+  let range = { Reviewdog.Range.start = start_pos; end_ = Some end_pos } in
+  { Reviewdog.Location.path; range = Some range }
 ;;

lib/crs_cli/src/reviewdog_utils.mli

@@ -19,5 +19,5 @@
 (*_  <http://www.gnu.org/licenses/> and <https://spdx.org>, respectively.        *)
 (*_*******************************************************************************)
 
-val source : Reviewdog_rdf.source
-val make_location : Loc.t -> Reviewdog_rdf.location
+val source : Reviewdog.Source.t
+val make_location : Loc.t -> Reviewdog.Location.t