package crs

  1. Overview
  2. Docs
A tool for managing code review comments embedded in source code

Install 

dune-project
 Dependency

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

Authors

  1. M
    Mathieu Barbin

Maintainers

  1. M
    Mathieu Barbin <opensource@mbarbin.org>

Sources

crs-0.0.20250914.tbz
sha256=dad0c46a83ef40da150d8b840b01c66af3b979dfa7c3e17c3edef38aa84b804f
sha512=d7a8b2a34f4a3ddda0eaaa3e4248ec2870f944a5d64782bd73b031637b01e94a378d7534b1c02da739f32343b342ed8e8bf491e6442a3bd7b0e748bd61c58770

doc/crs.crs-parser/Crs_parser/Private/Crs_ignore/Rules/index.html

Module Crs_ignore.RulesSource

This module allows to implement some caching or any other useful utils when dealing with all the .crs-ignore files from the tree at once.

Sourcetype t
Sourceval create : File.t Base.list -> t

After having loaded all ".crs-ignore" files from the repo, you can build a t value from there aggregation. The expectation is that they should all come from the same repo_root or the behavior is unspecified.

Sourceval is_file_ignored : t -> path:Volgo.Vcs.Path_in_repo.t -> Base.bool

This will go from the deeper directory containing the path, and then walking up, until a pattern is found that instruct that this file would be ignored. If no pattern was encountered upon reaching the root of the repository, this returns false.

Sourceval unused_patterns : t -> Base.string Loc.Txt.t Base.list

After having performed is_file_ignored operations, it is possible to use this function to access all located patterns that haven't been used. This is used by a validation command, to trigger some warning inviting the user to clean their crs-ignore config files.