✨ CLI & project building

Author: MystPi

examples/TestProject/spark.toml

@@ -1 +1,4 @@
-name = "TestProject"
+name = "TestProject"
+
+[dependencies]
+Spark = "https://github.com/MystPi/spark_stdlib/archive/refs/heads/main.tar.gz"

gleam.toml

@@ -1,5 +1,6 @@
 name = "spark"
 version = "1.0.0"
+target = "javascript"
 
 # Fill out these fields if you intend to generate HTML documentation or publish
 # your project to the Hex package manager.
@@ -12,16 +13,21 @@ version = "1.0.0"
 # For a full reference of all the available options, you can have a look at
 # https://gleam.run/writing-gleam/gleam-toml/.
 
+[javascript]
+runtime = "bun"
+
 [dependencies]
 gleam_stdlib = "~> 0.34 or ~> 1.0"
 chomp = { path = "../chomp-nibble" }
 gleam_community_ansi = ">= 1.4.0 and < 2.0.0"
-hug = "~> 1.0"
+hug = ">= 1.0.2 and < 2.0.0"
 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"
+glint = ">= 0.18.1 and < 1.0.0"
+argv = ">= 1.0.2 and < 2.0.0"
 
 [dev-dependencies]
 gleeunit = "~> 1.0"

manifest.toml

