package crs

You can search for identifiers within the package.

in-package search v0.2.0

A tool for managing code review comments embedded in source code

Install

Dune Dependency

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

Authors

M

Mathieu Barbin

Maintainers

M

Mathieu Barbin <opensource@mbarbin.org>

Sources

crs-0.0.20250705.tbz

sha256=e9f9f5ec5aea9658ed640aaa06f887985bb6870adcf7555ebf6d48bb741e4793

sha512=901ac1caae6c4103a320b4a3a177ca3aa0583ad533c54e7740aba6652ccdbd6311d07ab4b73e3ba750beed24f85479b5e1b0e94504ecfd0c59bd49cdabebc369

doc/crs.crs-cli/Crs_cli/Private/Config/index.html

Module `Private.Config`Source

A type to hold declarative values to configure crs commands for a given repository.

The expectations is that certain commands allow for a file to be given as argument to a --config FILE flag, which must contain a serialization of a value of type t.

This particular config is expected to contain repository specific configuration.

We are using JSON5 as serialization format.

Sourcemodule Annotation_severity : sig ... end

Sourcetype t = {

default_repo_owner : Volgo_base.Vcs.User_handle.t Base.option;
user_mentions_whitelist : Volgo_base.Vcs.User_handle.t Base.list Base.option;
invalid_crs_annotation_severity : Annotation_severity.t Base.option;
crs_due_now_annotation_severity : Annotation_severity.t Base.option;

}

default_repo_owner When not in a PR, the default_repo_owner may be used to assigned certain kinds of otherwise not easy to assign to a particular user. For example, invalid CRs when creating CRs annotation for a particular commit outside of a pull request.

If the repository is owned by an individual, this would typically be that user. If the repository is owned by an organization, this may be set to a user in particular who would be assigned otherwise unassignable CRs. If it isn't set, such CRs will simply not be assigned to any one in particular.

user_mentions_whitelist enables a specific list of users to be notified in annotations comments, when notifications is requested. This is a protection measure to avoid spamming users that do not have ties to a repo in particular, or simply do not wish to be notified via CRs.

Sourceval t_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> t

Sourceval sexp_of_t : t -> Sexplib0.Sexp.t

Source

val create : 
  ?default_repo_owner:Volgo_base.Vcs.User_handle.t ->
  ?user_mentions_whitelist:Volgo_base.Vcs.User_handle.t Base.list ->
  ?invalid_crs_annotation_severity:Annotation_severity.t ->
  ?crs_due_now_annotation_severity:Annotation_severity.t ->
  Base.unit ->
  t

Sourceval empty : t

Sourceval load_exn : path:Fpath_base.Fpath.t -> t