Clean slate

src/lune/error.rs

@@ -5,8 +5,6 @@ use std::{
 
 use mlua::prelude::*;
 
-use crate::lune::lua::stdio::formatting::pretty_format_luau_error;
-
 /**
     An opaque error type for formatted lua errors.
 */
@@ -66,11 +64,7 @@ impl From<LuaError> for LuneError {
 
 impl Display for LuneError {
     fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
-        write!(
+        write!(f, "{}", self.error) // TODO: Pretty formatting
-            f,
-            "{}",
-            pretty_format_luau_error(&self.error, !self.disable_colors)
-        )
     }
 }
 

src/lune/mod.rs

@@ -1,12 +1,6 @@
 use std::process::ExitCode;
 
-use lua::task::{TaskScheduler, TaskSchedulerResumeExt, TaskSchedulerScheduleExt};
 use mlua::prelude::*;
-use tokio::task::LocalSet;
-
-pub mod builtins;
-pub mod importer;
-pub mod lua;
 
 mod error;
 
@@ -37,17 +31,7 @@ impl Lune {
     }
 
     /**
-        Runs a Lune script.
+        Runs a Lune script inside of a new Luau VM.
-
-        This will create a new sandboxed Luau environment with the configured
-        globals and arguments, running inside of a [`tokio::task::LocalSet`].
-
-        Some Lune globals may spawn separate tokio tasks on other threads, but the Luau
-        environment itself is guaranteed to run on a single thread in the local set.
-
-        Note that this will create a static Lua instance and task scheduler that will
-        both live for the remainer of the program, and that this leaks memory using
-        [`Box::leak`] that will then get deallocated when the program exits.
     */
     pub async fn run(
         &self,
@@ -61,47 +45,9 @@ impl Lune {
 
     async fn run_inner(
         &self,
-        script_name: impl AsRef<str>,
+        _script_name: impl AsRef<str>,
-        script_contents: impl AsRef<[u8]>,
+        _script_contents: impl AsRef<[u8]>,
-    ) -> Result<ExitCode, LuaError> {
+    ) -> LuaResult<ExitCode> {
-        // Create our special lune-flavored Lua object with extra registry values
+        Ok(ExitCode::SUCCESS)
-        let lua = lua::create_lune_lua()?.into_static();
-        // Create our task scheduler and all globals
-        // NOTE: Some globals require the task scheduler to exist on startup
-        let sched = TaskScheduler::new(lua)?.into_static();
-        lua.set_app_data(sched);
-        importer::create(lua, self.args.clone())?;
-        // Create the main thread and schedule it
-        let main_chunk = lua
-            .load(script_contents.as_ref())
-            .set_name(script_name.as_ref())
-            .into_function()?;
-        let main_thread = lua.create_thread(main_chunk)?;
-        let main_thread_args = LuaValue::Nil.into_lua_multi(lua)?;
-        sched.schedule_blocking(main_thread, main_thread_args)?;
-        // Keep running the scheduler until there are either no tasks
-        // left to run, or until a task requests to exit the process
-        let exit_code = LocalSet::new()
-            .run_until(async move {
-                let mut got_error = false;
-                loop {
-                    let result = sched.resume_queue().await;
-                    if let Some(err) = result.get_lua_error() {
-                        eprintln!("{}", LuneError::from(err));
-                        got_error = true;
-                    }
-                    if result.is_done() {
-                        if let Some(exit_code) = result.get_exit_code() {
-                            break exit_code;
-                        } else if got_error {
-                            break ExitCode::FAILURE;
-                        } else {
-                            break ExitCode::SUCCESS;
-                        }
-                    }
-                }
-            })
-            .await;
-        Ok(exit_code)
     }
 }

src/old/builtins/fs.rs

@@ -4,7 +4,7 @@ use std::path::{PathBuf, MAIN_SEPARATOR};
 use mlua::prelude::*;
 use tokio::fs;
 
-use crate::lune::lua::{
+use crate::lune_temp::lua::{
     fs::{copy, FsMetadata, FsWriteOptions},
     table::TableBuilder,
 };

src/old/builtins/luau.rs

@@ -1,6 +1,6 @@
 use mlua::prelude::*;
 
-use crate::lune::lua::{
+use crate::lune_temp::lua::{
     luau::{LuauCompileOptions, LuauLoadOptions},
     table::TableBuilder,
 };

src/old/builtins/net.rs

@@ -9,7 +9,7 @@ use hyper::{
 };
 use tokio::{sync::mpsc, task};
 
-use crate::lune::lua::{
+use crate::lune_temp::lua::{
     net::{
         NetClient, NetClientBuilder, NetLocalExec, NetService, NetWebSocket, RequestConfig,
         ServeConfig,

src/old/builtins/process.rs

@@ -11,7 +11,7 @@ use mlua::prelude::*;
 use os_str_bytes::RawOsString;
 use tokio::process::Command;
 
-use crate::lune::lua::{
+use crate::lune_temp::lua::{
     process::pipe_and_inherit_child_process_stdio, table::TableBuilder, task::TaskScheduler,
 };
 

src/old/builtins/roblox.rs

@@ -10,7 +10,7 @@ use crate::roblox::{
 
 use tokio::task;
 
-use crate::lune::lua::table::TableBuilder;
+use crate::lune_temp::lua::table::TableBuilder;
 
 static REFLECTION_DATABASE: OnceCell<ReflectionDatabase> = OnceCell::new();
 

src/old/builtins/serde.rs

@@ -1,6 +1,6 @@
 use mlua::prelude::*;
 
-use crate::lune::lua::{
+use crate::lune_temp::lua::{
     serde::{
         compress, decompress, CompressDecompressFormat, EncodeDecodeConfig, EncodeDecodeFormat,
     },

src/old/builtins/stdio.rs

@@ -5,7 +5,7 @@ use tokio::{
     task,
 };
 
-use crate::lune::lua::{
+use crate::lune_temp::lua::{
     stdio::{
         formatting::{
             format_style, pretty_format_multi_value, style_from_color_str, style_from_style_str,

src/old/builtins/task.rs

@@ -1,6 +1,6 @@
 use mlua::prelude::*;
 
-use crate::lune::lua::{
+use crate::lune_temp::lua::{
     async_ext::LuaAsyncExt,
     table::TableBuilder,
     task::{

src/old/builtins/top_level.rs

@@ -4,7 +4,7 @@ use std::io::{self, Write as _};
 #[cfg(feature = "roblox")]
 use crate::roblox::datatypes::extension::RobloxUserdataTypenameExt;
 
-use crate::lune::lua::{
+use crate::lune_temp::lua::{
     stdio::formatting::{format_label, pretty_format_multi_value},
     task::TaskReference,
 };

src/old/error.rs

@@ -0,0 +1,83 @@
+use std::{
+    error::Error,
+    fmt::{Debug, Display, Formatter, Result as FmtResult},
+};
+
+use mlua::prelude::*;
+
+use crate::lune_temp::lua::stdio::formatting::pretty_format_luau_error;
+
+/**
+    An opaque error type for formatted lua errors.
+*/
+#[derive(Debug, Clone)]
+pub struct LuneError {
+    error: LuaError,
+    disable_colors: bool,
+}
+
+impl LuneError {
+    /**
+        Enables colorization of the error message when formatted using the [`Display`] trait.
+
+        Colorization is enabled by default.
+    */
+    #[doc(hidden)]
+    pub fn enable_colors(mut self) -> Self {
+        self.disable_colors = false;
+        self
+    }
+
+    /**
+        Disables colorization of the error message when formatted using the [`Display`] trait.
+
+        Colorization is enabled by default.
+    */
+    #[doc(hidden)]
+    pub fn disable_colors(mut self) -> Self {
+        self.disable_colors = true;
+        self
+    }
+
+    /**
+        Returns `true` if the error can likely be fixed by appending more input to the source code.
+
+        See [`mlua::Error::SyntaxError`] for more information.
+    */
+    pub fn is_incomplete_input(&self) -> bool {
+        matches!(
+            self.error,
+            LuaError::SyntaxError {
+                incomplete_input: true,
+                ..
+            }
+        )
+    }
+}
+
+impl From<LuaError> for LuneError {
+    fn from(value: LuaError) -> Self {
+        Self {
+            error: value,
+            disable_colors: false,
+        }
+    }
+}
+
+impl Display for LuneError {
+    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
+        write!(
+            f,
+            "{}",
+            pretty_format_luau_error(&self.error, !self.disable_colors)
+        )
+    }
+}
+
+impl Error for LuneError {
+    // TODO: Comment this out when we are ready to also re-export
+    // `mlua` as part of our public library interface in Lune
+    // fn cause(&self) -> Option<&dyn Error> {
+    //     Some(&self.error)
+    // }
+}

src/old/importer/mod.rs

@@ -3,7 +3,7 @@ use mlua::prelude::*;
 mod require;
 mod require_waker;
 
-use crate::lune::builtins::{self, top_level};
+use crate::lune_temp::builtins::{self, top_level};
 
 pub fn create(lua: &'static Lua, args: Vec<String>) -> LuaResult<()> {
     // Create all builtins

src/old/importer/require.rs

@@ -10,7 +10,7 @@ use mlua::prelude::*;
 use tokio::fs;
 use tokio::sync::Mutex as AsyncMutex;
 
-use crate::lune::lua::{
+use crate::lune_temp::lua::{
     table::TableBuilder,
     task::{TaskScheduler, TaskSchedulerScheduleExt},
 };

src/old/lua/async_ext.rs

@@ -2,7 +2,7 @@ use async_trait::async_trait;
 use futures_util::Future;
 use mlua::prelude::*;
 
-use crate::lune::{lua::table::TableBuilder, lua::task::TaskScheduler};
+use crate::lune_temp::{lua::table::TableBuilder, lua::task::TaskScheduler};
 
 use super::task::TaskSchedulerAsyncExt;
 

src/old/lua/net/server.rs

@@ -12,7 +12,7 @@ use hyper::{Body, Request, Response};
 use hyper_tungstenite::{is_upgrade_request as is_ws_upgrade_request, upgrade as ws_upgrade};
 use tokio::task;
 
-use crate::lune::{
+use crate::lune_temp::{
     lua::table::TableBuilder,
     lua::task::{TaskScheduler, TaskSchedulerAsyncExt, TaskSchedulerScheduleExt},
 };

src/old/lua/net/websocket.rs

@@ -22,7 +22,7 @@ use hyper_tungstenite::{
 };
 use tokio_tungstenite::MaybeTlsStream;
 
-use crate::lune::lua::table::TableBuilder;
+use crate::lune_temp::lua::table::TableBuilder;
 
 const WEB_SOCKET_IMPL_LUA: &str = r#"
 return freeze(setmetatable({

src/old/lua/stdio/formatting.rs

@@ -4,7 +4,7 @@ use console::{colors_enabled, set_colors_enabled, style, Style};
 use mlua::prelude::*;
 use once_cell::sync::Lazy;
 
-use crate::lune::lua::task::TaskReference;
+use crate::lune_temp::lua::task::TaskReference;
 
 const MAX_FORMAT_DEPTH: usize = 4;
 

src/old/lua/table/builder.rs

@@ -2,7 +2,7 @@ use std::future::Future;
 
 use mlua::prelude::*;
 
-use crate::lune::lua::async_ext::LuaAsyncExt;
+use crate::lune_temp::lua::async_ext::LuaAsyncExt;
 
 pub struct TableBuilder {
     lua: &'static Lua,

src/old/lua/task/ext/async_ext.rs

@@ -6,7 +6,7 @@ use futures_util::Future;
 use mlua::prelude::*;
 use tokio::time::{sleep, Instant};
 
-use crate::lune::lua::task::TaskKind;
+use crate::lune_temp::lua::task::TaskKind;
 
 use super::super::{
     scheduler::TaskReference, scheduler::TaskScheduler, scheduler_handle::TaskSchedulerAsyncHandle,

src/old/mod.rs

@@ -0,0 +1,107 @@
+use std::process::ExitCode;
+
+use lua::task::{TaskScheduler, TaskSchedulerResumeExt, TaskSchedulerScheduleExt};
+use mlua::prelude::*;
+use tokio::task::LocalSet;
+
+pub mod builtins;
+pub mod importer;
+pub mod lua;
+
+mod error;
+
+pub use error::LuneError;
+
+#[derive(Clone, Debug, Default)]
+pub struct Lune {
+    args: Vec<String>,
+}
+
+impl Lune {
+    /**
+        Creates a new Lune script runner.
+    */
+    pub fn new() -> Self {
+        Self::default()
+    }
+
+    /**
+        Arguments to give in `process.args` for a Lune script.
+    */
+    pub fn with_args<V>(mut self, args: V) -> Self
+    where
+        V: Into<Vec<String>>,
+    {
+        self.args = args.into();
+        self
+    }
+
+    /**
+        Runs a Lune script.
+
+        This will create a new sandboxed Luau environment with the configured
+        globals and arguments, running inside of a [`tokio::task::LocalSet`].
+
+        Some Lune globals may spawn separate tokio tasks on other threads, but the Luau
+        environment itself is guaranteed to run on a single thread in the local set.
+
+        Note that this will create a static Lua instance and task scheduler that will
+        both live for the remainer of the program, and that this leaks memory using
+        [`Box::leak`] that will then get deallocated when the program exits.
+    */
+    pub async fn run(
+        &self,
+        script_name: impl AsRef<str>,
+        script_contents: impl AsRef<[u8]>,
+    ) -> Result<ExitCode, LuneError> {
+        self.run_inner(script_name, script_contents)
+            .await
+            .map_err(LuneError::from)
+    }
+
+    async fn run_inner(
+        &self,
+        script_name: impl AsRef<str>,
+        script_contents: impl AsRef<[u8]>,
+    ) -> Result<ExitCode, LuaError> {
+        // Create our special lune-flavored Lua object with extra registry values
+        let lua = lua::create_lune_lua()?.into_static();
+        // Create our task scheduler and all globals
+        // NOTE: Some globals require the task scheduler to exist on startup
+        let sched = TaskScheduler::new(lua)?.into_static();
+        lua.set_app_data(sched);
+        importer::create(lua, self.args.clone())?;
+        // Create the main thread and schedule it
+        let main_chunk = lua
+            .load(script_contents.as_ref())
+            .set_name(script_name.as_ref())
+            .into_function()?;
+        let main_thread = lua.create_thread(main_chunk)?;
+        let main_thread_args = LuaValue::Nil.into_lua_multi(lua)?;
+        sched.schedule_blocking(main_thread, main_thread_args)?;
+        // Keep running the scheduler until there are either no tasks
+        // left to run, or until a task requests to exit the process
+        let exit_code = LocalSet::new()
+            .run_until(async move {
+                let mut got_error = false;
+                loop {
+                    let result = sched.resume_queue().await;
+                    if let Some(err) = result.get_lua_error() {
+                        eprintln!("{}", LuneError::from(err));
+                        got_error = true;
+                    }
+                    if result.is_done() {
+                        if let Some(exit_code) = result.get_exit_code() {
+                            break exit_code;
+                        } else if got_error {
+                            break ExitCode::FAILURE;
+                        } else {
+                            break ExitCode::SUCCESS;
+                        }
+                    }
+                }
+            })
+            .await;
+        Ok(exit_code)
+    }
+}