Delete compile file after compilation

.github/workflows/ci.yaml

@@ -481,7 +481,11 @@ jobs:
         run: make test
         working-directory: ./test/hextarball
 
-      - name: test/running_modules
+      - name: Test deletion of escript compile file after compilation
+        run: ./test.sh
+        working-directory: ./test/delete_escript_after_compilation
+
+      - name: Test running modules
         run: make test-all
         working-directory: ./test/running_modules
 

compiler-cli/src/beam_compiler.rs

@@ -66,6 +66,11 @@ impl BeamCompiler {
         let mut buf = String::new();
         let mut accumulated_modules: Vec<String> = Vec::new();
         while let (Ok(_), Ok(None)) = (inner.stdout.read_line(&mut buf), inner.process.try_wait()) {
+            let escript_path = paths::compilation_escript_path(out);
+
+            // Delete escript file, which is unnecessary after compilation
+            io.delete_file(&escript_path)?;
+
             match buf.trim() {
                 "gleam-compile-result-ok" => {
                     // Return Ok with the accumulated modules
@@ -91,7 +96,7 @@ impl BeamCompiler {
             buf.clear()
         }
 
-        // if we get here, stdout got closed before we got an "ok" or "err".
+        // If we get here, stdout got closed before we got an "ok" or "err".
         Err(Error::ShellCommand {
             program: "escript".into(),
             reason: ShellCommandFailureReason::Unknown,
@@ -103,9 +108,7 @@ impl BeamCompiler {
         io: &IO,
         out: &Utf8Path,
     ) -> Result<BeamCompilerInner, Error> {
-        let escript_path = out
-            .join(paths::ARTEFACT_DIRECTORY_NAME)
-            .join("gleam@@compile.erl");
+        let escript_path = paths::compilation_escript_path(out);
 
         let escript_source = std::include_str!("../templates/gleam@@compile.erl");
         io.write(&escript_path, escript_source)?;

compiler-core/src/paths.rs

@@ -133,6 +133,10 @@ impl ProjectPaths {
     }
 }
 
+pub fn compilation_escript_path(out: &Utf8Path) -> Utf8PathBuf {
+    out.join(ARTEFACT_DIRECTORY_NAME).join("gleam@@compile.erl")
+}
+
 pub fn global_package_cache_package_tarball(checksum: &Base16Checksum) -> Utf8PathBuf {
     global_packages_cache().join(format!("{}.tar", checksum.to_string()))
 }

test/delete_escript_after_compilation/.gitignore

@@ -0,0 +1 @@
+/build

test/delete_escript_after_compilation/Makefile

@@ -0,0 +1,10 @@
+# TODO: migrate to Rust shell commands, possibly ./compiler-cli/src/fs/tests.rs
+test:
+	# clean build directory && build the project
+	cargo run clean && cargo run build
+
+	# fail if file exists
+	@if find build -name "gleam@@compile.erl" | grep -q .; then \
+		echo "Error: gleam@@compile.erl file(s) still exist after build"; \
+		exit 1; \
+	fi

test/delete_escript_after_compilation/gleam.toml

@@ -0,0 +1,4 @@
+name = "delete_escript_after_compilation"
+version = "1.0.0"
+description = "Test project to delete escript compile file after compilation"
+licences = ["Apache-2.0"]

test/delete_escript_after_compilation/manifest.toml

@@ -0,0 +1,7 @@
+# This file was generated by Gleam
+# You typically do not need to edit this file
+
+packages = [
+]
+
+[requirements]

test/delete_escript_after_compilation/src/delete_escript_after_compilation.gleam

@@ -0,0 +1,3 @@
+pub fn something() {
+  "Just a thing to export"
+}

test/delete_escript_after_compilation/test.sh

@@ -0,0 +1,26 @@
+#!/bin/sh
+
+set -eu
+
+GLEAM_COMMAND=${GLEAM_COMMAND:-"cargo run --quiet --"}
+
+g() {
+  echo "Running: $GLEAM_COMMAND $@"
+  $GLEAM_COMMAND "$@"
+}
+
+echo Resetting the build directory to get to a known state
+rm -rf build
+
+echo Building the project
+g build
+
+echo Searching for leftover gleam@@compile.erl files
+if find build -name "gleam@@compile.erl" | grep -q .; then
+  echo "ERROR: gleam@@compile.erl file(s) still exist after build"
+  exit 1
+fi
+
+echo
+echo None found! Success!
+echo