@@ -2,31 +2,36 @@
 # You typically do not need to edit this file
 
 packages = [
+  { name = "argv", version = "1.0.2", build_tools = ["gleam"], requirements = [], otp_app = "argv", source = "hex", outer_checksum = "BA1FF0929525DEBA1CE67256E5ADF77A7CDDFE729E3E3F57A5BDCAA031DED09D" },
   { name = "chomp", version = "1.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], source = "local", path = "../chomp-nibble" },
   { name = "dedent", version = "1.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "dedent", source = "hex", outer_checksum = "591C78F019CFE8B4F138BDCA5DB57EB429D95F90CD12B51262A3FC6455EC1AEF" },
   { name = "filepath", version = "1.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "filepath", source = "hex", outer_checksum = "EFB6FF65C98B2A16378ABC3EE2B14124168C0CE5201553DE652E2644DCFDB594" },
   { name = "glam", version = "2.0.1", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "glam", source = "hex", outer_checksum = "66EC3BCD632E51EED029678F8DF419659C1E57B1A93D874C5131FE220DFAD2B2" },
   { name = "gleam_community_ansi", version = "1.4.0", build_tools = ["gleam"], requirements = ["gleam_community_colour", "gleam_stdlib"], otp_app = "gleam_community_ansi", source = "hex", outer_checksum = "FE79E08BF97009729259B6357EC058315B6FBB916FAD1C2FF9355115FEB0D3A4" },
   { name = "gleam_community_colour", version = "1.4.0", build_tools = ["gleam"], requirements = ["gleam_json", "gleam_stdlib"], otp_app = "gleam_community_colour", source = "hex", outer_checksum = "795964217EBEDB3DA656F5EB8F67D7AD22872EB95182042D3E7AFEF32D3FD2FE" },
   { name = "gleam_json", version = "1.0.1", build_tools = ["gleam"], requirements = ["gleam_stdlib", "thoas"], otp_app = "gleam_json", source = "hex", outer_checksum = "9063D14D25406326C0255BDA0021541E797D8A7A12573D849462CAFED459F6EB" },
-  { name = "gleam_stdlib", version = "0.34.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "1FB8454D2991E9B4C0C804544D8A9AD0F6184725E20D63C3155F0AEB4230B016" },
+  { name = "gleam_stdlib", version = "0.37.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "5398BD6C2ABA17338F676F42F404B9B7BABE1C8DC7380031ACB05BBE1BCF3742" },
   { name = "gleeunit", version = "1.1.2", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleeunit", source = "hex", outer_checksum = "72CDC3D3F719478F26C4E2C5FED3E657AC81EC14A47D2D2DEBB8693CA3220C3B" },
-  { name = "hug", version = "1.0.0", build_tools = ["gleam"], requirements = ["gleam_community_ansi", "gleam_community_colour", "gleam_stdlib"], otp_app = "hug", source = "hex", outer_checksum = "D7D8C4F5A3093FB0B6A0228288D94E95966AADC5500133F9E983BA4634E92CC8" },
-  { name = "pprint", version = "1.0.2", build_tools = ["gleam"], requirements = ["glam", "gleam_stdlib"], otp_app = "pprint", source = "hex", outer_checksum = "3EB2A7A8F72322F73EEF342374D0354AE39E7F9C64678B960BE8B2DC1B564AE1" },
+  { name = "glint", version = "0.18.1", build_tools = ["gleam"], requirements = ["gleam_community_ansi", "gleam_community_colour", "gleam_stdlib", "snag"], otp_app = "glint", source = "hex", outer_checksum = "5FB54D7732B4105E4AF4D89A7EE6D5E8CF33DA13A3575D0C6ECE470B97958454" },
+  { name = "hug", version = "1.0.2", build_tools = ["gleam"], requirements = ["gleam_community_ansi", "gleam_community_colour", "gleam_stdlib"], otp_app = "hug", source = "hex", outer_checksum = "0FB00C4F2E35155900BA90FF6240C63BD50C11037894836CD6AE04636A736C27" },
+  { name = "pprint", version = "1.0.3", build_tools = ["gleam"], requirements = ["glam", "gleam_stdlib"], otp_app = "pprint", source = "hex", outer_checksum = "76BBB92E23D12D954BD452686543F29EDE8EBEBB7FC0ACCBCA66EEF276EC3A06" },
   { name = "simplifile", version = "1.7.0", build_tools = ["gleam"], requirements = ["filepath", "gleam_stdlib"], otp_app = "simplifile", source = "hex", outer_checksum = "1D5DFA3A2F9319EC85825F6ED88B8E449F381B0D55A62F5E61424E748E7DDEB0" },
+  { name = "snag", version = "0.3.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "snag", source = "hex", outer_checksum = "54D32E16E33655346AA3E66CBA7E191DE0A8793D2C05284E3EFB90AD2CE92BCC" },
   { 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]
+argv = { version = ">= 1.0.2 and < 2.0.0"}
 chomp = { path = "../chomp-nibble" }
 dedent = { version = ">= 1.0.0 and < 2.0.0" }
 filepath = { version = ">= 1.0.0 and < 2.0.0" }
 glam = { version = ">= 2.0.0 and < 3.0.0" }
 gleam_community_ansi = { version = ">= 1.4.0 and < 2.0.0" }
 gleam_stdlib = { version = "~> 0.34 or ~> 1.0" }
 gleeunit = { version = "~> 1.0" }
-hug = { version = "~> 1.0" }
+glint = { version = ">= 0.18.1 and < 1.0.0" }
+hug = { version = ">= 1.0.2 and < 2.0.0" }
 pprint = { version = "~> 1.0" }
 simplifile = { version = ">= 1.7.0 and < 2.0.0" }
-tom = { version = ">= 0.3.0 and < 1.0.0"}
+tom = { version = ">= 0.3.0 and < 1.0.0" }

src/ffi.mjs

@@ -0,0 +1,29 @@
+import * as $gleam from './gleam.mjs';
+import * as $error from './spark/error.mjs';
+
+export function downloadTar(url, outputDir) {
+  const wget_command = Bun.spawnSync(['wget', '-q', '-O', '-', url]);
+
+  if (!wget_command.success)
+    return new $gleam.Error(
+      $error.simple_error('Failed to download tarball from ' + url)
+    );
+
+  const tar_command = Bun.spawnSync(
+    ['tar', 'xzC', outputDir, '--strip-components=1'],
+    {
+      stdin: wget_command.stdout,
+    }
+  );
+
+  if (!tar_command.success)
+    return new $gleam.Error(
+      $error.simple_error('Failed to extract tarball to ' + outputDir)
+    );
+
+  return new $gleam.Ok();
+}
+
+export function now() {
+  return performance.now();
+}

src/spark.gleam

@@ -1,47 +1,158 @@
+import argv
 import filepath
+import gleam/dict
 import gleam/io
-import gleam/result.{try}
-import gleam/string
-import gleam_community/ansi
+import gleam/list
+import gleam/result
+import glint
+import glint/flag
+import spark/build
+import spark/error
 import spark/file
 import spark/project
+import spark/util
 
 pub fn main() {
-  let result = {
-    use project <- try(project.from("examples/TestProject"))
-    build(project)
-  }
+  glint.new()
+  |> glint.with_name("spark")
+  |> glint.with_pretty_help(glint.default_pretty_help())
+  |> glint.add(at: ["build"], do: build_command())
+  |> glint.add(at: ["clean"], do: clean_command())
+  |> glint.add(at: ["new"], do: new_project_command())
+  |> glint.run_and_handle(argv.load().arguments, print_result)
+}
 
+fn print_result(result: Result(Nil, String)) -> Nil {
   case result {
     Ok(_) -> Nil
     Error(e) -> io.println_error(e)
   }
 }
 
-/// Build a project, with the stdlib and prelude included, to the /build directory.
-///
-fn build(project: project.Project) -> Result(Nil, String) {
-  let build_dir = filepath.join(project.dir, "build")
+// ---- FLAGS ------------------------------------------------------------------
+
+const root = "root"
+
+fn root_flag() -> flag.FlagBuilder(String) {
+  flag.string()
+  |> flag.default("./")
+  |> flag.description("Change project root directory; default is ./")
+}
+
+fn get_root_flag(input: glint.CommandInput) -> String {
+  let assert Ok(root) = flag.get_string(input.flags, root)
+  root
+}
+
+// ---- COMMANDS ---------------------------------------------------------------
 
-  report("Compiling", "Spark")
-  use template <- try(project.from("./templates"))
-  use _ <- try(project.compile(template, to: build_dir))
+// -- Build --
 
-  report("Compiling", project.config.name)
-  use _ <- try(project.compile(project, to: build_dir))
+fn build_command() {
+  glint.command(fn(input) {
+    input
+    |> get_root_flag
+    |> build
+  })
+  |> glint.description("Build a project")
+  |> glint.flag(root, root_flag())
+  |> glint.unnamed_args(glint.EqArgs(0))
+}
+
+fn build(root: String) {
+  project.from(root)
+  |> result.then(build.build)
+}
+
+// -- Clean --
+
+fn clean_command() {
+  glint.command(fn(input) {
+    input
+    |> get_root_flag
+    |> clean
+  })
+  |> glint.description("Delete a project's build directory")
+  |> glint.flag(root, root_flag())
+  |> glint.unnamed_args(glint.EqArgs(0))
+}
+
+fn clean(root: String) {
+  filepath.join(root, "build")
+  |> file.delete
+}
 
-  report("Creating", "index file")
-  let path = filepath.join(project.dir, "build/index.mjs")
-  let contents =
-    "import { main } from './" <> project.config.name <> ".mjs';\nmain();"
-  use _ <- try(file.write_all(path, contents))
+// -- New Project --
 
-  report("Compiled", "successfully")
-  report("Entry", path)
-  Ok(Nil)
+fn new_project_command() {
+  glint.command(fn(input) {
+    let assert Ok(name) = dict.get(input.named_args, "name")
+    case util.is_valid_module_name(name) {
+      True -> new_project(name)
+      False ->
+        Error(error.simple_error(
+          "`"
+          <> name
+          <> "` is not a valid module name. Module names start with an uppercase letter and contain only letters and numbers",
+        ))
+    }
+  })
+  |> glint.description("Create a new spark project")
+  |> glint.named_args(["name"])
+  |> glint.unnamed_args(glint.EqArgs(0))
 }
 
-fn report(status: String, message: String) {
-  let padding = string.repeat(" ", 9 - string.length(status))
-  io.println(padding <> ansi.bold(ansi.blue(status)) <> " " <> message)
+fn new_project(name: String) {
+  let files = [
+    #(".gitignore", "/build\n"),
+    #("README.md", new_project_readme(name)),
+    #("spark.toml", new_project_config(name)),
+    #("src/" <> name <> ".spark", new_project_code(name)),
+  ]
+
+  use _ <- result.try(
+    list.try_each(files, fn(file) {
+      let #(path, contents) = file
+      file.safe_write_all(filepath.join(name, path), contents)
+    }),
+  )
+
+  Ok(io.println("Created project in ./" <> name))
+}
+
+fn new_project_readme(name: String) -> String {
+  "# " <> name <> "
+
+A spark project.
+
+```sh
+# build
+spark build
+
+# run with Bun
+bun run ./build/index.mjs
+
+# run with Deno
+deno run ./build/index.mjs
+
+# run with Node
+node ./build/index.mjs
+```
+"
+}
+
+fn new_project_config(name: String) -> String {
+  "name = \"" <> name <> "\"
+
+[dependencies]
+Spark = \"https://github.com/MystPi/spark_stdlib/archive/refs/heads/main.tar.gz\"
+"
+}
+
+fn new_project_code(name: String) -> String {
+  "import Spark/IO
+
+def pub main =
+  IO.println(\"Hello from " <> name <> "!\")
+"
 }

src/spark/build.gleam

@@ -0,0 +1,82 @@
+import filepath
+import gleam/float
+import gleam/int
+import gleam/io
+import gleam/list
+import gleam/result.{try}
+import gleam/string
+import gleam_community/ansi
+import spark/file
+import spark/prelude
+import spark/project
+
+/// Build a project with its dependencies to the build directory.
+///
+pub fn build(project: project.Project) -> Result(Nil, String) {
+  let build_dir = filepath.join(project.dir, "build")
+
+  let start_time = now()
+  use _ <- try(build_dependencies(project, to: build_dir))
+
+  report("Compiling", project.config.name)
+  use _ <- try(project.compile(project, to: build_dir))
+
+  use path <- try(project.create_entrypoint(project, in: build_dir))
+  use _ <- try(prelude.create(in: build_dir))
+  let end_time = now()
+
+  report(
+    "Compiled",
+    "in " <> float.to_string(round(end_time -. start_time)) <> "ms",
+  )
+  report("Entry", path)
+  Ok(Nil)
+}
+
+@external(javascript, "../ffi.mjs", "now")
+fn now() -> Float
+
+fn round(f: Float) -> Float {
+  int.to_float(float.round(f *. 100.0)) /. 100.0
+}
+
+fn build_dependencies(
+  project: project.Project,
+  to build_dir: String,
+) -> Result(Nil, String) {
+  list.try_each(project.config.dependencies, fn(dep) {
+    let #(name, url) = dep
+    let path = filepath.join(build_dir, "deps/" <> name)
+
+    use _ <- try({
+      case file.directory_exists(path) {
+        True -> Ok(Nil)
+        False -> {
+          report("Downloading", name)
+          download_dependency(from: url, to: path)
+        }
+      }
+    })
+
+    report("Compiling", name)
+    use dep_project <- try(project.from(path))
+    use _ <- try(project.compile(dep_project, to: build_dir))
+
+    build_dependencies(dep_project, to: build_dir)
+  })
+}
+
+@external(javascript, "../ffi.mjs", "downloadTar")
+fn download_tar(from url: String, to dir: String) -> Result(Nil, String)
+
+fn download_dependency(from url: String, to dir: String) -> Result(Nil, String) {
+  use _ <- try(file.create_directory_all(dir))
+  download_tar(from: url, to: dir)
+}
+
+fn report(status: String, message: String) {
+  let padding = string.repeat(" ", 11 - string.length(status))
+  io.println(
+    padding <> ansi.blue(status) <> ansi.dim(": ") <> ansi.bold(message),
+  )
+}