package spin

You can search for identifiers within the package.

in-package search v0.2.0

package spin

spin
- Spin
  - Config
  - Dec_common
    
    Git_repo
    
    Errors
    
    Make_valid_string
    
    Errors
    
    M
    
    Source
    
    Template_name
    
    Errors
  - Dec_project
    
    Config
    
    Errors
  - Dec_template
    
    Actions
    
    Base_template
    
    Errors
    
    Configuration
    
    Description
    
    Example_command
    
    Example_commands
    
    Expr
    
    Ignore_rule
    
    Parse_binaries
    
    Raw_files
  - Dec_user_config
  - Decoder
    
    Infix
    
    Syntax
  - Encoder
  - File_generator
  - Git_template
  - Helpers
  - Local_template
  - Official_template
  - Pp
  - Refmt
  - Spawn
  - Spin_error
  - Template
  - Template_actions
  - Template_configuration
  - Template_expr
  - User_config
spin.ansi
- Ansi
spin.inquire
- Inquire
  - Style
spin.std
- Spin_std
  - Filename
  - Glob
  - Hashtbl
  - List
  - Result
    
    List
    
    Syntax
  - Spawn
  - String
  - Sys
spin.template
- Spin_template
  - Template

Legend:
Library
Module
Module type
Parameter
Class
Class type

type source =

| Git of string
| Local_dir of string
| Official of (module Spin_template.Template)

type example_command = {

name : string;
description : string;

}

type t = {

name : string;
description : string;
raw_files : string list;
parse_binaries : bool;
files : (string, string) Spin_std.Hashtbl.t;
context : (string, string) Spin_std.Hashtbl.t;
pre_gen_actions : Template_actions.t list;
post_gen_actions : Template_actions.t list;
example_commands : example_command list;
source : source;

}

val source_of_string : string -> source Stdlib.Option.t

val source_of_dec : Dec_common.Source.t -> (source, string) Spin_std.Result.t

val source_to_dec : source -> Dec_common.Source.t

val read_source_spin_file : 
  ?download_git:bool ->
  source ->
  (Dec_template.t, Spin_error.t) Spin_std.Result.t

val read_source_template_files : 
  ?download_git:bool ->
  source ->
  ((string, string) Spin_std.Hashtbl.t, Spin_error.t) Spin_std.Result.t

val of_dec : 
  ?use_defaults:bool ->
  ?files:(string, string) Spin_std.Hashtbl.t ->
  ?ignore_configs:bool ->
  ?ignore_actions:bool ->
  ?ignore_example_commands:bool ->
  source:source ->
  context:(string, string) Spin_std.Hashtbl.t ->
  Dec_template.t ->
  (t, Spin_error.t) Spin_std.Result.t

val read : 
  ?use_defaults:bool ->
  ?ignore_configs:bool ->
  ?ignore_actions:bool ->
  ?ignore_example_commands:bool ->
  ?context:(string, string) Spin_std.Hashtbl.t ->
  source ->
  (t, Spin_error.t) Spin_std.Result.t

val generate : path:string -> t -> (unit, Spin_error.t) Spin_std.Result.t