Source file github_annotation.ml

(********************************************************************************)
(*  crs - A tool for managing code review comments embedded in source code      *)
(*  Copyright (C) 2024-2025 Mathieu Barbin <mathieu.barbin@gmail.com>           *)
(*                                                                              *)
(*  This file is part of crs.                                                   *)
(*                                                                              *)
(*  crs is free software; you can redistribute it and/or modify it under the    *)
(*  terms of the GNU Lesser General Public License as published by the Free     *)
(*  Software Foundation either version 3 of the License, or any later version,  *)
(*  with the LGPL-3.0 Linking Exception.                                        *)
(*                                                                              *)
(*  crs is distributed in the hope that it will be useful, but WITHOUT ANY      *)
(*  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS   *)
(*  FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License and     *)
(*  the file `NOTICE.md` at the root of this repository for more details.       *)
(*                                                                              *)
(*  You should have received a copy of the GNU Lesser General Public License    *)
(*  and the LGPL-3.0 Linking Exception along with this library. If not, see     *)
(*  <http://www.gnu.org/licenses/> and <https://spdx.org>, respectively.        *)
(********************************************************************************)

module Severity = struct
  type t =
    | Error
    | Warning
    | Notice
  [@@deriving sexp_of]

  let to_string = function
    | Error -> "error"
    | Warning -> "warning"
    | Notice -> "notice"
  ;;
end

type t =
  { loc : Loc.t
  ; severity : Severity.t
  ; title : string
  ; message : string
  }
[@@deriving sexp_of]

let create ~loc ~severity ~title ~message = { loc; severity; title; message }

let to_loc_fields ~loc =
  let column (pos : Lexing.position) = pos.pos_cnum - pos.pos_bol + 1 in
  let start_pos = Loc.start loc in
  let stop_pos = Loc.stop loc in
  [ "file", Fpath.to_string (Loc.path loc)
  ; "line", Int.to_string start_pos.pos_lnum
  ; "col", Int.to_string (column start_pos)
  ; "endLine", Int.to_string stop_pos.pos_lnum
  ; "endColumn", Int.to_string (column stop_pos)
  ]
;;

let to_string { loc; severity; title; message } =
  let fields = to_loc_fields ~loc @ [ "title", title ] in
  String.concat
    ~sep:""
    [ "::"
    ; Severity.to_string severity
    ; " "
    ; List.map fields ~f:(fun (field, value) -> Printf.sprintf "%s=%s" field value)
      |> String.concat ~sep:","
    ; "::"
    ; message
    ]
;;