document mli files

lib/ast.mli

@@ -1,3 +1,4 @@
+(* ReadConstant reads a const value, like `export const banana: Fruit = Fruit.Banana` *)
 module ReadConstant : sig
   type t =
     { var : string
@@ -9,6 +10,7 @@ module ReadConstant : sig
   val to_string : t -> string
 end
 
+(* ReadVariable reads a mutable value, like `export let apple: Fruit = Fruit.Apple` *)
 module ReadVariable : sig
   type t =
     { var : string
@@ -20,6 +22,7 @@ module ReadVariable : sig
   val to_string : t -> string
 end
 
+(* ReadSpreadsheet reads an interface and rows from a spreadsheet at a given path *)
 module ReadSpreadsheet : sig
   type t =
     { var : string
@@ -32,6 +35,7 @@ module ReadSpreadsheet : sig
   val to_string : t -> string
 end
 
+(* Import imports modules from external ts files, but does not do any type checking *)
 module Import : sig
   type t =
     { var : Variable.T.t
@@ -43,6 +47,7 @@ module Import : sig
   val to_string : t -> string
 end
 
+(* Export exports everything to either stdout or some file, or some other source *)
 module Export : sig
   type t =
     | File of string
@@ -53,6 +58,7 @@ module Export : sig
   val to_string : t -> string
 end
 
+(* Node is a node in the AST tree *)
 module Node : sig
   type t =
     | ReadConstant of ReadConstant.t

lib/entry.mli

@@ -1 +1,2 @@
+(* Entry point to the entire program, put into a separate file to avoid dependency cycles *)
 val entry_point : string -> unit

lib/header.mli

@@ -1,3 +1,4 @@
+(* A header of a CSV column, wrapped with sexp decoding *)
 module T : sig
   type t =
     | Enum of string * string (* (type * name) *)
@@ -15,12 +16,14 @@ module T : sig
   val get_string : t -> string
 end
 
+(* A header parsing wrapper *)
 module Parser : sig
   val parse : string -> T.t
   val parse_all : string list -> T.t list
   val check_duplicates : T.t list -> unit
 end
 
+(* A list of headers for a CSV *)
 type t = T.t list
 
 val t_of_sexp : Sexplib0.Sexp.t -> t

lib/import.ml

@@ -1,3 +1,5 @@
 module T = struct
+  type t = string * Variable.T.t
+
   let to_string (var, from) = Printf.sprintf "import { %s } from \"%s\";" var from
 end

lib/import.mli

@@ -1,3 +1,6 @@
+(* Represents a module imported from some file *)
 module T : sig
-  val to_string : string * Variable.T.t -> string
+  type t = string * Variable.T.t
+
+  val to_string : t -> string
 end

lib/interpreter.mli

@@ -1,3 +1,4 @@
+(* Represents a stateful interpreter that stores everything in hash maps *)
 module T : sig
   type state =
     { variable_store : Literal.T.v Store.T.t
@@ -8,5 +9,7 @@ module T : sig
 
   val interpret_node : state -> Ast.Node.t -> unit
   val create_blank_state : unit -> state
+
+  (* Entry point to the module, and interprets nodes using List.iter *)
   val interpret : Program.T.t -> unit
 end

lib/io.mli

@@ -1,3 +1,4 @@
+(* Some useful file system utils *)
 module Files : sig
   val get_absolute_file_path : string -> string
   val is_valid_path : string -> bool

lib/literal.mli

@@ -1,11 +1,14 @@
+(* Represents a literal value in const/let statements *)
 module T : sig
+  (* The actual value. Enum contains the actual enum type, while everything else only contains value. *)
   type t =
     | Enum of string * string
     | String of string
     | Integer of int
     | Float of float
     | Boolean of bool
 
+  (* Represents whether is const or let *)
   type v =
     | Constant of t
     | Mutable of t

lib/program.mli

@@ -1,3 +1,4 @@
+(* Represents a program linked list of AST nodes. Type t can be extended with a program counter, but it doesn't really serve a purpose other than being a wrapper. *)
 module T : sig
   type ast = Ast.Node.t list
 

lib/record.mli

@@ -1,3 +1,4 @@
+(* A single record in a spreadsheet. For the most part identical to Literal, but by no means the same. *)
 module Value : sig
   type record_type =
     | Enum of string
@@ -18,6 +19,7 @@ module Value : sig
   val to_json : t -> string
 end
 
+(* A spreadsheet row, i.e a list of Record.Value.t *)
 module T : sig
   type t = Value.t list
 

lib/spreadsheet.mli

@@ -1,10 +1,12 @@
+(* A path to a spreadsheet, typed to support future extension *)
 module Path : sig
   type t = Csv of string
 
   val t_of_sexp : Sexplib0.Sexp.t -> t
   val sexp_of_t : t -> Sexplib0.Sexp.t
 end
 
+(* The CSV spreadsheet module *)
 module Csv0 : sig
   type t =
     { headers : Header.T.t list
@@ -22,8 +24,10 @@ module Csv0 : sig
   val get_interface : string -> t -> string
 end
 
+(* Variant that can support other spreadsheets too *)
 type t = Csv of Csv0.u
 
+(* Writes any spreadsheet to string *)
 module Writer : sig
   val to_string : string * t -> string
 end

lib/store.mli

@@ -1,3 +1,4 @@
+(* A generalised Hashtbl.t backed store for various types, like variables and spreadsheets *)
 module T : sig
   type 'a t = { data : (string, 'a) Hashtbl.t }
 

lib/util.mli

@@ -1,3 +1,4 @@
+(* Some generic utils *)
 module T : sig
   val is_not_space : char -> bool
   val quote : string -> string

lib/variable.mli

@@ -1,12 +1,15 @@
+(* Checks if a variable name is a reserved keyword *)
 module Keywords : sig
   val keywords_list : string list
   val is_keyword : string -> bool
 end
 
+(* Checks if a variable name is a valid variable name *)
 module ValidName : sig
   val check : string -> bool
 end
 
+(* Wraps variables, which are just strings, as sexps and around some useful helpers *)
 module T : sig
   type t = string [@@deriving sexp]
 

test/expect_tests/cases/enum_program_test.sexp

@@ -1,5 +1,6 @@
 (
 	(Import ((var Something) (from some-file.ts)))
+	(ReadConstant ((var apple) (value (Enum Fruit Apple))))
 	(ReadSpreadsheet ((var "SOME_SHEET") (interface "Type") (path (Csv "./data/sample_spreadsheet_enums.csv"))))
 	(Export Stdout)
 )

test/expect_tests/end_to_end_program_tests.ml

@@ -33,7 +33,7 @@ let%expect_test "passes enums end to end test" =
   [%expect
     {|
     import { Something } from "some-file.ts";
-
+    export const apple: Fruit = Apple;
 
     export interface Type {
     a: Something;