package crs

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parsing
Searching

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

M

Mathieu Barbin

Maintainers

M

Mathieu Barbin <opensource@mbarbin.org>

Sources

crs-0.0.20260307.tbz

sha256=77f77c61e908a6716fa876f5648f662ffaf7e24be4a7889fd6b53121592311bb

sha512=5fc6252650571c4127ebb1e61fecf78c5d4ce35e2832dff47125cda1448e07ea6d4da5e3a9a28643e3491d3594b0ee8857214241f98bd0296ada2c35ea8daa4b

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 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 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.

Sourcemodule Private : sig ... end