package crs

  1. Overview
  2. Docs
A tool for managing code review comments embedded in source code

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (3)

Authors

  1. M
    Mathieu Barbin

Maintainers

  1. M
    Mathieu Barbin <opensource@mbarbin.org>

Sources

crs-0.0.20250914.tbz
sha256=dad0c46a83ef40da150d8b840b01c66af3b979dfa7c3e17c3edef38aa84b804f
sha512=d7a8b2a34f4a3ddda0eaaa3e4248ec2870f944a5d64782bd73b031637b01e94a378d7534b1c02da739f32343b342ed8e8bf491e6442a3bd7b0e748bd61c58770

doc/src/crs.crs-parser/user_message.ml.html

Source file user_message.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
(********************************************************************************)
(*  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.        *)
(********************************************************************************)

let pp_to_string pp =
  let buffer = Buffer.create 23 in
  let formatter = Stdlib.Format.formatter_of_buffer buffer in
  Stdlib.Format.fprintf formatter "%a%!" Pp.to_fmt pp;
  let contents =
    Buffer.contents buffer
    |> String.split_lines
    |> List.map ~f:(fun s -> String.rstrip s ^ "\n")
    |> String.concat
  in
  contents
;;

let emit_github_annotation ~severity ~loc ~messages ~hints =
  let message_text = String.concat ~sep:"" (List.map messages ~f:pp_to_string) in
  let hints_text =
    match hints with
    | None -> ""
    | Some hints -> "Hints: " ^ String.concat ~sep:" " (List.map hints ~f:pp_to_string)
  in
  let github_annotation =
    Github_annotation.create
      ~loc:(Option.value loc ~default:Loc.none)
      ~severity
      ~title:"crs"
      ~message:(String.strip (message_text ^ hints_text))
  in
  prerr_endline (Github_annotation.to_string github_annotation)
;;

let warning ?loc ~emit_github_annotations ?hints messages =
  Err.warning ?loc ?hints messages;
  if emit_github_annotations
  then emit_github_annotation ~severity:Warning ~loc ~messages ~hints
;;

let error ?loc ~emit_github_annotations ?hints messages =
  Err.error ?loc ?hints messages;
  if emit_github_annotations
  then emit_github_annotation ~severity:Error ~loc ~messages ~hints
;;