package opam-state

  1. Overview
  2. Docs

Module OpamFileToolsSource

Tools for manipulating and checking package definition ("opam") files

Sourceval template : OpamTypes.package -> OpamFile.OPAM.t

Create an OPAM package template filled with common options

Sourceval lint : ?check_extra_files:(OpamTypes.basename * (OpamHash.t -> bool)) list -> ?check_upstream:bool -> OpamFile.OPAM.t -> (int * [ `Warning | `Error ] * string) list

Runs several sanity checks on the opam file; returns a list of warnings. `Error level should be considered unfit for publication, while `Warning are advisory but may be accepted. The int is an identifier for this specific warning/error. If check_extra_files is unspecified, warning 53 won't be checked.

Sourceval lint_file : ?check_extra_files:(OpamTypes.basename * (OpamHash.t -> bool)) list -> ?check_upstream:bool -> OpamFile.OPAM.t OpamFile.typed_file -> (int * [ `Warning | `Error ] * string) list * OpamFile.OPAM.t option

Same as lint, but operates on a file, which allows catching parse errors too. You can specify an expected name and version. check_extra_files defaults to a function that will look for a files/ directory besides filename

Sourceval lint_channel : ?check_extra_files:(OpamTypes.basename * (OpamHash.t -> bool)) list -> ?check_upstream:bool -> OpamFile.OPAM.t OpamFile.typed_file -> in_channel -> (int * [ `Warning | `Error ] * string) list * OpamFile.OPAM.t option

Same as lint_file, but taking input from a channel. check_extra_files defaults to a function that will look for a files/ directory besides filename

Sourceval lint_string : ?check_extra_files:(OpamTypes.basename * (OpamHash.t -> bool)) list -> ?check_upstream:bool -> OpamFile.OPAM.t OpamFile.typed_file -> string -> (int * [ `Warning | `Error ] * string) list * OpamFile.OPAM.t option

Like lint_file, but takes the file contents as a string. check_extra_files defaults to a function that will look for a files/ directory besides filename

Sourceval warns_to_string : (int * [ `Warning | `Error ] * string) list -> string

Utility function to print validation results

Sourceval read_opam : OpamTypes.dirname -> OpamFile.OPAM.t option

Read the opam metadata from a given directory (opam file, with possible overrides from url and descr files). Also includes the names and hashes of files below files/

Sourceval add_aux_files : ?dir:OpamTypes.dirname -> files_subdir_hashes:bool -> OpamFile.OPAM.t -> OpamFile.OPAM.t

Adds data from 'url' and 'descr' files found in the specified dir or the opam file's metadata dir, if not already present in the opam file. if files_subdir_hashes is true, also adds the names and hashes of files found below 'files/'

Sourceval map_all_variables : (OpamTypes.full_variable -> OpamTypes.full_variable) -> OpamFile.OPAM.t -> OpamFile.OPAM.t

Tools to manipulate the OpamFile.OPAM.t contents

Sourceval map_all_filters : (OpamTypes.filter -> OpamTypes.filter) -> OpamFile.OPAM.t -> OpamFile.OPAM.t