package dunolint

  1. Overview
  2. Docs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module DunolinterSource

Sourcemodule Handler : sig ... end

A handler for evaluating and enforcing predicates.

Sourcemodule Linter : sig ... end
Sourcemodule Linters : sig ... end

A data structure to hold linters with a binary search lookup based on field name.

Sourcemodule Sexp_handler : sig ... end

A handler for fields found in a dune stanza (in files "dune", "dune-project", etc.)

Sourcemodule Stanza_linter : sig ... end
Sourcemodule Stanza : sig ... end
Sourcemodule type S = sig ... end

A linter for a file containing stanzas.

Returns the path of the file where the stanza was located when it was loaded.

Sourceval linter : _ Stanza.t -> Linter.t

Stanzas that do not have support for predicate enforcement shall be ignored when using this interface, they will be left untouched by dunolint.

Sourceval match_stanza : 'a Stanza.t -> 'a

If you are writing a custom rewriter perhaps perhaps you'll find it easier to use directly the stanza API provided by a linter library, in which case you'll need this accessor. In this use of the library, you perform side effects to 'a directly using the linter api, rather than going through the enforcement of configurable conditions.

Sourceval original_sexp : _ Stanza.t -> Base.Sexp.t

That is the sexp that correspond to the entire stanza held by this rewriter. These are the sexps found at the top level of dune files, for example (library ..) or (executable ..).

This accessor is provided if you desire to implement a low-level rewriter using Sexps_rewriter.

Sourceval sexps_rewriter : _ Stanza.t -> Sexps_rewriter.t

That is the Sexps_rewriter that was created to read the stanza held by this rewriter.

Sourcemodule Private : sig ... end
OCaml

Innovation. Community. Security.