package crs
A tool for managing code review comments embedded in source code
Install
dune-project
Dependency
Authors
Maintainers
Sources
crs-0.0.20250620.tbz
sha256=c9639ddde0d9126acf847a7b27a84db161b2bfbb7d3c69bba88a4fcfe1d3db21
sha512=34cfa8d001b5f8a87bdf3b78c15150f338c99cb575e8c85e6c398381f953727e0a0267c564d757330e28a57a5eedc27cb72681f82833197b17fa8d1c28a2df05
doc/crs.crs-parser/Crs_parser/index.html
Module Crs_parser
Source
Utils for parsing and searching for code review comments (CRs) in versioned source files.
Parsing
Source
val parse_file :
path:Volgo.Vcs.Path_in_repo.t ->
file_contents:Volgo.Vcs.File_contents.t ->
Cr_comment.t Base.list
Parse all code review comments (CRs) from a file. Comments that resemble CRs but are malformed or partially invalid are still returned, with error information in their metadata, so users can be alerted rather than having such comments silently ignored.
Searching
Source
val grep :
vcs:< Volgo.Vcs.Trait.ls_files.. > Volgo.Vcs.t ->
repo_root:Volgo.Vcs.Repo_root.t ->
below:Volgo.Vcs.Path_in_repo.t ->
Cr_comment.t Base.list
Search recursively for all code review comments (CRs) in files versioned under the supplied repo_root
, starting at and below
the given path in the repository. Only files tracked by the version control system are included; untracked or ignored files are skipped. Returns all found CRs.