Module:Deprecated - Revision history

Awesome Aasim at 15:49, 30 March 2025

2025-03-30T15:49:00Z

← Previous revision		Revision as of 15:49, 30 March 2025
Line 1:		Line 1:
	--- Marks ~~functions~~ as deprecated, and provides a warning when they are called.		--- Marks items as deprecated, and provides a warning when they are called.
	-- @release alpha		-- @release alpha
	-- @author [[User:Awesome_Aasim\|Awesome Aasim]]		-- @author [[User:Awesome_Aasim\|Awesome Aasim]]

Awesome Aasim at 23:26, 27 March 2025

2025-03-27T23:26:07Z

← Previous revision		Revision as of 23:26, 27 March 2025
Line 30:		Line 30:
	warn(		warn(
	mw.ustring.format(		mw.ustring.format(
	"Deprecated member <code>%s</code> called ", index		"Deprecated member <code>%s</code> called. ", index
	) .. (		) .. (
	deprecatedTable[index]["replacement"]		deprecatedTable[index]["replacement"]

Awesome Aasim: module to mark modules or member items as deprecated

2025-03-21T01:53:59Z

module to mark modules or member items as deprecated

New page

--- Marks functions as deprecated, and provides a warning when they are called.
-- @release alpha
-- @author [[User:Awesome_Aasim|Awesome Aasim]]
-- @function deprecated
-- @param {table} p package frame
-- @param deprecatedTable
-- @return package

return function(p, deprecatedTable, replacement)
local pckg = {}
--- Warn
-- @param {string} text warning text
function warn(text)
local tb = debug.traceback()
mw.log(text .. '\n' .. tb)
mw.addWarning(text .. tb:gsub("\n", "<br/>"):gsub("\t", "&emsp;"))
end
if deprecatedTable == nil or deprecatedTable == true then
deprecatedTable = {}
for k,_ in pairs(p) do
deprecatedTable[k] = {
deprecated = true,
replacement = replacement or ""
}
end
end
setmetatable(pckg, {
__index = function(t, index)
if deprecatedTable[index] and deprecatedTable[index]["deprecated"] then
warn(
mw.ustring.format(
"Deprecated member <code>%s</code> called ", index
) .. (
deprecatedTable[index]["replacement"]
and mw.ustring.format("Please %s instead.", deprecatedTable[index]["replacement"])
or ''
)
)
end
return p[index]
end
})
return pckg
end