Difference between revisions of "Module:Check for deprecated parameters"

From blackwiki
Jump to navigation Jump to search
blackwiki>Zackmann08
(WIP)
blackwiki>Zackmann08
Line 41: Line 41:
 
-- loop over the parent args, and make sure they are on the list
 
-- loop over the parent args, and make sure they are on the list
 
for k, v in pairs(pargs) do
 
for k, v in pairs(pargs) do
mw.log(k..'---'..v)
+
-- mw.log(k..'---'..v)
 
if dep_values[k] then
 
if dep_values[k] then
 
table.insert(values, k)
 
table.insert(values, k)
 
end
 
end
 
 
-- if type(k) == 'string' and knownargs[k] == nil then
 
-- local knownflag = false
 
-- for i, regexp in ipairs(regexps) do
 
-- if mw.ustring.match(k, regexp) then
 
-- knownflag = true
 
-- break
 
-- end
 
-- end
 
-- if not knownflag and ( not ignoreblank or isnotempty(v) )  then
 
-- k = mw.ustring.gsub(k, '[^%w\-_ ]', '?')
 
-- table.insert(values, k)
 
-- end
 
-- elseif type(k) == 'number' and
 
-- knownargs[tostring(k)] == nil and
 
-- ( showblankpos or isnotempty(v) )
 
-- then
 
-- local vlen = mw.ustring.len(v)
 
-- v = mw.ustring.sub(v, 1, (vlen < 25) and vlen or 25)
 
-- v = mw.ustring.gsub(v, '[^%w\-_ ]', '?')
 
-- table.insert(values, k .. ' = ' .. v .. ((vlen >= 25) and ' ...' or ''))
 
-- end
 
 
mw.logObject(values)
 
mw.logObject(values)
 
end
 
end
Line 76: Line 55:
 
end
 
end
 
for k, v in pairs(values) do
 
for k, v in pairs(values) do
 +
mw.log(k..'---'..v)
 +
mw.log(dep_values[v])
 
if v == '' then
 
if v == '' then
 
-- Fix odd bug for | = which gets stripped to the empty string and
 
-- Fix odd bug for | = which gets stripped to the empty string and
Line 81: Line 62:
 
v = ' '
 
v = ' '
 
end
 
end
local r =  deprecated:gsub('_VALUE_', v)
+
 +
local r =  deprecated:gsub('_VALUE_', (v..'. replace with "'..dep_values[v]..'"'))
 
table.insert(res, r)
 
table.insert(res, r)
 
end
 
end

Revision as of 19:44, 30 November 2018

This module may be appended to a template to check for uses of deprecated parameters. The purpose is to locate deprecated parameters, display a message and place the page in a specific category noting that it is deprecated.

Note: due to the nature of deprecations, this module will often have no templates implementing it.

Usage

{{#invoke:check for deprecated parameters|check
|category=[[Category:<category_name>|_VALUE_]]
| old_param1 = new_param1 
| old_param2 = new_param2
| ....
| old_paramN = new_paramN
}}

See also


-- This module may be used to compare the arguments passed to the parent
-- with a list of arguments, returning a specified result if an argument is
-- on the list
local p = {}

local function trim(s)
	return s:match('^%s*(.-)%s*$')
end

local function isnotempty(s)
	return s and trim(s) ~= ''
end

function p.check (frame)
	local args = frame.args
	local pargs = frame:getParent().args
	local ignoreblank = isnotempty(frame.args['ignoreblank'])
	local showblankpos = isnotempty(frame.args['showblankpositional'])
	local knownargs = {}
	local deprecated = frame.args['deprecated'] or 'Found _VALUE_, '
	local preview = frame.args['preview']

	local dep_values = {}
	local values = {}
	local res = {}
	local regexps = {}

	-- create the table of deprecated values and their matching new value
	for k, v in pairs(args) do
		if k == 'ignoreblank' or k == 'preview' or k == 'deprecated' then else
			dep_values[k] = v
		end
	end
	
	if isnotempty(preview) then 
		preview = '<div class="hatnote" style="color:red"><strong>Warning:</strong> ' .. preview .. ' (this message is shown only in preview).</div>'
	elseif preview == nil then
		preview = deprecated
	end

	-- loop over the parent args, and make sure they are on the list
	for k, v in pairs(pargs) do
		-- mw.log(k..'---'..v)
		if dep_values[k] then
			table.insert(values, k)
		end
		
		mw.logObject(values)
	end

	-- add resuls to the output tables
	if #values > 0 then
		if frame:preprocess( "{{REVISIONID}}" ) == "" then
			deprecated = preview
		end
		for k, v in pairs(values) do
			mw.log(k..'---'..v)
			mw.log(dep_values[v])
			if v == '' then
			-- Fix odd bug for | = which gets stripped to the empty string and
			-- breaks category links
			v = ' '
			end
			
			local r =  deprecated:gsub('_VALUE_', (v..'. replace with "'..dep_values[v]..'"'))
			table.insert(res, r)
		end
	end

	return table.concat(res)
end

return p