package spin

  1. Overview
  2. Docs

Module Spin.TemplateSource

Sourcetype source =
  1. | Git of string
  2. | Local_dir of string
  3. | Official of (module Spin_template.Template)
Sourcetype example_command = {
  1. name : string;
  2. description : string;
}
Sourcetype t = {
  1. name : string;
  2. description : string;
  3. raw_files : string list;
  4. parse_binaries : bool;
  5. files : (string, string) Spin_std.Hashtbl.t;
  6. context : (string, string) Spin_std.Hashtbl.t;
  7. pre_gen_actions : Template_actions.t list;
  8. post_gen_actions : Template_actions.t list;
  9. example_commands : example_command list;
  10. source : source;
}
Sourceval source_of_string : string -> source Option.t
Sourceval source_of_dec : Dec_common.Source.t -> (source, string) Spin_std.Result.t
Sourceval source_to_dec : source -> Dec_common.Source.t
Sourceval read_source_spin_file : ?download_git:bool -> source -> (Dec_template.t, Spin_error.t) Spin_std.Result.t
Sourceval read_source_template_files : ?download_git:bool -> source -> ((string, string) Spin_std.Hashtbl.t, Spin_error.t) Spin_std.Result.t
Sourceval read : ?use_defaults:bool -> ?context:(string, string) Spin_std.Hashtbl.t -> source -> (t, Spin_error.t) Spin_std.Result.t
Sourceval generate : path:string -> t -> (unit, Spin_error.t) Spin_std.Result.t