✨ Config file support

Author: MystPi

gleam.toml

@@ -21,6 +21,7 @@ glam = ">= 2.0.0 and < 3.0.0"
 dedent = ">= 1.0.0 and < 2.0.0"
 filepath = ">= 1.0.0 and < 2.0.0"
 simplifile = ">= 1.7.0 and < 2.0.0"
+tom = ">= 0.3.0 and < 1.0.0"
 
 [dev-dependencies]
 gleeunit = "~> 1.0"

manifest.toml

@@ -15,6 +15,7 @@ packages = [
   { name = "pprint", version = "1.0.2", build_tools = ["gleam"], requirements = ["glam", "gleam_stdlib"], otp_app = "pprint", source = "hex", outer_checksum = "3EB2A7A8F72322F73EEF342374D0354AE39E7F9C64678B960BE8B2DC1B564AE1" },
   { name = "simplifile", version = "1.7.0", build_tools = ["gleam"], requirements = ["filepath", "gleam_stdlib"], otp_app = "simplifile", source = "hex", outer_checksum = "1D5DFA3A2F9319EC85825F6ED88B8E449F381B0D55A62F5E61424E748E7DDEB0" },
   { name = "thoas", version = "1.2.0", build_tools = ["rebar3"], requirements = [], otp_app = "thoas", source = "hex", outer_checksum = "540C8CB7D9257F2AD0A14145DC23560F91ACDCA995F0CCBA779EB33AF5D859D1" },
+  { name = "tom", version = "0.3.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "tom", source = "hex", outer_checksum = "0831C73E45405A2153091226BF98FB485ED16376988602CC01A5FD086B82D577" },
 ]
 
 [requirements]
@@ -28,3 +29,4 @@ gleeunit = { version = "~> 1.0" }
 hug = { version = "~> 1.0" }
 pprint = { version = "~> 1.0" }
 simplifile = { version = ">= 1.7.0 and < 2.0.0" }
+tom = { version = ">= 0.3.0 and < 1.0.0"}

src/spark.gleam

@@ -2,13 +2,13 @@ import filepath
 import gleam/io
 import gleam/result.{try}
 import gleam/string
+import gleam_community/ansi
 import spark/file
 import spark/project
-import gleam_community/ansi
 
 pub fn main() {
   let result = {
-    use project <- try(project.from("TestProject", "examples/TestProject"))
+    use project <- try(project.from("examples/TestProject"))
     build(project)
   }
 
@@ -24,15 +24,16 @@ fn build(project: project.Project) -> Result(Nil, String) {
   let build_dir = filepath.join(project.dir, "build")
 
   report("Compiling", "Spark")
-  use template <- try(project.from("Spark", "./templates"))
+  use template <- try(project.from("./templates"))
   use _ <- try(project.compile(template, to: build_dir))
 
-  report("Compiling", project.name)
+  report("Compiling", project.config.name)
   use _ <- try(project.compile(project, to: build_dir))
 
   report("Creating", "index file")
   let path = filepath.join(project.dir, "build/index.mjs")
-  let contents = "import { main } from './" <> project.name <> ".mjs';\nmain();"
+  let contents =
+    "import { main } from './" <> project.config.name <> ".mjs';\nmain();"
   use _ <- try(file.write_all(path, contents))
 
   report("Compiled", "successfully")

src/spark/error.gleam

@@ -87,3 +87,7 @@ fn parse_error_to_string(error, pos: Span, ctx_stack) {
 
   #("syntax error" <> ctx, hint, pos)
 }
+
+pub fn simple_error(message: String) -> String {
+  ansi.red("error") <> ansi.dim(": ") <> ansi.bold(message)
+}

src/spark/file.gleam

@@ -1,7 +1,7 @@
 import filepath
 import gleam/result.{try}
-import gleam_community/ansi
 import simplifile
+import spark/error
 
 /// Write a file, creating directories as needed.
 ///
@@ -37,5 +37,5 @@ pub fn get_files(dir: String) -> Result(List(String), String) {
 }
 
 fn file_error(message, path) -> String {
-  ansi.red("I was unable to " <> message <> ": ") <> path
+  error.simple_error("I was unable to " <> message <> ": " <> path)
 }

src/spark/project.gleam

@@ -9,20 +9,37 @@ import spark/lex
 import spark/module.{type Module}
 import spark/parse
 import spark/util
+import tom
 
 // ---- TYPES ------------------------------------------------------------------
 
 pub type Project {
-  Project(name: String, modules: List(Module), extra_files: List(String), dir: String)
+  Project(
+    config: Config,
+    modules: List(Module),
+    extra_files: List(String),
+    dir: String,
+  )
+}
+
+pub type Config {
+  Config(name: String)
 }
 
 // ---- CONSTRUCTOR ------------------------------------------------------------
 
-pub fn from(name: String, dir: String) -> Result(Project, String) {
+pub fn from(dir: String) -> Result(Project, String) {
+  use config_file <- try(
+    file.read(filepath.join(dir, "spark.toml"))
+    |> result.replace_error(error.simple_error(
+      "`spark.toml` config file is missing",
+    )),
+  )
+  use config <- try(parse_config(config_file))
   use #(modules, extra_files) <- try(
     scan_project_files(filepath.join(dir, "src")),
   )
-  Ok(Project(name, modules, extra_files, dir))
+  Ok(Project(config, modules, extra_files, dir))
 }
 
 fn scan_project_files(
@@ -40,6 +57,22 @@ fn scan_project_files(
   |> Ok
 }
 
+fn parse_config(config_file: String) -> Result(Config, String) {
+  use parsed <- try(
+    tom.parse(config_file)
+    |> result.replace_error(error.simple_error(
+      "I was unable to parse the config file as valid TOML",
+    )),
+  )
+  use name <- try(
+    tom.get_string(parsed, ["name"])
+    |> result.replace_error(error.simple_error(
+      "Config is missing the `name` field or it is not a string",
+    )),
+  )
+  Ok(Config(name))
+}
+
 // ---- FUNCTIONS --------------------------------------------------------------
 
 /// Compile a project to the given build directory.

templates/spark.toml

@@ -0,0 +1 @@
+name = "Spark"