package crs
A tool for managing code review comments embedded in source code
Install
Dune Dependency
Authors
Maintainers
Sources
crs-0.0.20250705.tbz
sha256=e9f9f5ec5aea9658ed640aaa06f887985bb6870adcf7555ebf6d48bb741e4793
sha512=901ac1caae6c4103a320b4a3a177ca3aa0583ad533c54e7740aba6652ccdbd6311d07ab4b73e3ba750beed24f85479b5e1b0e94504ecfd0c59bd49cdabebc369
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.