change namespace

Author: AndreLouisIssa

CHANGELOG.md

@@ -22,15 +22,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 
 - Fixed `import_as_fallback` and `import_as_shared`, so they can be hot reloaded in some situations
-- Fixed some usage examples in the definitions from `SGG_Modding-ENVY-auto`
+- Fixed some usage examples in the definitions from `LuaENVY-ENVY-auto`
 
 ## [1.0.0] - 2024-05-15
 
 ### Added
 
 - Initial Thunderstore release.
 
-[unreleased]: https://github.com/SGG-Modding/ENVY/compare/1.1.0...HEAD
-[1.1.0]: https://github.com/SGG-Modding/ENVY/compare/1.0.1...1.1.0
-[1.0.1]: https://github.com/SGG-Modding/ENVY/compare/1.0.0...1.0.1
-[1.0.0]: https://github.com/SGG-Modding/ENVY/compare/6da071b5c4c8bb4458ed7ea5cb23e7f83d332911...1.0.0
+[unreleased]: https://github.com/LuaENVY/ENVY/compare/1.1.0...HEAD
+[1.1.0]: https://github.com/LuaENVY/ENVY/compare/1.0.1...1.1.0
+[1.0.1]: https://github.com/LuaENVY/ENVY/compare/1.0.0...1.0.1
+[1.0.0]: https://github.com/LuaENVY/ENVY/compare/6da071b5c4c8bb4458ed7ea5cb23e7f83d332911...1.0.0

README.md

@@ -1,2 +1,2 @@
 # ENVY
