CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

0.8.7 - August 10th, 2024

Added

• Added a compression level option to serde.compress (#224)
• Added missing vector methods to the roblox library (#228)

Changed

• Updated to Luau version 0.635
• Updated to rbx-dom database version 0.634

Fixed

• Fixed fs.readDir with trailing forward-slash on Windows (#220)
• Fixed __type and __tostring metamethods not always being respected when formatting tables

0.8.6 - June 23rd, 2024

Added

• Added a builtin API for hashing and calculating HMACs as part of the serde library (#193)

  Basic usage:

  local serde = require("@lune/serde")
  local hash = serde.hash("sha256", "a message to hash")
  local hmac = serde.hmac("sha256", "a message to hash", "a secret string")
  
  print(hash)
  print(hmac)

  The returned hashes are sequences of lowercase hexadecimal digits. The following algorithms are supported: md5, sha1, sha224, sha256, sha384, sha512, sha3-224, sha3-256, sha3-384, sha3-512, blake3

• Added two new options to luau.load:

  • codegenEnabled - whether or not codegen should be enabled for the loaded chunk.
  • injectGlobals - whether or not to inject globals into a passed environment.

  By default, globals are injected and codegen is disabled. Check the documentation for the luau standard library for more information.

• Implemented support for floor division operator / __idiv for the Vector2 and Vector3 types in the roblox standard library (#196)

• Fixed the _VERSION global containing an incorrect Lune version string.

Changed

• Sandboxing and codegen in the Luau VM is now fully enabled, resulting in up to 2x or faster code execution. This should not result in any behavior differences in Lune, but if it does, please open an issue.
• Improved formatting of custom error objects (such as when fs.readFile returns an error) when printed or formatted using stdio.format.

Fixed

• Fixed __type and __tostring metamethods on userdatas and tables not being respected when printed or formatted using stdio.format.

0.8.5 - June 1st, 2024

Changed

• Improved table pretty formatting when using print, warn, and stdio.format:

  • Keys are sorted numerically / alphabetically when possible.
  • Keys of different types are put in distinct sections for mixed tables.
  • Tables that are arrays no longer display their keys.
  • Empty tables are no longer spread across lines.

Fixed

• Fixed formatted values in tables not being separated by newlines.
• Fixed panicking (crashing) when using process.spawn with a program that does not exist.
• Fixed instance:SetAttribute("name", nil) throwing an error and not removing the attribute.

0.8.4 - May 12th, 2024

Added

• Added a builtin API for regular expressions.

  Example basic usage:

  local Regex = require("@lune/regex")
  
  local re = Regex.new("hello")
  
  if re:isMatch("hello, world!") then
  	print("Matched!")
  end
  
  local caps = re:captures("hello, world! hello, again!")
  
  print(#caps) -- 2
  print(caps:get(1)) -- "hello"
  print(caps:get(2)) -- "hello"
  print(caps:get(3)) -- nil

  Check out the documentation for more details.

• Added support for buffers as arguments in builtin APIs (#148)

  This includes APIs such as fs.writeFile, serde.encode, and more.

• Added support for cross-compilation of standalone binaries (#162)

  You can now compile standalone binaries for other platforms by passing an additional target argument to the build subcommand:

  lune build my-file.luau --output my-bin --target windows-x86_64

  Currently supported targets are the same as the ones included with each release of Lune on GitHub. Check releases for a full list of targets.

• Added stdio.readToEnd() for reading the entire stdin passed to Lune

Changed

• Split the repository into modular crates instead of a monolith. (#188)

  If you previously depended on Lune as a crate, nothing about it has changed for version 0.8.4, but now each individual sub-crate has also been published and is available for use:

  • lune (old)
  • lune-utils
  • lune-roblox
  • lune-std-* for every builtin library

  When depending on the main lune crate, each builtin library also has a feature flag that can be toggled in the format std-*.

  In general, this should mean that it is now much easier to make your own Lune builtin, publish your own flavor of a Lune CLI, or take advantage of all the work that has been done for Lune as a runtime when making your own Rust programs.

• Changed the User-Agent header in net.request to be more descriptive (#186)

• Updated to Luau version 0.622.

Fixed

• Fixed not being able to decompress lz4 format in high compression mode
• Fixed stack overflow for tables with circular keys (#183)
• Fixed net.serve no longer accepting ipv6 addresses
• Fixed headers in net.serve being raw bytes instead of strings

0.8.3 - April 15th, 2024

Fixed

• Fixed require not throwing syntax errors (#168)
• Fixed require caching not working correctly (#171)
• Fixed case-sensitivity issue in require with aliases (#173)
• Fixed itertools dependency being marked optional even though it is mandatory (#176)
• Fixed test cases for the net built-in library on Windows (#177)

0.8.2 - March 12th, 2024

Fixed

• Fixed REPL panicking after the first evaluation / run.
• Fixed globals reloading on each run in the REPL, causing unnecessary slowdowns.
• Fixed net.serve requests no longer being plain tables in Lune 0.8.1, breaking usage of things such as table.clone.

0.8.1 - March 11th, 2024

Added

• Added the ability to specify an address in net.serve. (#142)

Changed

• Update to Luau version 0.616.
• Major performance improvements when using a large amount of threads / asynchronous Lune APIs. (#165)
• Minor performance improvements and less overhead for net.serve and net.socket. (#165)

Fixed

• Fixed fs.copy not working with empty dirs. (#155)
• Fixed stack overflow when printing tables with cyclic references. (#158)
• Fixed not being able to yield in net.serve handlers without blocking other requests. (#165)
• Fixed various scheduler issues / panics. (#165)

0.8.0 - January 14th, 2024

Breaking Changes

• The Lune CLI now uses subcommands instead of flag options:
  

  • lune script_name arg1 arg2 arg3 -> lune run script_name arg1 arg2 arg3
  • lune --list -> lune list
  • lune --setup -> lune setup

  This unfortunately hurts ergonomics for quickly running scripts but is a necessary change to allow us to add more commands, such as the new build subcommand.

• The createdAt, modifiedAt, and accessedAt properties returned from fs.metadata are now DateTime values instead of numbers.

• The Lune struct has been renamed to Runtime in the Lune rust crate.

Added

• Added support for compiling single Lune scripts into standalone executables! (#140)

  Example usage:

  -- my_cool_script.luau
  print("Hello, standalone!")

  > lune build my_cool_script.luau
  # Creates `my_cool_script.exe` (Windows) or `my_cool_script` (macOS / Linux)

  > ./my_cool_script.exe # Windows
  > ./my_cool_script # macOS / Linux
  > "Hello, standalone!"

  To compile scripts that use require and reference multiple files, a bundler such as darklua should preferrably be used. You may also distribute files alongside the standalone binary, they will still be able to be require-d. This limitation will be lifted in the future and Lune will automatically bundle any referenced scripts.

• Added support for path aliases using .luaurc config files!

  For full documentation and reference, check out the official Luau RFC, but here's a quick example:

  // .luaurc
  {
    "aliases": {
      "modules": "./some/long/path/to/modules"
    }
  }

  -- ./some/long/path/to/modules/foo.luau
  return { World = "World!" }
  
  -- ./anywhere/you/want/my_script.luau
  local mod = require("@modules/foo")
  print("Hello, " .. mod.World)

• Added support for multiple values for a single query, and multiple values for a single header, in net.request. This is a part of the HTTP specification that is not widely used but that may be useful in certain cases. To clarify:

  • Single values remain unchanged and will work exactly the same as before.
    

    -- https://example.com/?foo=bar&baz=qux
    local net = require("@lune/net")
    net.request({
        url = "example.com",
        query = {
            foo = "bar",
            baz = "qux",
        }
    })

  • Multiple values on a single query / header are represented as an ordered array of strings.
    

    -- https://example.com/?foo=first&foo=second&foo=third&bar=baz
    local net = require("@lune/net")
    net.request({
        url = "example.com",
        query = {
            foo = { "first", "second", "third" },
            bar = "baz",
        }
    })

Changed

• Update to Luau version 0.606.

Fixed

• Fixed the print and warn global functions yielding the thread, preventing them from being used in places such as the callback to table.sort.
• Fixed the overwrite option for fs.move not correctly removing existing files / directories. (#133)

0.7.11 - October 29th, 2023

Changed

• Update to Luau version 0.601.

Fixed

• Fixed roblox.getAuthCookie not being compatible with the latest cookie format by upgrading rbx_cookie.

0.7.10 - October 25th, 2023

Added

• Added the GetDebugId instance method to the roblox built-in. This will return the internal id used by the instance, and as the name implies, it should be primarily used for debugging purposes and cases where you need a globally unique identifier for an instance. It is guaranteed to be a 32-digit hexadecimal string.

Fixed

• Fixed issues with SecurityCapabilities on instances in the roblox built-in by upgrading rbx-dom.

0.7.9 - October 21st, 2023

Added

• Added implementProperty and implementMethod to the roblox built-in library to fill in missing functionality that Lune does not aim to implement itself.

  Example usage:

  local roblox = require("@lune/roblox")
  
  local part = roblox.Instance.new("Part")
  
  roblox.implementMethod("BasePart", "TestMethod", function(_, ...)
      print("Tried to call TestMethod with", ...)
  end)
  
  part:TestMethod("Hello", "world!")

Changed

• Update to Luau version 0.599.
• Stdio options when using process.spawn can now be set with more granularity, allowing stderr & stdout to be disabled individually and completely to improve memory usage when they are not being used.

0.7.8 - October 5th, 2023

Added

• Added a new datetime built-in library for handling date & time values, parsing, formatting, and more. (#94)

  Example usage:

  local DateTime = require("@lune/datetime")
  
  -- Creates a DateTime for the current exact moment in time
  local now = DateTime.now()
  
  -- Formats the current moment in time as an ISO 8601 string
  print(now:toIsoDate())
  
  -- Formats the current moment in time, using the local
  -- time, the French locale, and the specified time string
  print(now:formatLocalTime("%A, %d %B %Y", "fr"))
  
  -- Returns a specific moment in time as a DateTime instance
  local someDayInTheFuture = DateTime.fromLocalTime({
      year = 3033,
      month = 8,
      day = 26,
      hour = 16,
      minute = 56,
      second = 28,
      millisecond = 892,
  })
  
  -- Extracts the current local date & time as separate values (same values as above table)
  print(now:toLocalTime())
  
  -- Returns a DateTime instance from a given float, where the whole
  -- denotes the seconds and the fraction denotes the milliseconds
  -- Note that the fraction for millis here is completely optional
  DateTime.fromUnixTimestamp(871978212313.321)
  
  -- Extracts the current universal (UTC) date & time as separate values
  print(now:toUniversalTime())

• Added support for passing stdin in process.spawn (#106)

• Added support for setting a custom environment in load options for luau.load, not subject to getfenv / setfenv deoptimizations

• Added Terrain:GetMaterialColor and Terrain:SetMaterialColor (#93)

• Added support for a variable number of arguments for CFrame methods (#85)

Changed

• Update to Luau version 0.596.
• Update to rbx-dom database version 0.596.
• process.spawn now uses powershell instead of /bin/bash as the shell on Windows, with shell = true.
• CFrame and Vector3 values are now rounded to the nearest 2 ^ 16 decimal place to reduce floating point errors and diff noise. Note that this does not affect intermediate calculations done in lua, and only happens when a property value is set on an Instance.

Fixed

• Fixed the process built-in library not loading correctly when using Lune in REPL mode.
• Fixed list subcommand not listing global scripts without a local .lune / lune directory present.
• Fixed net.serve stopping when the returned ServeHandle is garbage collected.
• Fixed missing trailing newline when using the warn global.
• Fixed constructor for CFrame in the roblox built-in library not parsing the 12-arg overload correctly. (#102)
• Fixed various functions for CFrame in the roblox built-in library being incorrect, specifically row-column ordering and some flipped signs. (#103)
• Fixed cross-service Instance references disappearing when using the roblox built-in library (#117)

0.7.7 - August 23rd, 2023

Added

• Added a REPL to Lune. (#83)

  This allows you to run scripts within Lune without writing files!

  Example usage, inside your favorite terminal:

  # 1. Run the Lune executable, without any arguments
  lune
  
  # 2. You will be shown the current Lune version and a blank prompt arrow:
  Lune v0.7.7
  >
  
  # 3. Start typing, and hit enter when you want to run your script!
  #    Your script will run until completion and output things along the way.
  > print(2 + 3)
  5
  > print("Hello, lune changelog!")
  Hello, lune changelog!
  
  # 4. You can also set variables that will get preserved between runs.
  #    Note that local variables do not get preserved here.
  > myVariable = 123
  > print(myVariable)
  123
  
  # 5. Press either of these key combinations to exit the REPL:
  #    - Ctrl + D
  #    - Ctrl + C

• Added a new luau built-in library for manually compiling and loading Luau source code. (#82)

  Example usage:

  local luau = require("@lune/luau")
  
  local bytecode = luau.compile("print('Hello, World!')")
  local callableFn = luau.load(bytecode)
  
  callableFn()
  
  -- Additionally, we can skip the bytecode generation and
  -- load a callable function directly from the code itself.
  local callableFn2 = luau.load("print('Hello, World!')")
  
  callableFn2()

Changed

• Update to Luau version 0.591.

• Lune's internal task scheduler and require functionality has been completely rewritten.
  The new scheduler is much more stable, conforms to a larger test suite, and has a few additional benefits:

  • Built-in libraries are now lazily loaded, meaning nothing gets allocated until the built-in library gets loaded using require("@lune/builtin-name"). This also improves startup times slightly.
  • Spawned processes using process.spawn now run on different thread(s), freeing up resources for the main thread where luau runs.
  • Serving requests using net.serve now processes requests on background threads, also freeing up resources. In the future, this will also allow us to offload heavy tasks such as compression/decompression to background threads.
  • Groundwork for custom / user-defined require aliases has been implemented, as well as absolute / cwd-relative requires. These will both be exposed as options and be made available to use some time in the future.

• When using the serde built-in library, keys are now sorted during serialization. This means that the output of encode is now completely deterministic, and wont cause issues when committing generated files to git etc.

Fixed

• Fixed not being able to pass arguments to the thread using coroutine.resume. (#86)

• Fixed a large number of long-standing issues, from the task scheduler rewrite:

  • Fixed require hanging indefinitely when the module being require-d uses an async function in its main body.
  • Fixed background tasks (such as net.serve) not keeping Lune alive even if there are no lua threads to run.
  • Fixed spurious panics and error messages such as Tried to resume next queued future but none are queued.
  • Fixed not being able to catch non-string errors properly, errors were accidentally being wrapped in an opaque userdata type.

0.7.6 - August 9th, 2023

Changed

• Update to Luau version 0.588
• Enabled Luau JIT backend for potential performance improvements 🚀
  If you run into any strange behavior please open an issue!

Fixed

• Fixed publishing of the Lune library to crates.io
• Fixed serde.decode deserializing null values as userdata instead of nil.
• Fixed not being able to require files with multiple extensions, eg. module.spec.luau was not require-able using require("module.spec").
• Fixed instances and roblox built-in library APIs erroring when used asynchronously/concurrently.

0.7.5 - July 22nd, 2023

Added

• Lune now has a new documentation site!
  This addresses new APIs from version 0.7.0 not being available on the docs site, brings much improved searching functionality, and will help us keep documentation more up-to-date going forward with a more automated process. You can check out the new site at lune-org.github.io.

• Added fs.copy to recursively copy files and directories.

  Example usage:

  local fs = require("@lune/fs")
  
  fs.writeDir("myCoolDir")
  fs.writeFile("myCoolDir/myAwesomeFile.json", "{}")
  
  fs.copy("myCoolDir", "myCoolDir2")
  
  assert(fs.isDir("myCoolDir2"))
  assert(fs.isFile("myCoolDir2/myAwesomeFile.json"))
  assert(fs.readFile("myCoolDir2/myAwesomeFile.json") == "{}")

• Added fs.metadata to get metadata about files and directories.

  Example usage:

  local fs = require("@lune/fs")
  
  fs.writeFile("myAwesomeFile.json", "{}")
  
  local meta = fs.metadata("myAwesomeFile.json")
  
  print(meta.exists) --> true
  print(meta.kind) --> "file"
  print(meta.createdAt) --> 1689848548.0577152 (unix timestamp)
  print(meta.permissions) --> { readOnly: false }

• Added roblox.getReflectionDatabase to access the builtin database containing information about classes and enums.

  Example usage:

  local roblox = require("@lune/roblox")
  
  local db = roblox.getReflectionDatabase()
  
  print("There are", #db:GetClassNames(), "classes in the reflection database")
  
  print("All base instance properties:")
  
  local class = db:GetClass("Instance")
  for name, prop in class.Properties do
  	print(string.format(
  		"- %s with datatype %s and default value %s",
  		prop.Name,
  		prop.Datatype,
  		tostring(class.DefaultProperties[prop.Name])
  	))
  end

• Added support for running directories with an init.luau or init.lua file in them in the CLI.

Changed

• Update to Luau version 0.583

Fixed

• Fixed publishing of Lune to crates.io by migrating away from a monorepo.
• Fixed crashes when writing a very deeply nested Instance to a file. (#62)
• Fixed not being able to read & write to WebSocket objects at the same time. (#68)
• Fixed tab character at the start of a script causing it not to parse correctly. (#72)

0.7.4 - July 7th, 2023

Added

• Added support for CFrame and Font types in attributes when using the roblox builtin.

Fixed

• Fixed roblox.serializeModel still keeping some unique ids.

0.7.3 - July 5th, 2023

Changed

• When using roblox.serializeModel, Lune will no longer keep internal unique ids.
  This is consistent with what Roblox does and prevents Lune from always generating a new and unique file.
  This previously caused unnecessary diffs when using git or other kinds of source control. (Relevant issue)

0.7.2 - June 28th, 2023

Added

• Added support for init files in directories, similar to Rojo, or index.js / mod.rs in JavaScript / Rust.
  This means that placing a file named init.luau or init.lua in a directory will now let you require that directory.

Changed

• The lune --setup command is now much more user-friendly.
• Update to Luau version 0.581

0.7.1 - June 17th, 2023

Added

• Added support for TLS in websockets, enabling usage of wss://-prefixed URLs. (#57)

Fixed

• Fixed closeCode erroring when being accessed on websockets. (#57)
• Fixed issues with UniqueId when using the roblox builtin by downgrading rbx-dom.

0.7.0 - June 12th, 2023

Breaking Changes

• Globals for the fs, net, process, stdio, and task builtins have been removed, and the require("@lune/...") syntax is now the only way to access builtin libraries. If you have previously been using a global such as fs directly, you will now need to put local fs = require("@lune/fs") at the top of the file instead.

• Migrated several functions in the roblox builtin to new, more flexible APIs:

  • readPlaceFile -> deserializePlace
  • readModelFile -> deserializeModel
  • writePlaceFile -> serializePlace
  • writeModelFile -> serializeModel

  These new APIs no longer use file paths, meaning to use them with files you must first read them using the fs builtin.

• Removed CollectionService and its methods from the roblox builtin library - new instance methods have been added as replacements.

• Removed Instance:FindFirstDescendant which was a method that was never enabled in the official Roblox API and will soon be removed.
  Use the second argument of the already existing find methods instead to find descendants.

• Removed the global printinfo function - it was generally not used, and did not work as intended. Use the stdio builtin for formatting and logging instead.

• Removed support for Windows on ARM - it's more trouble than its worth right now, we may revisit it later.

Added

• Added serde.compress and serde.decompress for compressing and decompressing strings using one of several compression formats: brotli, gzip, lz4, or zlib.

  Example usage:

  local INPUT = string.rep("Input string to compress", 16) -- Repeated string 16 times for the purposes of this example
  
  local serde = require("@lune/serde")
  
  local compressed = serde.compress("gzip", INPUT)
  local decompressed = serde.decompress("gzip", compressed)
  
  assert(decompressed == INPUT)

• Added automatic decompression for compressed responses when using net.request. This behavior can be disabled by passing options = { decompress = false } in request params.

• Added support for finding scripts in the current home directory. This means that if you have a script called script-name.luau, you can place it in the following location:

  • C:\Users\YourName\.lune\script-name.luau (Windows)
  • /Users/YourName/.lune/script-name.luau (macOS)
  • /home/YourName/.lune/script-name.luau (Linux)

  And then run it using lune script-name from any directory you are currently in.

• Added several new instance methods in the roblox builtin library:

  • Instance:AddTag
  • Instance:GetTags
  • Instance:HasTag
  • Instance:RemoveTag

• Implemented the second argument of the FindFirstChild / FindFirstChildOfClass / FindFirstChildWhichIsA instance methods.

Changed

• Update to Luau version 0.579
• Both stdio.write and stdio.ewrite now support writing arbitrary bytes, instead of only valid UTF-8.

Fixed

• Fixed stdio.write and stdio.ewrite not being flushed and causing output to be interleaved. (#47)
• Fixed typeof returning userdata for roblox types such as Instance, Vector3, ...

0.6.7 - May 14th, 2023

Added

• Replaced all of the separate typedef & documentation generation commands with a unified lune --setup command.

  This command will generate type definition files for all of the builtins and will work with the new require("@lune/...") syntax. Note that this also means that there is no longer any way to generate type definitions for globals - this is because they will be removed in the next major release in favor of the beforementioned syntax.

• New releases now include prebuilt binaries for arm64 / aarch64!
  These new binaries will have names with the following format:

  • lune-windows-0.6.7-aarch64.exe
  • lune-linux-0.6.7-aarch64
  • lune-macos-0.6.7-aarch64

• Added global types to documentation site

0.6.6 - April 30th, 2023

Added

• Added tracing / logging for rare and hard to diagnose error cases, which can be configured using the env var RUST_LOG.

Changed

• The _VERSION global now follows a consistent format Lune x.y.z+luau to allow libraries to check against it for version requirements.

  Examples:

  • Lune 0.0.0+0
  • Lune 1.0.0+500
  • Lune 0.11.22+9999

• Updated to Luau version 0.573

• Updated rbx-dom to support reading and writing Font datatypes

Fixed

• Fixed _G not being a readable & writable table
• Fixed _G containing normal globals such as print, math, ...
• Fixed using instances as keys in tables

0.6.5 - March 27th, 2023

Changed

• Functions such as print, warn, ... now respect __tostring metamethods.

Fixed

• Fixed access of roblox instance properties such as Workspace.Terrain, game.Workspace that are actually links to child instances.
  These properties are always guaranteed to exist, and they are not always properly set, meaning they must be found through an internal lookup.
• Fixed issues with the CFrame.lookAt and CFrame.new(Vector3, Vector3) constructors.
• Fixed issues with CFrame math operations returning rotation angles in the wrong order.

0.6.4 - March 26th, 2023

Fixed

• Fixed instances with attributes not saving if they contain integer attributes.
• Fixed attributes not being set properly if the instance has an empty attributes property.
• Fixed error messages for reading & writing roblox files not containing the full error message.
• Fixed crash when trying to access an instance reference property that points to a destroyed instance.
• Fixed crash when trying to save instances that contain unsupported attribute types.

0.6.3 - March 26th, 2023

Added

• Added support for instance tags & CollectionService in the roblox built-in.
  Currently implemented methods are listed on the docs site.

Fixed

• Fixed accessing a destroyed instance printing an error message even if placed inside a pcall.
• Fixed cloned instances not having correct instance reference properties set (ObjectValue.Value, Motor6D.Part0, ...)
• Fixed Instance::GetDescendants returning the same thing as Instance::GetChildren.

0.6.2 - March 25th, 2023

This release adds some new features and fixes for the roblox built-in.

Added

• Added GetAttribute, GetAttributes and SetAttribute methods for instances.
• Added support for getting & setting properties that are instance references.

Changed

• Improved handling of optional property types such as optional cframes & default physical properties.

Fixed

• Fixed handling of instance properties that are serialized as binary strings.

0.6.1 - March 22nd, 2023

Fixed

• Fixed writePlaceFile and writeModelFile in the new roblox built-in making mysterious "ROOT" instances.

0.6.0 - March 22nd, 2023

Added

• Added a roblox built-in

  If you're familiar with Remodel, this new built-in contains more or less the same APIs, integrated into Lune.
  There are just too many new APIs to list in this changelog, so head over to the docs sit to learn more!

• Added a serde built-in

  This built-in contains previously available functions encode and decode from the net global.
  The plan is for this built-in to contain more serialization and encoding functionality in the future.

• require has been reimplemented and overhauled in several ways:

  • New built-ins such as roblox and serde can only be imported using require("@lune/roblox"), require("@lune/serde"), ...
  • Previous globals such as fs, net and others can now also be imported using require("@lune/fs"), require("@lune/net"), ...
  • Requiring a script is now completely asynchronous and will not block lua threads other than the caller.
  • Requiring a script will no longer error when using async APIs in the main body of the required script.

  All new built-ins will be added using this syntax and new built-ins will no longer be available in the global scope, and current globals will stay available as globals until proper editor and LSP support is available to ensure Lune users have a good development experience. This is the first step towards moving away from adding each library as a global, and allowing Lune to have more built-in libraries in general.

  Behavior otherwise stays the same, and requires are still relative to file unless the special @ prefix is used.

• Added net.urlEncode and net.urlDecode for URL-encoding and decoding strings

Changed

• Renamed the global info function to printinfo to make it less ambiguous

Removed

• Removed experimental net.encode and net.decode functions, since they are now available using require("@lune/serde")
• Removed option to preserve default Luau require behavior

0.5.6 - March 11th, 2023

Added

• Added support for shebangs at the top of a script, meaning scripts such as this one will now run without throwing a syntax error:

  #!/usr/bin/env lune
  
  print("Hello, world!")

Fixed

• Fixed fs.writeFile and fs.readFile not working with strings / files that are invalid utf-8

0.5.5 - March 8th, 2023

Added

• Added support for running scripts by passing absolute file paths in the CLI
  • This does not have the restriction of scripts having to use the .luau or .lua extension, since it is presumed that if you pass an absolute path you know exactly what you are doing

Changed

• Improved error messages for passing invalid file names / file paths substantially - they now include helpful formatting to make file names distinct from file extensions, and give suggestions on how to solve the problem
• Improved general formatting of error messages, both in the CLI and for Luau scripts being run

Fixed

• Fixed the CLI being a bit too picky about file names when trying to run files in lune or .lune directories
• Fixed documentation misses from large changes made in version 0.5.0

0.5.4 - March 7th, 2023

Added

• Added support for reading scripts from stdin by passing "-" as the script name
• Added support for close codes in the net WebSocket APIs:
  • A close code can be sent by passing it to socket.close
  • A received close code can be checked with the socket.closeCode value, which is populated after a socket has been closed - note that using socket.close will not set the close code value, it is only set when received and is guaranteed to exist after closure

Changed

• Update to Luau version 0.566

Fixed

• Fixed scripts having to be valid utf8, they may now use any kind of encoding that base Luau supports
• The net WebSocket APIs will no longer return nil for partial messages being received in socket.next, and will instead wait for the full message to arrive

0.5.3 - February 26th, 2023

Fixed

• Fixed lune --generate-selene-types generating an invalid Selene definitions file
• Fixed type definition parsing issues on Windows

0.5.2 - February 26th, 2023

Fixed

• Fixed crash when using stdio.color() or stdio.style() in a CI environment or non-interactive terminal

0.5.1 - February 25th, 2023

Added

• Added net.encode and net.decode which are equivalent to net.jsonEncode and net.jsonDecode, but with support for more formats.

  WARNING: Unstable API

  This API is unstable and may change or be removed in the next major version of Lune. The purpose of making a new release with these functions is to gather feedback from the community, and potentially replace the JSON-specific encoding and decoding utilities.

  Example usage:

  local toml = net.decode("toml", [[
  [package]
  name = "my-cool-toml-package"
  version = "0.1.0"
  
  [values]
  epic = true
  ]])
  
  assert(toml.package.name == "my-cool-toml-package")
  assert(toml.package.version == "0.1.0")
  assert(toml.values.epic == true)

Fixed

• Fixed indentation of closing curly bracket when printing tables

0.5.0 - February 23rd, 2023

Added

• Added auto-generated API reference pages and documentation using GitHub wiki pages

• Added support for query in net.request parameters, which enables usage of query parameters in URLs without having to manually URL encode values.

• Added a new function fs.move to move / rename a file or directory from one path to another.

• Implemented a new task scheduler which resolves several long-standing issues:

  • Issues with yielding across the C-call/metamethod boundary no longer occur when calling certain async APIs that Lune provides.
  • Ordering of interleaved calls to task.spawn/task.defer is now completely deterministic, deferring is now guaranteed to run last even in these cases.
  • The minimum wait time possible when using task.wait and minimum delay time using task.delay are now much smaller, and only limited by the underlying OS implementation. For most systems this means task.wait and task.delay are now accurate down to about 5 milliseconds or less.

Changed

• Type definitions are now bundled as part of the Lune executable, meaning they no longer need to be downloaded.
  • lune --generate-selene-types will generate the Selene type definitions file, replacing lune --download-selene-types
  • lune --generate-luau-types will generate the Luau type definitions file, replacing lune --download-luau-types
• Improved accuracy of Selene type definitions, strongly typed arrays are now used where possible
• Improved error handling and messages for net.serve
• Improved error handling and messages for stdio.prompt
• File path representations on Windows now use legacy paths instead of UNC paths wherever possible, preventing some confusing cases where file paths don't work as expected

Fixed

• Fixed process.cwd not having the correct ending path separator on Windows
• Fixed remaining edge cases where the task and coroutine libraries weren't interoperable
• Fixed task.delay keeping the script running even if it was cancelled using task.cancel
• Fixed stdio.prompt blocking all other lua threads while prompting for input

0.4.0 - February 11th, 2023

Added

• Web Sockets

  net now supports web sockets for both clients and servers!
  Note that the web socket object is identical on both client and server, but how you retrieve a web socket object is different.

  Server API

  The server web socket API is an extension of the existing net.serve function.
  This allows for serving both normal HTTP requests and web socket requests on the same port.

  Example usage:

  net.serve(8080, {
      handleRequest = function(request)
          return "Hello, world!"
      end,
      handleWebSocket = function(socket)
          task.delay(10, function()
              socket.send("Timed out!")
              socket.close()
          end)
          -- The message will be nil when the socket has closed
          repeat
              local messageFromClient = socket.next()
              if messageFromClient == "Ping" then
                  socket.send("Pong")
              end
          until messageFromClient == nil
      end,
  })

  Client API

  Example usage:

  local socket = net.socket("ws://localhost:8080")
  
  socket.send("Ping")
  
  task.delay(5, function()
      socket.close()
  end)
  
  -- The message will be nil when the socket has closed
  repeat
      local messageFromServer = socket.next()
      if messageFromServer == "Ping" then
          socket.send("Pong")
      end
  until messageFromServer == nil

Changed

• net.serve now returns a NetServeHandle which can be used to stop serving requests safely.

  Example usage:

  local handle = net.serve(8080, function()
      return "Hello, world!"
  end)
  
  print("Shutting down after 1 second...")
  task.wait(1)
  handle.stop()
  print("Shut down succesfully")

• The third and optional argument of process.spawn is now a global type ProcessSpawnOptions.

• Setting cwd in the options for process.spawn to a path starting with a tilde (~) will now use a path relative to the platform-specific home / user directory.

• NetRequest query parameters value has been changed to be a table of key-value pairs similar to process.env. If any query parameter is specified more than once in the request url, the value chosen will be the last one that was specified.

• The internal http client for net.request now reuses headers and connections for more efficient requests.

• Refactored the Lune rust crate to be much more user-friendly and documented all of the public functions.

Fixed

• Fixed process.spawn blocking all lua threads if the spawned child process yields.

0.3.0 - February 6th, 2023

Added

• Added a new global stdio which replaces console

• Added stdio.write which writes a string directly to stdout, without any newlines

• Added stdio.ewrite which writes a string directly to stderr, without any newlines

• Added stdio.prompt which will prompt the user for different kinds of input

  Example usage:

  local text = stdio.prompt()
  
  local text2 = stdio.prompt("text", "Please write some text")
  
  local didConfirm = stdio.prompt("confirm", "Please confirm this action")
  
  local optionIndex = stdio.prompt("select", "Please select an option", { "one", "two", "three" })
  
  local optionIndices = stdio.prompt(
      "multiselect",
      "Please select one or more options",
      { "one", "two", "three", "four", "five" }
  )

Changed

• Migrated console.setColor/resetColor and console.setStyle/resetStyle to stdio.color and stdio.style to allow for more flexibility in custom printing using ANSI color codes. Check the documentation for new usage and behavior.
• Migrated the pretty-printing and formatting behavior of console.log/info/warn/error to the standard Luau printing functions.

Removed

• Removed printing functions console.log/info/warn/error in favor of regular global functions for printing.

Fixed

• Fixed scripts hanging indefinitely on error

0.2.2 - February 5th, 2023

Added

• Added global types for networking & child process APIs
  • net.request gets NetFetchParams and NetFetchResponse for its argument and return value
  • net.serve gets NetRequest and NetResponse for the handler function argument and return value
  • process.spawn gets ProcessSpawnOptions for its third and optional parameter

Changed

• Reorganize repository structure to take advantage of cargo workspaces, improves compile times

0.2.1 - February 3rd, 2023

Added

• Added support for string interpolation syntax (update to Luau 0.561)

• Added network server functionality using net.serve

  Example usage:

  net.serve(8080, function(request)
      print(`Got a {request.method} request at {request.path}!`)
  
      local data = net.jsonDecode(request.body)
  
      -- For simple text responses with a 200 status
      return "OK"
  
      -- For anything else
      return {
          status = 203,
          headers = { ["Content-Type"] = "application/json" },
          body = net.jsonEncode({
              message = "echo",
              data = data,
          })
      }
  end)

Changed

• Improved type definitions file for Selene, now including constants like process.env + tags such as readonly and mustuse wherever applicable

Fixed

• Fixed type definitions file for Selene not including all API members and parameters
• Fixed process.exit exiting at the first yield instead of exiting instantly as it should

0.2.0 - January 28th, 2023

Added

• Added full documentation for all global APIs provided by Lune! This includes over 200 lines of pure documentation about behavior & error cases for all of the current 35 constants & functions. Check the README to find out how to enable documentation in your editor.

• Added a third argument options for process.spawn:

  • cwd - The current working directory for the process
  • env - Extra environment variables to give to the process
  • shell - Whether to run in a shell or not - set to true to run using the default shell, or a string to run using a specific shell
  • stdio - How to treat output and error streams from the child process - set to "inherit" to pass output and error streams to the current process

• Added process.cwd, the path to the current working directory in which the Lune script is running

0.1.3 - January 25th, 2023

Added

• Added a --list subcommand to list scripts found in the lune or .lune directory.

0.1.2 - January 24th, 2023

Added

• Added automatic publishing of the Lune library to crates.io

Fixed

• Fixed scripts that terminate instantly sometimes hanging

0.1.1 - January 24th, 2023

Fixed

• Fixed errors containing ./ and / or ../ in the middle of file paths
• Potential fix for spawned processes that yield erroring with "attempt to yield across metamethod/c-call boundary"

0.1.0 - January 24th, 2023

Added

• task now supports passing arguments in task.spawn / task.delay / task.defer
• require now uses paths relative to the file instead of being relative to the current directory, which is consistent with almost all other languages but not original Lua / Luau - this is a breaking change but will allow for proper packaging of third-party modules and more in the future.
  • NOTE: If you still want to use the default Lua behavior instead of relative paths, set the environment variable LUAU_PWD_REQUIRE to true

Changed

• Improved error message when an invalid file path is passed to require
• Much improved error formatting and stack traces

Fixed

• Fixed downloading of type definitions making json files instead of the proper format
• Process termination will now always make sure all lua state is cleaned up before exiting, in all cases

0.0.6 - January 23rd, 2023

Added

• Initial implementation of Roblox's task library, with some caveats:

  • Minimum wait / delay time is currently set to 10ms, subject to change
  • It is not yet possible to pass arguments to tasks created using task.spawn / task.delay / task.defer
  • Timings for task.defer are flaky and deferred tasks are not (yet) guaranteed to run after spawned tasks

  With all that said, everything else should be stable!

  • Mixing and matching the coroutine library with task works in all cases
  • process.exit() will stop all spawned / delayed / deferred threads and exit the process
  • Lune is guaranteed to keep running until there are no longer any waiting threads

  If any of the abovementioned things do not work as expected, it is a bug, please file an issue!

Fixed

• Potential fix for spawned processes that yield erroring with "attempt to yield across metamethod/c-call boundary"

0.0.5 - January 22nd, 2023

Added

• Added full test suites for all Lune globals to ensure correct behavior
• Added library version of Lune that can be used from other Rust projects

Changed

• Large internal changes to allow for implementing the task library.
• Improved general formatting of errors to make them more readable & glanceable
• Improved output formatting of non-primitive types
• Improved output formatting of empty tables

Fixed

• Fixed double stack trace for certain kinds of errors

0.0.4 - January 21st, 2023

Added

• Added process.args for inspecting values given to Lune when running (read only)
• Added process.env which is a plain table where you can get & set environment variables

Changed

• Improved error formatting & added proper file name to stack traces

Removed

• Removed ... for process arguments, use process.args instead
• Removed individual functions for getting & setting environment variables, use process.env instead

0.0.3 - January 20th, 2023

Added

• Added networking functions under net

  Example usage:

  local apiResult = net.request({
  	url = "https://jsonplaceholder.typicode.com/posts/1",
  	method = "PATCH",
  	headers = {
  		["Content-Type"] = "application/json",
  	},
  	body = net.jsonEncode({
  		title = "foo",
  		body = "bar",
  	}),
  })
  
  local apiResponse = net.jsonDecode(apiResult.body)
  assert(apiResponse.title == "foo", "Invalid json response")
  assert(apiResponse.body == "bar", "Invalid json response")

• Added console logging & coloring functions under console

  This piece of code:

  local tab = { Integer = 1234, Hello = { "World" } }
  console.log(tab)

  Will print the following formatted text to the console, with syntax highlighting:

  {
      Integer = 1234,
      Hello = {
          "World",
      }
  }

  Additional utility functions exist with the same behavior but that also print out a colored tag together with any data given to them: console.info, console.warn, console.error - These print out prefix tags [INFO], [WARN], [ERROR] in blue, orange, and red, respectively.

Changed

• The json api is now part of net
  • json.encode becomes net.jsonEncode
  • json.decode become net.jsonDecode

Fixed

• Fixed JSON decode not working properly

0.0.2 - January 19th, 2023

Added

• Added support for command-line parameters to scripts

  These can be accessed as a vararg in the root of a script:

  local firstArg: string, secondArg: string = ...
  print(firstArg, secondArg)

• Added CLI parameters for downloading type definitions:

  • lune --download-selene-types to download Selene types to the current directory
  • lune --download-luau-types to download Luau types to the current directory

  These files will be downloaded as lune.yml and luneTypes.d.luau respectively and are also available in each release on GitHub.

0.0.1 - January 18th, 2023

Initial Release