rename library

Author: ewd3v

README.md

@@ -1,6 +1,6 @@
-# Luau Hotreload
+# Graft
 
-[![GitHub License](https://img.shields.io/github/license/ewd3v/luau_hotreload)](https://opensource.org/licenses/MIT)
-[![CI Status](https://github.com/ewd3v/luau_hotreload/actions/workflows/ci.yaml/badge.svg)](https://github.com/ewd3v/luau_hotreload/actions/workflows/ci.yaml)
+[![GitHub License](https://img.shields.io/github/license/ewd3v/luau_graft)](https://opensource.org/licenses/MIT)
+[![CI Status](https://github.com/ewd3v/luau_graft/actions/workflows/ci.yaml/badge.svg)](https://github.com/ewd3v/luau_graft/actions/workflows/ci.yaml)
 
-> Hot reloading for luau
+> Hot reloading for Luau

pesde.lock

@@ -1,7 +1,7 @@
 # This file is automatically @generated by pesde.
 # It is not intended for manual editing.
 format = 2
-name = "ewdev/hotreload"
+name = "ewdev/graft"
 version = "0.0.0"
 target = "luau"
 

pesde.toml

@@ -1,8 +1,8 @@
-name = "ewdev/hotreload"
+name = "ewdev/graft"
 version = "0.0.0"
-description = "Hot reloading for luau"
+description = "Hot reloading for Luau"
 authors = ["EwDev (https://ewdev.net/)"]
-repository = "https://github.com/ewd3v/luau_hotreload"
+repository = "https://github.com/ewd3v/luau_graft"
 license = "MIT"
 includes = ["src/**", "pesde.toml", "LICENSE", "README.md", "fiu/Source.lua"]
 

src/init.luau

@@ -7,44 +7,44 @@ type Module = VM.Module
 type Settings = VM.Settings
 
 --[=[
-	@class HotReload
+	@class Graft
 
-	An object used to hold information relevant to hot reloading a certain Luau module / file / script.
+	An object used to hold information relevant for hot reloading a certain Luau module / file / script.
 ]=]
 
-local HotReload = {} :: impl
-HotReload.__index = HotReload
+local Graft = {} :: impl
+Graft.__index = Graft
 
 type self = {
 	Source: string,
 	Interface: Interface,
 	Module: Module?,
 
 	_waitingForModule: { thread },
-	_reloadThread: thread?,
+	_patchThread: thread?,
 	_main: ((...any) -> ...any)?,
 
 	Settings: Settings,
 }
 type impl = {
 	__index: impl,
 
-	new: (interface: Interface) -> HotReload,
+	new: (interface: Interface) -> Graft,
 
-	IsHotReloaded: () -> boolean,
-	Reload: (self: HotReload) -> (),
-	Run: (self: HotReload, ...any) -> ...any,
+	IsGrafted: () -> boolean,
+	Patch: (self: Graft) -> (),
+	Run: (self: Graft, ...any) -> ...any,
 }
 
-export type HotReload = typeof(setmetatable({} :: self, HotReload))
+export type Graft = typeof(setmetatable({} :: self, Graft))
 
 local function getDefaultSettings(): Settings
 	local settings = VM.luau_newsettings()
 
-	local isHotReloaded = HotReload.IsHotReloaded
+	local isGrafted = Graft.IsGrafted
 	settings.callHooks = {
 		callHook = function(func, ...)
-			if func ~= isHotReloaded then
+			if func ~= isGrafted then
 				return func, ...
 			end
 
@@ -58,53 +58,53 @@ local function getDefaultSettings(): Settings
 end
 
 --[=[
-	Creates a new [HotReload] object with the provided [Interface].
+	Creates a new [Graft] object with the provided [Interface].
 ]=]
-function HotReload.new(interface: Interface, source: string?): HotReload
-	local self = setmetatable({}, HotReload)
+function Graft.new(interface: Interface, source: string?): Graft
+	local self = setmetatable({}, Graft)
 
 	--[=[
-		@within HotReload
+		@within Graft
 		@prop Source string
 
 		The name / source of the Luau module thats being hot reloaded by this object.
 	]=]
 	self.Source = source or debug.info(2, "s")
 
 	--[=[
-		@within HotReload
+		@within Graft
 		@prop Interface Interface
 
-		A reference to the [Interface] used to create this HotReload object.
+		A reference to the [Interface] used to create this Graft object.
 	]=]
 	self.Interface = interface
 
 	--[=[
-		@within HotReload
+		@within Graft
 		@prop Module Module
 	]=]
 	self.Module = nil
 
 	--[=[
-		@within HotReload
+		@within Graft
 		@prop _waitingForBytecode { thread }
 		@private
 
-		A list of threads that are currently yielding and that should be resumed when [HotReload.Module] is available.
+		A list of threads that are currently yielding and that should be resumed when [Graft.Module] is available.
 	]=]
 	self._waitingForModule = {}
 
 	--[=[
-		@within HotReload
-		@prop _reloadThread thread
+		@within Graft
+		@prop _patchThread thread
 		@private
 
-		The thread that's currently fetching the updated code and reloading the code.
+		The thread that's currently fetching the updated code and patching the code.
 	]=]
-	self._reloadThread = nil
+	self._patchThread = nil
 
 	--[=[
-		@within HotReload
+		@within Graft
 		@prop _main ((...any) -> ...any)?
 		@private
 
@@ -113,35 +113,35 @@ function HotReload.new(interface: Interface, source: string?): HotReload
 	self._main = nil
 
 	--[=[
-		@within HotReload
+		@within Graft
 		@prop Settings Settings
 
 		The [Fiu] settings that should be used.
 	]=]
 	self.Settings = getDefaultSettings()
 
-	self:Reload()
+	self:Patch()
 	return self
 end
 
 --[=[
-	Returns true if the current environment is being hot reloaded.
-	If it is you shouldn't really try hot loading it again.
+	Returns true if the current environment can be hot reloaded with [Graft].
+	If it is you shouldn't try hot loading it again.
 ]=]
-function HotReload.IsHotReloaded(): boolean
+function Graft.IsGrafted(): boolean
 	return false
 end
 
-local function reload(self: HotReload)
+local function patch(self: Graft)
 	local bytecodeSuccess, bytecode = pcall(self.Interface.GetBytecode)
 	if not bytecodeSuccess then
-		print(`[HotReload] Failed to retrieve bytecode for {self.Source}: {bytecode}`)
+		print(`[Graft] Failed to retrieve bytecode for {self.Source}: {bytecode}`)
 		return
 	end
 
 	local deserializeSuccess, deserialized = pcall(VM.luau_deserialize, bytecode :: any, self.Settings)
 	if not deserializeSuccess then
-		print(`[HotReload] Failed to deserialize bytecode for {self.Source}: {deserialized}`)
+		print(`[Graft] Failed to deserialize bytecode for {self.Source}: {deserialized}`)
 	end
 
 	local module = self.Module
@@ -157,7 +157,7 @@ local function reload(self: HotReload)
 	end
 
 	local functionChangeError =
-		`[HotReload] Changing the amount of functions or rearranging them is not yet supported. Not hot reloading. (source: {self.Source})`
+		`[Graft] Changing the amount of functions or rearranging them is not yet supported. Not patching. (source: {self.Source})`
 
 	if #module.protoList ~= #deserialized.protoList then
 		print(functionChangeError)
@@ -168,7 +168,7 @@ local function reload(self: HotReload)
 		local dProto = deserialized.protoList[index]
 		if proto.nups ~= dProto.nups then
 			print(
-				`[HotReload] Changing the amount of upvalues that a function has is not yet supported. Not hot reloading. (line: {dProto.linedefined}, function name: {dProto.debugname}, source: {self.Source})`
+				`[Graft] Changing the amount of upvalues that a function has is not yet supported. Not patching. (line: {dProto.linedefined}, function name: {dProto.debugname}, source: {self.Source})`
 			)
 			return
 		end
@@ -184,7 +184,7 @@ local function reload(self: HotReload)
 		end
 	end
 
-	print(`[HotReload] Hot reloading {self.Source}`)
+	print(`[Graft] Patching {self.Source}`)
 
 	module.stringList = deserialized.stringList
 	module.typesVersion = deserialized.typesVersion
@@ -214,21 +214,21 @@ end
 --[=[
 	Asks the [Interface] for the updated source code and then hot reloads the code.
 ]=]
-function HotReload:Reload()
-	if self._reloadThread then
-		coroutine.close(self._reloadThread)
+function Graft:Patch()
+	if self._patchThread then
+		coroutine.close(self._patchThread)
 	end
 
-	self._reloadThread = coroutine.create(reload)
-	coroutine.resume(self._reloadThread :: any, self)
+	self._patchThread = coroutine.create(patch)
+	coroutine.resume(self._patchThread :: any, self)
 end
 
 --[=[
-	Runs the luau module.
+	Runs the Luau module.
 
 	@yields
 ]=]
-function HotReload:Run(...: any): ...any
+function Graft:Run(...: any): ...any
 	local module = self.Module
 	if not module then
 		table.insert(self._waitingForModule, coroutine.running())
@@ -242,4 +242,4 @@ function HotReload:Run(...: any): ...any
 	return (self._main :: any)(...)
 end
 
-return HotReload
+return Graft

src/interface.luau

@@ -3,10 +3,10 @@
 --[=[
 	@class Interface
 
-	An interface is required in order to create a [HotReload] object.
+	An interface is required in order to create a [Graft] object.
 	It provides all the required information to it that it needs in order to perform hot reloading (mainly watching for changes and reading / compiling code sources).
 
-	The main reason why this can't be included in the library by default is because raw luau can't actually read it's own source code or watch for io changes.
+	The main reason why this can't be included in the library by default is because pure Luau can't actually read it's own source code or watch for io changes.
 	Because of this, there's really no standard to the implementation that runtimes that do support this chooses to have.
 	
 	It's planned in the future to create packages for these runtimes which will implement this interface for you. Which will be listed here.
@@ -22,9 +22,9 @@ export type Interface = {
 	@return buffer
 	@yields
 
-	Function that will compile and return the bytecode of the luau module to run.
+	Function that will compile and return the bytecode of the Luau module to run.
 
-	This function may get called multiple times, once while constructing the [HotReload] object, and then whenever [HotReload:Reload] gets called.
+	This function may get called multiple times, once while constructing the [Graft] object, and then whenever [Graft:Patch] gets called.
 
 	The function may throw errors, in which case the error will get caught and hot reloading won't happen until the next reload.
 

src/vm.luau

@@ -2,7 +2,7 @@
 
 --[=[
 	@class VM
-	@external Fiu https://github.com/rce-incorporated/Fiu/blob/main/Source.lua
+	@external Fiu https://github.com/rce-incorporated/Fiu
 
 	[Fiu] VM
 ]=]

tests/init.luau

@@ -6,24 +6,24 @@ end
 local luau = require("@lune/luau")
 local task = require("@lune/task")
 
-local HotReload = require("./src")
+local Graft = require("./src")
 
 local sourcecode = [[
 local task = require("@lune/task")
-local HotReload, a, b = ...
+local Graft, a, b = ...
 local ret = { a, b }
 local function test()
 	table.insert(ret, "hi!")
 end
 test()
 task.wait(1)
 test()
-return HotReload.IsHotReloaded(), ret
+return Graft.IsGrafted(), ret
 ]]
 
 local sourcecode2 = [[
 local task = require("@lune/task")
-local HotReload, a, b = ...
+local Graft, a, b = ...
 local ret = { a, b }
 local function test()
 	table.insert(ret, "goodbye!")
@@ -32,10 +32,10 @@ end
 test()
 task.wait(1)
 test()
-return HotReload.IsHotReloaded(), ret
+return Graft.IsGrafted(), ret
 ]]
 
-local hotReload = HotReload.new({
+local graft = Graft.new({
 	GetBytecode = function(): buffer
 		print("compiling bytecode...")
 		return buffer.fromstring(luau.compile(sourcecode))
@@ -44,12 +44,12 @@ local hotReload = HotReload.new({
 
 task.defer(function()
 	sourcecode = sourcecode2
-	hotReload:Reload()
+	graft:Patch()
 end)
 
-local isHotReloaded, ret = hotReload:Run(HotReload, "test1", "test2")
-assert(isHotReloaded == true, ".IsHotReloaded() should return true in hot reloaded environments")
-assert(HotReload.IsHotReloaded() == false, ".IsHotReloaded() should return false outside hot reloaded environments")
+local isGrafted, ret = graft:Run(Graft, "test1", "test2")
+assert(isGrafted == true, ".IsGrafted() should return true in hot reloaded environments")
+assert(graft.IsGrafted() == false, ".IsGrafted() should return false outside hot reloaded environments")
 
 assert(#ret == 5, "bad return amount")
 assert(ret[1] == "test1", "bad return")