-A plugin to allow [ReturnOfModding](https://github.com/SGG-Modding/Hell2Modding) plugins greater control of their environment, helpful when you need to share information between multiple files in your plugin.
+A plugin to allow ReturnOfModding plugins greater control of their environment, helpful when you need to share information between multiple files in your plugin.

src/def.lua

@@ -1,23 +1,23 @@
----@meta SGG_Modding-ENVY
+---@meta LuaENVY-ENVY
 local envy = {}
 
----@alias SGG_Modding-ENVY*file userdata|table|string|fun(...): table
+---@alias LuaENVY-ENVY*file userdata|table|string|fun(...): table
 
 --[[ 
           Definition of `getfenv` in lua 5.2 for convenience
 --]]
 ---@param fn integer | function? chunk function or stack level
 ---@return table? env environment the chunk uses
 function envy.getfenv( fn ) end
----@alias SGG_Modding-ENVY.getfenv ...
+---@alias LuaENVY-ENVY.getfenv ...
 
 --[[ 
           Definition of `setfenv` in lua 5.2 for convenience
 --]]
 ---@param fn integer | function? chunk function or stack level
 ---@param env table? environment to set the chunk to use
 function envy.setfenv( fn, env ) end
----@alias SGG_Modding-ENVY.setfenv ...
+---@alias LuaENVY-ENVY.setfenv ...
 
 
 --[[
@@ -32,12 +32,12 @@ function envy.setfenv( fn, env ) end
         result.value = 2; print(value) -- 2
         print(result.binder == binder) -- true
 --]]
----@see SGG_Modding-ENVY.import_all to shallow copy into an environment
----@see SGG_Modding-ENVY.import_as_fallback to use the result as a fallback
+---@see LuaENVY-ENVY.import_all to shallow copy into an environment
+---@see LuaENVY-ENVY.import_as_fallback to use the result as a fallback
 ---@param binder function|integer? function to export locals
 ---@return table result table bound to the upvalues <br/>
 function envy.export( binder ) end
----@alias SGG_Modding-ENVY.export ...
+---@alias LuaENVY-ENVY.export ...
 
 
 --[[
@@ -49,18 +49,18 @@ function envy.export( binder ) end
     Usage:
         local helper = import(_ENV,"helper.lua")
 --]]
----@see SGG_Modding-ENVY.export to share locals from the file
----@see SGG_Modding-ENVY.import_all like python's `import *`
----@see SGG_Modding-ENVY.import_as_fallback `import_all`, without shallow copy
+---@see LuaENVY-ENVY.export to share locals from the file
+---@see LuaENVY-ENVY.import_all like python's `import *`
+---@see LuaENVY-ENVY.import_as_fallback `import_all`, without shallow copy
 ---@param env table environment (typically a plugin)
----@param file SGG_Modding-ENVY*file path relative to plugin, absolute path, file handle, chunk function, or module table
+---@param file LuaENVY-ENVY*file path relative to plugin, absolute path, file handle, chunk function, or module table
 ---@param fenv table? environment to give the function (not relevant if a module table was given)
 ---@param level integer? stack level to send errors to
 ---@param ... any arguments passed in to the chunk function (if relevant)
 ---@return table data return value from the file/module
 ---@return any ... additional return values from the file/module <br/>
 function envy.import(env,file,fenv,level,...) end
----@alias SGG_Modding-ENVY.import ...
+---@alias LuaENVY-ENVY.import ...
 
 --[[
           Uses `import` to get the data from a lua file/module,
@@ -70,15 +70,15 @@ function envy.import(env,file,fenv,level,...) end
     Usage:
         import_all(_ENV,"util.lua")
 --]]
----@see SGG_Modding-ENVY.import how it obtains the data from the file/module
----@see SGG_Modding-ENVY.import_as_fallback this, but without shallow copying.
----@see SGG_Modding-ENVY.import_as_shared*auto this, but writes fallback as well.
+---@see LuaENVY-ENVY.import how it obtains the data from the file/module
+---@see LuaENVY-ENVY.import_as_fallback this, but without shallow copying.
+---@see LuaENVY-ENVY.import_as_shared*auto this, but writes fallback as well.
 ---@param env table environment (typically a plugin)
----@param file SGG_Modding-ENVY*file path relative to plugin, absolute path, file handle, chunk function, or module table
+---@param file LuaENVY-ENVY*file path relative to plugin, absolute path, file handle, chunk function, or module table
 ---@param fenv table? environment to give the function (not relevant if a module table was given)
 ---@param level integer? stack level to send errors to <br/>
 function envy.import_all(env,file,fenv,level,...) end
----@alias SGG_Modding-ENVY.import_all ...
+---@alias LuaENVY-ENVY.import_all ...
 
 --[[
           Uses `import` to get the data from a lua file/module,
@@ -89,14 +89,14 @@ function envy.import_all(env,file,fenv,level,...) end
     Usage:
         import_all_fallback(_ENV,"shell.lua")
 --]]
----@see SGG_Modding-ENVY.import how it obtains the data from the file/module
----@see SGG_Modding-ENVY.import_all this, but by shallow copying.
+---@see LuaENVY-ENVY.import how it obtains the data from the file/module
+---@see LuaENVY-ENVY.import_all this, but by shallow copying.
 ---@param env table environment (typically a plugin)
----@param file SGG_Modding-ENVY*file path relative to plugin, absolute path, file handle, chunk function, or module table
+---@param file LuaENVY-ENVY*file path relative to plugin, absolute path, file handle, chunk function, or module table
 ---@param fenv table? environment to give the function (not relevant if a module table was given)
 ---@param level integer? stack level to send errors to <br/>
 function envy.import_as_fallback(env,file,fenv,level,...) end
----@alias SGG_Modding-ENVY.import_as_fallback ...
+---@alias LuaENVY-ENVY.import_as_fallback ...
 
 --[[
           Uses `import` to get *and set* the data from a lua file/module,
@@ -107,15 +107,15 @@ function envy.import_as_fallback(env,file,fenv,level,...) end
     Usage:
         import_as_shared(_ENV,"state.lua")
 --]]
----@see SGG_Modding-ENVY.import how it obtains the data from the file/module
----@see SGG_Modding-ENVY.import_all this, but by shallow copying.
----@see SGG_Modding-ENVY.import_as_shared this, but writes don't fallback.
+---@see LuaENVY-ENVY.import how it obtains the data from the file/module
+---@see LuaENVY-ENVY.import_all this, but by shallow copying.
+---@see LuaENVY-ENVY.import_as_shared this, but writes don't fallback.
 ---@param env table environment (typically a plugin)
----@param file SGG_Modding-ENVY*file path relative to plugin, absolute path, file handle, chunk function, or module table
+---@param file LuaENVY-ENVY*file path relative to plugin, absolute path, file handle, chunk function, or module table
 ---@param fenv table? environment to give the function (not relevant if a module table was given)
 ---@param level integer? stack level to send errors to <br/>
 function envy.import_as_shared(env,file,fenv,level,...) end
----@alias SGG_Modding-ENVY.import_as_shared ...
+---@alias LuaENVY-ENVY.import_as_shared ...
 
 --[[
           The extras are: 
@@ -128,11 +128,11 @@ function envy.import_as_shared(env,file,fenv,level,...) end
         local _ENV, ext = setup(_ENV)
         import_all(_ENV,ext)
 --]]
----@class SGG_Modding-ENVY*extras: table
----@field public import fun(file: SGG_Modding-ENVY*file, fenv: table?,...): table loads a lua file/module relative to *your* plugin.
----@field public import_all fun(file: SGG_Modding-ENVY*file, fenv: table?,...) uses `import` to get the data from a lua file/module (shallow copied into *your* environment).
----@field public import_as_shared fun(file: SGG_Modding-ENVY*file, fenv: table?,...) uses `import` to get the data from a lua file/module (as fallback to *your* environment).
----@field public import_as_fallback fun(file: SGG_Modding-ENVY*file, fenv: table?,...) uses `import` to get the data from a lua file/module (as a fallback with linked writes from *your* environment).
+---@class LuaENVY-ENVY*extras: table
+---@field public import fun(file: LuaENVY-ENVY*file, fenv: table?,...): table loads a lua file/module relative to *your* plugin.
+---@field public import_all fun(file: LuaENVY-ENVY*file, fenv: table?,...) uses `import` to get the data from a lua file/module (shallow copied into *your* environment).
+---@field public import_as_shared fun(file: LuaENVY-ENVY*file, fenv: table?,...) uses `import` to get the data from a lua file/module (as fallback to *your* environment).
+---@field public import_as_fallback fun(file: LuaENVY-ENVY*file, fenv: table?,...) uses `import` to get the data from a lua file/module (as a fallback with linked writes from *your* environment).
 ---@field public export fun(binder: function|integer?): result: table exports locals by using a function bound to them as upvalues.
 ---@field public private table the new 'private' environment
 ---@field public public table the original 'public' environment
@@ -160,28 +160,28 @@ function envy.import_as_shared(env,file,fenv,level,...) end
         local _ENV, ext = setup(_ENV)
         import_all(_ENV,ext)
 --]]
