package crs

  1. Overview
  2. Docs
On This Page
  1. Utils
  2. Getters
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/crs.crs-cli/Crs_cli/Private/Std/Annotation/index.html

Module Std.AnnotationSource

A type to hold information about a CR that is assigned in the ci event (pull request or push to ongoing branch).

This is used by workflow that integrate with platforms or tools supporting annotations, such as GitHub Annotations, and Reviewdog Diagnostics.

Sourcemodule Severity : sig ... end
Sourcetype t
Sourceval to_dyn : t -> Crs_stdlib.Dyn.t
Sourceval of_cr : cr:Cr_comment.t -> config:Crs_cli__.Config.t -> review_mode:Crs_cli__.Review_mode.t -> with_user_mentions:bool -> t option

When with_user_mentions is true, we prefix user names by '@' in annotations messages. See also write_username.

Utils

Sourceval write_username : user:Cr_comment.Std.User_handle.t -> with_user_mention:bool -> string

When with_user_mention is true we use the syntax '@user' in the annotation message to trigger a notification in the environment that will end up rendering this string. This doesn't always work, even when this is the correct syntax. For example, mentioning a user with '@' in a GitHub Annotations Panels does nothing.

Getters

Sourceval message : t -> string
Sourceval severity : t -> Severity.t
Sourceval assignee : t -> Crs_cli__.Assignee.t
Sourceval with_user_mention : t -> bool

Export to supported consumers / backend.

Sourceval to_reviewdog_diagnostic : t -> Reviewdog.Diagnostic.t