Module:Check for unknown parameters: Difference between revisions
From Vigyanwiki
Template>Frietjes (fix odd bug for | = which gets stripped to nothing, and Category:Foo is broken) |
Template>Mr. Stradivarius (fix substitution of "_VALUE_" when it isn't followed by a space) |
||
Line 33: | Line 33: | ||
end | end | ||
end | end | ||
end | |||
local function addresult(k) | |||
if k == '' then | |||
-- Fix odd bug for | = which gets stripped to the empty string and | |||
-- breaks category links | |||
k = ' ' | |||
end | |||
local r = mw.ustring.gsub(unknown, '_VALUE_', k) | |||
table.insert(res, r) | |||
table.insert(comments, '"' .. k .. '"') | |||
end | end | ||
Line 46: | Line 57: | ||
if( (not knownflag) and ( (not ignoreblank) or (ignoreblank and isnotempty(v)) ) ) then | if( (not knownflag) and ( (not ignoreblank) or (ignoreblank and isnotempty(v)) ) ) then | ||
k = mw.ustring.gsub(k, '[^%w\-_ ]', '?') | k = mw.ustring.gsub(k, '[^%w\-_ ]', '?') | ||
addresult(k) | |||
end | end | ||
elseif(checkpos and type(k) == 'number' and knownargs[tostring(k)] == nil) then | elseif(checkpos and type(k) == 'number' and knownargs[tostring(k)] == nil) then | ||
if( (not ignoreblank) or (ignoreblank and isnotempty(v)) ) then | if( (not ignoreblank) or (ignoreblank and isnotempty(v)) ) then | ||
addresult(k) | |||
end | end | ||
end | end |
Revision as of 16:20, 2 November 2015
Documentation for this module may be created at Module:Check for unknown parameters/doc
-- 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
-- not on the list
local p = {}
local function isnotempty(s)
return s and s:match( '^%s*(.-)%s*$' ) ~= ''
end
function p.check (frame)
local args = frame.args
local pargs = frame:getParent().args
local ignoreblank = isnotempty(frame.args['ignoreblank'])
local checkpos = isnotempty(frame.args['checkpositional'])
local knownargs = {}
local unknown = 'Found _VALUE_, '
local res = {}
local regexps = {}
local comments = {}
local commentstr = ''
-- create the list of known args, regular expressions, and the return string
for k, v in pairs(args) do
if type(k) == 'number' then
v = mw.ustring.gsub(v, '^%s*(.-)%s*$', '%1')
knownargs[v] = 1
else
if (k == 'unknown' and type(v) == 'string') then
unknown = v
elseif (mw.ustring.match(k, '^regexp[%d]*$') and type(v) == 'string') then
table.insert(regexps, '^' .. v .. '$')
end
end
end
local function addresult(k)
if k == '' then
-- Fix odd bug for | = which gets stripped to the empty string and
-- breaks category links
k = ' '
end
local r = mw.ustring.gsub(unknown, '_VALUE_', k)
table.insert(res, r)
table.insert(comments, '"' .. k .. '"')
end
-- loop over the parent args, and make sure they are on the list
for k,v in pairs(pargs) do
if (type(k) == 'string' and knownargs[k] == nil) then
local knownflag = nil
for r = 1,#regexps do
if( mw.ustring.match(k,regexps[r]) ) then
knownflag = 1
end
end
if( (not knownflag) and ( (not ignoreblank) or (ignoreblank and isnotempty(v)) ) ) then
k = mw.ustring.gsub(k, '[^%w\-_ ]', '?')
addresult(k)
end
elseif(checkpos and type(k) == 'number' and knownargs[tostring(k)] == nil) then
if( (not ignoreblank) or (ignoreblank and isnotempty(v)) ) then
addresult(k)
end
end
end
if(#comments > 0) then
commentstr = '<!-- Module:Check for unknown parameters results: ' ..
table.concat(comments, ', ') .. '-->'
end
return table.concat(res) .. commentstr
end
return p