----@see SGG_Modding-ENVY*extras
----@see SGG_Modding-ENVY.auto
----@see SGG_Modding-ENVY.import_all
+---@see LuaENVY-ENVY*extras
+---@see LuaENVY-ENVY.auto
+---@see LuaENVY-ENVY.import_all
 ---@return table newenv
----@return SGG_Modding-ENVY*extras extras
+---@return LuaENVY-ENVY*extras extras
 function envy.setup(env) end
----@alias SGG_Modding-ENVY.setup ...
+---@alias LuaENVY-ENVY.setup ...
 
 --[[
           Finds the caller (at the stack `level`) to `setup` its environment and `import` all `extras`.
     
     Usage:
-        ---@module 'SGG_Modding-ENVY-auto'
+        ---@module 'LuaENVY-ENVY-auto'
         auto()
 --]]
----@see SGG_Modding-ENVY*extras
----@see SGG_Modding-ENVY.setup
----@see SGG_Modding-ENVY.import
+---@see LuaENVY-ENVY*extras
+---@see LuaENVY-ENVY.setup
+---@see LuaENVY-ENVY.import
 ---@param level integer?
----@return SGG_Modding-ENVY*extras extras
+---@return LuaENVY-ENVY*extras extras
 function envy.auto(level) end
----@alias SGG_Modding-ENVY.auto ...
+---@alias LuaENVY-ENVY.auto ...
 
 envy.globals = _G
 

src/def_auto.lua

@@ -1,4 +1,4 @@
----@meta SGG_Modding-ENVY-auto
+---@meta LuaENVY-ENVY-auto
 
 --[[
           Loads a lua file/module relative to *your* plugin.
@@ -9,16 +9,16 @@
     Usage:
         local helper = import("helper.lua")
 --]]
----@see SGG_Modding-ENVY-auto.export to share locals from the file
----@see SGG_Modding-ENVY-auto.import_all like python's `import *`
----@see SGG_Modding-ENVY-auto.import_as_fallback `import_all`, without shallow copy
----@param file SGG_Modding-ENVY*file path relative to plugin, absolute path, file handle, chunk function, or module table
+---@see LuaENVY-ENVY-auto.export to share locals from the file
+---@see LuaENVY-ENVY-auto.import_all like python's `import *`
+---@see LuaENVY-ENVY-auto.import_as_fallback `import_all`, without shallow copy
+---@param file LuaENVY-ENVY*file path relative to plugin, absolute path, file handle, chunk function, or module table
 ---@param fenv table? environment to give the function (not relevant if a module table was given)
 ---@param ... any arguments passed in to the chunk function (if relevant)
 ---@return table data return value from the file/module
 ---@return any ... additional return values from the file/module <br/>
 function import(file,fenv,...) end
----@alias SGG_Modding-ENVY-auto.import ...
+---@alias LuaENVY-ENVY-auto.import ...
 
 --[[
           Uses `import` to get the data from a lua file/module,
@@ -28,13 +28,13 @@ function import(file,fenv,...) end
     Usage:
         import_all("util.lua")
 --]]
