Module Dunolint.Config

type t
val equal : t -> t -> bool
val compare : t -> t -> int
val sexp_of_t : t -> Sexplib0.Sexp.t

This is used by tests for quick debug. To print the config into a file, see to_file_contents.

module V0 : sig ... end
module V1 : sig ... end

Create

val v0 : V0.t -> t
val v1 : V1.t -> t

Save to file

val to_file_contents : t -> generated_by:string -> string

This is the recommended way to create the contents of the config to save to a file via a dune rule. generated_by should be the path to the file that implements the config, and will be mentioned in a header comment at the top with a sentence indicating that the config is generated and should not be edited.

To/from stanzas.

val of_stanzas : Sexplib0.Sexp.t list -> t
val to_stanzas : t -> Sexplib0.Sexp.t list

Private Utils

module Private : sig ... end

Compatibility

We plan on removing this compatibility layer and enforcing the use of the versioned API in the future. This will be done as a gradual and multi steps transition. At the moment we offer both APIs to start experimenting with the specification of configs using the versioned API.

module Skip_subtree : sig ... end
module Rule : sig ... end
module Std : sig ... end
val skip_subtree : t -> Skip_subtree.t option
val rules : t -> Rule.t list
val create : ?skip_subtree:Skip_subtree.t -> ?rules:Rule.t list -> unit -> t