package crs

  1. Overview
  2. Docs
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-parser/Crs_parser/Private/Std/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 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 -> 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 -> string Loc.Txt.t 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.