----@see SGG_Modding-ENVY-auto.import how it obtains the data from the file/module
----@see SGG_Modding-ENVY-auto.import_as_fallback this, but without shallow copying.
----@param file SGG_Modding-ENVY*file path relative to plugin, absolute path, file handle, chunk function, or module table
+---@see LuaENVY-ENVY-auto.import how it obtains the data from the file/module
+---@see LuaENVY-ENVY-auto.import_as_fallback this, but without shallow copying.
+---@param file LuaENVY-ENVY*file path relative to plugin, absolute path, file handle, chunk function, or module table
 ---@param fenv table? environment to give the function (not relevant if a module table was given)
 ---@param ... any arguments passed in to the chunk function (if relevant) <br/>
 function import_all(file,fenv,...) end
----@alias SGG_Modding-ENVY-auto.import_all ...
+---@alias LuaENVY-ENVY-auto.import_all ...
 
 --[[
           Uses `import` to get the data from a lua file/module,
@@ -45,14 +45,14 @@ function import_all(file,fenv,...) end
     Usage:
         import_all_fallback("shell.lua")
 --]]
----@see SGG_Modding-ENVY-auto.import how it obtains the data from the file/module
----@see SGG_Modding-ENVY-auto.import_all this, but by shallow copying.
----@see SGG_Modding-ENVY-auto.import_as_shared this, but writes fallback as well.
----@param file SGG_Modding-ENVY*file path relative to plugin, absolute path, file handle, chunk function, or module table
+---@see LuaENVY-ENVY-auto.import how it obtains the data from the file/module
+---@see LuaENVY-ENVY-auto.import_all this, but by shallow copying.
+---@see LuaENVY-ENVY-auto.import_as_shared this, but writes fallback as well.
+---@param file LuaENVY-ENVY*file path relative to plugin, absolute path, file handle, chunk function, or module table
 ---@param fenv table? environment to give the function (not relevant if a module table was given)
 ---@param ... any arguments passed in to the chunk function (if relevant) <br/>
 function import_as_fallback(file,fenv,...) end
----@alias SGG_Modding-ENVY-auto.import_as_fallback ...
+---@alias LuaENVY-ENVY-auto.import_as_fallback ...
 
 --[[
           Uses `import` to get *and set* the data from a lua file/module,
@@ -63,14 +63,14 @@ function import_as_fallback(file,fenv,...) end
     Usage:
         import_as_shared("state.lua")
 --]]
----@see SGG_Modding-ENVY-auto.import how it obtains the data from the file/module
----@see SGG_Modding-ENVY-auto.import_all this, but by shallow copying.
----@see SGG_Modding-ENVY-auto.import_as_shared this, but writes don't fallback.
----@param file SGG_Modding-ENVY*file path relative to plugin, absolute path, file handle, chunk function, or module table
+---@see LuaENVY-ENVY-auto.import how it obtains the data from the file/module
+---@see LuaENVY-ENVY-auto.import_all this, but by shallow copying.
+---@see LuaENVY-ENVY-auto.import_as_shared this, but writes don't fallback.
+---@param file LuaENVY-ENVY*file path relative to plugin, absolute path, file handle, chunk function, or module table
 ---@param fenv table? environment to give the function (not relevant if a module table was given)
 ---@param ... any arguments passed in to the chunk function (if relevant) <br/>
 function import_as_shared(file,fenv,...) end
----@alias SGG_Modding-ENVY-auto.import_as_shared*auto ...
+---@alias LuaENVY-ENVY-auto.import_as_shared*auto ...
 
 --[[
           Exports locals by using a function bound to them as upvalues.
@@ -84,12 +84,12 @@ function import_as_shared(file,fenv,...) end
         result.value = 2; print(value) -- 2
         print(result.binder == binder) -- true
 --]]
----@see SGG_Modding-ENVY-auto.import_all to shallow copy into an environment
----@see SGG_Modding-ENVY-auto.import_as_fallback to use the result as a fallback
+---@see LuaENVY-ENVY-auto.import_all to shallow copy into an environment
+---@see LuaENVY-ENVY-auto.import_as_fallback to use the result as a fallback
 ---@param binder function|integer? function to export locals
 ---@return table result table bound to the upvalues <br/>
 function export( binder ) end
----@alias SGG_Modding-ENVY-auto.export ...
+---@alias LuaENVY-ENVY-auto.export ...
 
 -- the original 'public' environment
 public = _ENV

src/main.lua

@@ -488,7 +488,7 @@ end
 
 -- extending itself
 
----@module 'SGG_Modding-ENVY-auto'
+---@module 'LuaENVY-ENVY-auto'
 auto()
 
 for k,v in pairs(exports) do