package dunolint

You can search for identifiers within the package.

in-package search v0.2.0

A linter for build files in dune projects

Install

Dune Dependency

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

Authors

M

Mathieu Barbin

Maintainers

M

Mathieu Barbin <opensource@mbarbin.org>

Sources

dunolint-0.0.20250310.tbz

sha256=b44119c96aeabb960e852711c2f20ae43f0011e796f05e012141ba980a5b58f6

sha512=5bf76732adc940db6cac0875e94c3eaff436288faba95388b9675c68b3f30f5362e01f289fc8a096325f7db812ace273773a1e051ab7d7ace3b8db4a57a0e070

doc/dunolint.dune_linter/Dune_linter/Flags/index.html

Module `Dune_linter.Flags`Source

The "flags" to be passed to OCaml.

Sourcetype t

Sourceval create : flags:Sexplib0.Sexp.t Base.list -> t

At the moment there is not predicate nor enforceable conditions on flags. TBD.

include Dunolinter.Stanza_linter.S
  with type t := t
   and type predicate := Base.Nothing.t

Sourceval sexp_of_t : t -> Sexplib0.Sexp.t

Sourceval field_name : Base.string

Sourceval read : sexps_rewriter:Sexps_rewriter.t -> field:Base.Sexp.t -> t

If the stanza already exists, parse the value currently present. The sexps_rewriter is given in order to find locations of the supplied sexp to supply to the error messages. Errors are raised if the arguments do not have the expected shape for that field.

Sourceval write : t -> Base.Sexp.t

Write as a new field. This is used to create the field the first time it is introduced in a stanza, such as when a new dune file is created by dunolint.

Source

val rewrite : 
  t ->
  sexps_rewriter:Sexps_rewriter.t ->
  field:Base.Sexp.t ->
  Base.unit

When the field is already present, it may be necessary to merge the existing values with the expected one. In this case we do not write the field from scratch, instead we refactor it using a rewrite. The field sexp is expected to be taken from the sexps_rewriter and must be the original sexp that represent the entire field.

If the stanza already exists, all we do is some linting, that is we update it if needed, and perhaps generating some errors or warnings along the way. To be called with the sexps that follow the "(library)" atom, which are labeled "fields".

This has the effect of side-effecting the File_rewriter that is contained by the sexps_rewriter parameter. For this call to be useful, it is assumed that the caller is going to output the resulting rewrite, and do something with it. The field sexp is expected to be taken from the sexps_rewriter and must be the original sexp that represent the entire field.

Sourceval eval : t -> predicate:Base.Nothing.t -> Dunolint.Trilang.t

Sourceval enforce : t -> condition:Base.Nothing.t Dunolint.Std.Blang.t -> Base.unit

Getters

Sourceval is_empty : t -> Base.bool

Sourceval flags : t -> Sexplib0.Sexp.t Base.list

Setters

Sourceval set_flags : t -> flags:Sexplib0.Sexp.t Base.list -> Base.unit

On This Page

Getters
Setters