v1.3.0

Author: lpil

.gitignore

@@ -3,3 +3,4 @@
 build
 erl_crash.dump
 /gleescript
+/tmp

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v1.3.0 - 2024-06-24
+
+- The `--out` flag can be used to write the escript to a specified directory.
+
 ## v1.2.0 - 2024-05-24
 
 - Generated escript files are now executable by default.

README.md

@@ -24,10 +24,6 @@ gleam run -m gleescript
 # Hello from your_project!
 ```
 
-### Configuration
-
-You can optionally configure the target directory of the executable by adding `--target-dir my_directory`, where `my_directory` is where you want to store the executable.
-
 The escript can run on any computer that has the Erlang VM installed. Older
 versions of the virtual machine may not support the newer bytecode contained in
 the escript. Typically being within a couple major versions of the version used
@@ -37,4 +33,19 @@ See the [Erlang escript documentation][1] for more information.
 
 [1]: https://www.erlang.org/doc/man/escript.html
 
-Havefun!
+
+By default the executable is created in the current directory. The `--out` flag
+can be used to write to a different directory.
+
+```sh
+gleam run -m gleescript -- --out=./some/directory
+#  Compiling your_project
+#   Compiled in 0.26s
+#    Running gleescript.main
+#  Generated ./some/directory/your_project
+
+./some/directory/your_project
+# Hello from your_project!
+```
+
+Have fun!

gleam.toml

@@ -1,5 +1,5 @@
 name = "gleescript"
-version = "1.2.0"
+version = "1.3.0"
 description = "Bundle your Gleam-on-Erlang project into an escript, a single executable file!"
 licences = ["Apache-2.0"]
 repository = { type = "github", user = "lpil", repo = "gleescript" }

src/gleescript.gleam

@@ -26,18 +26,7 @@ pub fn main() {
 }
 
 type Config {
-  Config(package_name: String, target_dir: String)
-}
-
-pub fn get_target_dir(args: List(String)) -> String {
-  let target = case args {
-    ["--target-dir", folder] -> folder
-    _ -> "./"
-  }
-  case string.last(target) {
-    Ok("/") -> target
-    _ -> target <> "/"
-  }
+  Config(package_name: String, out_dir: String)
 }
 
 pub fn run() -> snag.Result(Nil) {
@@ -69,14 +58,14 @@ pub fn run() -> snag.Result(Nil) {
   )
 
   use _ <- result.try(
-    simplifile.create_directory_all(config.target_dir)
+    simplifile.create_directory_all(config.out_dir)
     |> snag_inspect_error
-    |> snag.context("Failed to create " <> config.target_dir <> " directory"),
+    |> snag.context("Failed to create " <> config.out_dir <> " directory"),
   )
 
   let result =
     erlang_escript_create(
-      charlist.from_string(config.target_dir <> config.package_name),
+      charlist.from_string(config.out_dir <> config.package_name),
       [
         Shebang,
         Comment(charlist.from_string("")),
@@ -92,7 +81,7 @@ pub fn run() -> snag.Result(Nil) {
     |> snag.context("Failed to build escript"),
   )
 
-  let name = config.target_dir <> config.package_name
+  let name = config.out_dir <> config.package_name
   use _ <- result.try(
     simplifile.set_permissions_octal(name, 0o777)
     |> snag_inspect_error
@@ -101,7 +90,7 @@ pub fn run() -> snag.Result(Nil) {
 
   io.println(
     "  \u{001b}[95mGenerated\u{001b}[0m "
-    <> config.target_dir
+    <> config.out_dir
     <> config.package_name,
   )
 
@@ -125,7 +114,7 @@ fn locate_beam_files() -> snag.Result(List(String)) {
 }
 
 fn load_config() -> snag.Result(Config) {
-  let target_dir = get_target_dir(argv.load().arguments)
+  let out_dir = get_out_dir(argv.load().arguments)
 
   use text <- result.try(
     simplifile.read("gleam.toml")
@@ -145,7 +134,7 @@ fn load_config() -> snag.Result(Config) {
     |> snag.context("Failed to get package name from gleam.toml"),
   )
 
-  Ok(Config(package_name: package_name, target_dir: target_dir))
+  Ok(Config(package_name: package_name, out_dir: out_dir))
 }
 
 fn snag_inspect_error(result: Result(t, e)) -> snag.Result(t) {
@@ -172,3 +161,14 @@ fn erlang_escript_create(
 
 @external(erlang, "init", "stop")
 fn shutdown(status: Int) -> a
+
+fn get_out_dir(args: List(String)) -> String {
+  let out = case args {
+    ["--out", folder] | ["--out=" <> folder] -> folder
+    _ -> "./"
+  }
+  case string.last(out) {
+    Ok("/") -> out
+    _ -> out <> "/"
+  }
+}

test.sh

@@ -1,14 +1,20 @@
 #!/bin/sh
 
-DIRECTORY=test-dir
+set -eu
 
-rm -rf $DIRECTORY
+# Reset out artefacts
+rm -rf gleescript ./tmp
 
-gleam run -- --target-dir $DIRECTORY
+# No arguments
+gleam run -m gleescript
+./gleescript
 
-if [ ! -d $DIRECTORY ]; then
-	echo "Directory $DIRECTORY was not created"
-	exit 1
-fi
+# --out tmp/without-equals
+gleam run -m gleescript -- --out tmp/without-equals
+./tmp/without-equals/gleescript
 
-echo "Test passed!"
+# --out=tmp/with-equals
+gleam run -m gleescript -- --out=tmp/with-equals
+./tmp/with-equals/gleescript
+
+echo "Tests passed!"

test/gleescript_test.gleam

@@ -1,18 +1,5 @@
-import gleescript
 import gleeunit
-import gleeunit/should
 
 pub fn main() {
   gleeunit.main()
 }
-
-// gleeunit test functions end in `_test`
-pub fn arguments_parsed_correctly_test() {
-  ["--target-dir", "test"]
-  |> gleescript.get_target_dir
-  |> should.equal("test/")
-
-  []
-  |> gleescript.get_target_dir
-  |> should.equal("./")
-}