package crs

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

Install 

dune-project
 Dependency

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

Authors

  1. M
    Mathieu Barbin

Maintainers

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

Sources

crs-0.0.20260307.tbz
sha256=77f77c61e908a6716fa876f5648f662ffaf7e24be4a7889fd6b53121592311bb
sha512=5fc6252650571c4127ebb1e61fecf78c5d4ce35e2832dff47125cda1448e07ea6d4da5e3a9a28643e3491d3594b0ee8857214241f98bd0296ada2c35ea8daa4b

doc/src/crs.crs-cli/assignee.ml.html

Source file assignee.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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
(********************************************************************************)
(*  crs - A tool for managing inline review comments embedded in source code    *)
(*  Copyright (C) 2024-2026 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 Raw_assignee = struct
  type t =
    | Not_due_now
    | Invalid
    | Recipient of User_handle.t
    | Reporter of User_handle.t
    | Unaddressed

  let compute ~cr ~config:_ =
    match Cr_comment.priority cr with
    | Soon | Someday -> Not_due_now
    | Now ->
      (match Cr_comment.header cr with
       | Error _ -> Invalid
       | Ok h ->
         (match Cr_comment.Header.status h with
          | XCR -> Reporter (Cr_comment.Header.reporter h)
          | CR ->
            (match Cr_comment.Header.recipient h with
             | Some user -> Recipient user
             | None -> Unaddressed)))
  ;;
end

module Reason = struct
  type t =
    | Not_due_now
    | Recipient
    | Reporter
    | Default_repo_owner
    | No_default_repo_owner
    | Pull_request_author

  let all =
    [ Not_due_now
    ; Recipient
    ; Reporter
    ; Default_repo_owner
    ; No_default_repo_owner
    ; Pull_request_author
    ]
  ;;

  let variant_constructor_name = function
    | Not_due_now -> "Not_due_now"
    | Recipient -> "Recipient"
    | Reporter -> "Reporter"
    | Default_repo_owner -> "Default_repo_owner"
    | No_default_repo_owner -> "No_default_repo_owner"
    | Pull_request_author -> "Pull_request_author"
  ;;

  let to_dyn t = Dyn.Variant (variant_constructor_name t, [])

  let to_string_hum = function
    | Not_due_now -> "CR not due now"
    | Recipient -> "CR recipient"
    | Reporter -> "CR reporter"
    | Default_repo_owner -> "default repo owner"
    | No_default_repo_owner -> "no default repo owner configured"
    | Pull_request_author -> "PR author"
  ;;
end

type t =
  { user : User_handle.t option
  ; reason : Reason.t
  }

let to_dyn { user; reason } =
  Dyn.record
    [ "user", user |> Dyn.option User_handle.to_dyn; "reason", reason |> Reason.to_dyn ]
;;

let of_raw
      ~(raw_assignee : Raw_assignee.t)
      ~(config : Config.t)
      ~(review_mode : Review_mode.t)
  =
  let default =
    match review_mode with
    | Pull_request { author; base = _ } ->
      { user = Some author; reason = Pull_request_author }
    | Revision ->
      (match Config.default_repo_owner config with
       | Some owner -> { user = Some owner; reason = Default_repo_owner }
       | None -> { user = None; reason = No_default_repo_owner })
  in
  match raw_assignee with
  | Not_due_now -> { user = None; reason = Not_due_now }
  | Invalid -> default
  | Recipient recipient -> { user = Some recipient; reason = Recipient }
  | Reporter reporter -> { user = Some reporter; reason = Reporter }
  | Unaddressed -> default
;;

let compute ~cr ~(config : Config.t) ~(review_mode : Review_mode.t) =
  let raw_assignee = Raw_assignee.compute ~cr ~config in
  of_raw ~raw_assignee ~config ~review_mode
;;