Topkg_care_pkg (topkg.Topkg_care

Package

type t

val v : 
  ?name:string ->
  ?version:string ->
  ?delegate:Bos_setup.Cmd.t ->
  ?build_dir:Fpath.t ->
  ?opam:Fpath.t ->
  ?opam_descr:Fpath.t ->
  ?readme:Fpath.t ->
  ?change_log:Fpath.t ->
  ?license:Fpath.t ->
  ?distrib_uri:string ->
  ?distrib_file:Fpath.t ->
  ?publish_msg:string ->
  ?publish_artefacts:[ `Distrib | `Doc | `Alt of string ] list ->
  Fpath.t ->
  t

val pkg_file : t -> Fpath.t

val name : t -> (string, Bos_setup.R.msg) Bos_setup.result

val version : t -> (string, Bos_setup.R.msg) Bos_setup.result

val delegate : t -> (Bos_setup.Cmd.t, Bos_setup.R.msg) Bos_setup.result

val build_dir : t -> (Fpath.t, Bos_setup.R.msg) Bos_setup.result

val opam : t -> (Fpath.t, Bos_setup.R.msg) Bos_setup.result

val opam_field : 
  t ->
  string ->
  (string list option, Bos_setup.R.msg) Bos_setup.result

val opam_field_hd : 
  t ->
  string ->
  (string option, Bos_setup.R.msg) Bos_setup.result

val opam_fields : 
  t ->
  (string list Bos_setup.String.map, Bos_setup.R.msg) Bos_setup.result

val opam_descr : 
  t ->
  (Topkg_care_opam.Descr.t * bool, Bos_setup.R.msg) Bos_setup.result

val readmes : t -> (Fpath.t list, Bos_setup.R.msg) Bos_setup.result

val readme : t -> (Fpath.t, Bos_setup.R.msg) Bos_setup.result

val change_logs : t -> (Fpath.t list, Bos_setup.R.msg) Bos_setup.result

val change_log : t -> (Fpath.t, Bos_setup.R.msg) Bos_setup.result

val licenses : t -> (Fpath.t list, Bos_setup.R.msg) Bos_setup.result

val distrib_uri : ?raw:bool -> t -> (string, Bos_setup.R.msg) Bos_setup.result

val distrib_file : t -> (Fpath.t, Bos_setup.R.msg) Bos_setup.result

val publish_msg : t -> (string, Bos_setup.R.msg) Bos_setup.result

val publish_artefacts : 
  t ->
  ([ `Distrib | `Doc | `Alt of string ] list, Bos_setup.R.msg) Bos_setup.result

Test

val test : 
  t ->
  dir:Fpath.t ->
  args:Bos_setup.Cmd.t ->
  out:(Bos_setup.OS.Cmd.run_out -> ('a, Bos_setup.R.msg) Bos_setup.result) ->
  ('a, Bos_setup.R.msg) Bos_setup.result

Build

val build : 
  t ->
  dir:Fpath.t ->
  args:Bos_setup.Cmd.t ->
  out:(Bos_setup.OS.Cmd.run_out -> ('a, Bos_setup.R.msg) Bos_setup.result) ->
  ('a, Bos_setup.R.msg) Bos_setup.result

Clean

val clean : 
  t ->
  dir:Fpath.t ->
  args:Bos_setup.Cmd.t ->
  out:(Bos_setup.OS.Cmd.run_out -> ('a, Bos_setup.R.msg) Bos_setup.result) ->
  ('a, Bos_setup.R.msg) Bos_setup.result

Distrib

val distrib_filename : 
  ?opam:bool ->
  t ->
  (Fpath.t, Bos_setup.R.msg) Bos_setup.result

val distrib_archive : 
  t ->
  keep_dir:bool ->
  (Fpath.t, Bos_setup.R.msg) Bos_setup.result

Lint

type lint = [

| `Custom
| `Std_files
| `Meta
| `Opam
| `Deps

]

val lint_all : lint list

val lint : 
  ?ignore_pkg:bool ->
  t ->
  dir:Fpath.t ->
  lint list ->
  (int, Bos_setup.R.msg) Bos_setup.result