Module:Check for deprecated parameters

Module documentationviewedithistorypurge

Module:Check for deprecated parameters may be appended to a template to check for uses of deprecated parameters. It will place the page in a specific category, and display a preview message, when it finds deprecated parameter uses.

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

For testing, see the output of the test cases. You should view that both normally and in preview mode to fully test the module.

Usage

{{#invoke:Check for deprecated parameters|check
| _category = {{main other|[[Category:Pages using TEMPLATENAME with deprecated parameters|_VALUE_]]}}
| _remove = RemoveParam1; RemoveParam2
| old_param1 = new_param1 
| old_param2 = new_param2
| ....
| old_paramN = new_paramN
}}

Parameters

• |_category= - what happens when an unknown parameter is used. Typically use either a tracking category to place pages that use deprecated parameters, or an error.
• |_remove= - a ; separated list of parameters that should simply be removed from the template, not replaced with another. For example: |_remove=Param1; Param2; Param3
• |ignoreblank= – by default, the module makes no distinction between a defined-but-blank parameter and a non-blank parameter. That is, both unlisted |foo=x and |foo= are reported. To only track non-blank parameters use |ignoreblank=1. If you clean your arguments with Module:Arguments and call this module afterwards, you need not use this parameter as that module ignores blank arguments by default.
• |preview= – set a custom preview warning message. Note the default is Page using LINKED_TEMPLATE_NAME with deprecated parameter _VALUE_
• |_regexp#= - set regular expressions to deprecate and replace with a corresponding regular expression.

Regex example

The following code will look for any supplied parameter of the format suc-type# and indicate that it should be replace with suc_type#. So for example, you will get suc-type4 needing to replaced with suc_type4.

{{#invoke:Check for deprecated parameters|check
| _regexp1 = (suc)%-(type%d?) = %1_%2
| _regexp2 = 
| _regexp3 = 
...
}}

See also

• Template:Deprecated parameters category
• Category:Deprecated parameters
• Module:Check for unknown parameters
• Module:Check for conflicting parameters – module that checks for conflicting parameters

The above documentation is transcluded from Module:Check for deprecated parameters/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (edit | run) pages.
Subpages of this module.

-- 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 MAX_PARAMS = 9 -- Limit to only showing 10 preview warnings

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

local function scanValues(values,results,args,replaceTable)
    for k, v in pairs(values) do
		local c = args.category:gsub('_VALUE_', v)
		table.insert(results, c)
		if v == '' then
			-- Fix odd bug for | = which gets stripped to the empty string
			-- and breaks category links
			v = ' '
		end
        local replaceString = '<code>'..v..'</code>. '
        local replaceValue = replaceTable and replaceTable[v]
        replaceString = replaceString..(replaceValue and 'Replace with <code>'..replaceValue..'</code>.' or 'It should be removed.')
		local p = args.preview:gsub('_VALUE_',replaceString)
		table.insert(results, p )
	end
end

function p.check (frame)
	-- create the table of deprecated values and their matching new value
	return p._check(frame.args, frame:getParent().args, frame:getParent():getTitle())
end

local moduleParams = {ignoreblank=true, preview=true, _category=true, _remove=true}

function p._check(args, pargs, caller)
	local dep_values = {}
	local reg_exps = {}
	for k, v in pairs(args) do
		if ( type(k) == 'string' and k:find('^_regexp[1-9][0-9]*$') and v:find('=') ) then
			local v_split = mw.text.split(v, '%s*=%s*')
			if ( #v_split == 2 ) then
				table.insert(reg_exps, { '^' .. v_split[1] .. '$', v_split[2] } )
			end
		elseif not moduleParams[k] then
			dep_values[k] = v
		end
	end

	-- Parse params to remove
	local removes = {}
	if args['_remove'] then
		for r in args['_remove']:gmatch("([^;]+)") do
            removes[mw.text.trim(r)] = 1
		end
	end
	
	-- loop over the parent args and see if any are deprecated
	local values = {}
	local remove_values = {}
	local ignoreblank = isnotempty(args['ignoreblank'])
	for k, v in pairs(pargs) do
        if not ignoreblank or isnotempty(v) then
			if dep_values[k] then
				table.insert(values, k)
			elseif removes[k] then
				table.insert(remove_values, k)
			else
				for _, regexp in ipairs(reg_exps) do
					if mw.ustring.match( tostring(k), regexp[1] ) then
						table.insert(values, k)
						dep_values[k] = mw.ustring.gsub(tostring(k), regexp[1], regexp[2])
						break
					end
				end
			end
		end
	end

    -- find out about calling context
    local title = mw.title.getCurrentTitle()

    -- create local defaulted arguments
    local category = args["_category"] or title.namespace == 0 and "[[Category:Pages with deprecated parameters]]" or ""
	local preview = args['preview'] or 'Page using [['..caller..']] with deprecated parameter _VALUE_'
	if isnotempty(preview) then
		preview = require('Module:If preview')._warning({preview})
	end
    local localArgs = {category=category,preview=preview}
	
    -- scan through values and remove_values and create output results
	local results = {}
    scanValues(values,results,localArgs,dep_values)
    scanValues(remove_values,results,localArgs)
	
	if #results >= MAX_PARAMS*2 then
		while #results > MAX_PARAMS*2 do
    		table.remove(results) -- Calling without index removes the last element
		end
   		table.insert(results, require('Module:If preview')._warning({'Page using [['..caller..']] with <b>multiple other</b> deprecated parameters. Fix those above and preview again.'}))
	end
	return table.concat(results)
end

return p