Module:Check for unknown parameters: Difference between revisions

m
(add optional regexp match)
m (39 revisions imported from wikipedia:Module:Check_for_unknown_parameters)
 
(29 intermediate revisions by 8 users not shown)
Line 3:
-- not on the list
local p = {}
 
local function trim(s)
return s:match('^%s*(.-)%s*$')
end
 
local function isnotempty(s)
return s and s:match( '^%s*(.-)%s*$S' ) ~= ''
end
 
local function clean(text)
function p.check (frame)
-- Return text cleaned for display and truncated if too long.
local args = frame.args
-- Strip markers are replaced with dummy text representing the original wikitext.
local pargs = frame:getParent().args
local pos, truncated
local ignoreblank = isnotempty(frame.args['ignoreblank'])
local function truncate(text)
local checkpos = isnotempty(frame.args['checkpositional'])
if truncated then
return ''
end
if mw.ustring.len(text) > 25 then
truncated = true
ktext = mw.ustring.gsubsub(ktext, '[^%w\-_ ]'1, 25) .. '?...')
end
return mw.text.nowiki(text)
end
local commentsparts = {}
for before, tag, remainder in text:gmatch('([^\127]*)\127[^\127]*%-(%l+)%-[^\127]*\127()') do
pos = remainder
table.insert(parts, truncate(before) .. '<' .. tag .. '>...</' .. tag .. '>')
end
table.insert(parts, truncate(text:sub(pos or 1)))
return table.concat(parts)
end
 
function p._check(args, pargs)
if type(args) ~= "table" or type(pargs) ~= "table" then
-- TODO: error handling
return
end
 
local ignoreblank = isnotempty(frame.args['ignoreblank'])
local checkposshowblankpos = isnotempty(frame.args['checkpositionalshowblankpositional'])
local knownargs = {}
local unknown = args['unknown'] or 'Found _VALUE_, '
local preview = args['preview']
 
local commentstrvalues = ''{}
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.gsubtrim(v, '^%s*(.-)%s*$', '%1')
knownargs[v] = 1
elseif k:find('^regexp[1-9][0-9]*$') then
else
if table.insert(k ==regexps, '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
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 = unknown
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 = nilfalse
for r_, =regexp 1,#in ipairs(regexps) do
if( mw.ustring.match(k,regexps[r]) regexp) then
knownflag = 1true
break
end
end
if( (not knownflag) and ( (not ignoreblank) or (ignoreblank and isnotempty(v)) ) ) then
table.insert(resvalues, rclean(k))
k = mw.ustring.gsub(k, '[^%w\-_ ]', '?')
local r = mw.ustring.gsub(unknown, '_VALUE_', k)
table.insert(res, r)
table.insert(comments, '"' .. k .. '"')
end
elseif(checkpos and type(k) == 'number' and knownargs[tostring(k)] == nil) then
if( (not ignoreblank) or (ignoreblank and isnotempty(v)) ) then
local r = mw.ustring.gsub(unknown, '_VALUE_', k)
table.insert(res, r)
table.insert(comments, '"' .. k .. '"')
end
elseif type(k) == 'number' and
knownargs[tostring(k)] == nil and
( showblankpos or isnotempty(v) )
then
table.insert(regexpsvalues, '^'k .. v' = ' .. '$'clean(v))
end
end
 
-- add results to the output tables
if( #commentsvalues > 0) then
commentstr = '<!-- Module:Check for unknown parameters results: ' ..
if mw.getCurrentFrame():preprocess( "{{REVISIONID}}" ) == "" then
table.concat(comments, ', ') .. '-->'
unknown = vpreview
end
for _, v in pairs(values) do
if v == '' then
-- Fix odd bug for | = which gets stripped to the empty string and
-- breaks category links
v = ' '
end
-- avoid error with v = 'example%2' ("invalid capture index")
local r = mw.ustring. unknown:gsub(unknown, '_VALUE_', k{_VALUE_ = v})
table.insert(commentsres, '"' .. k .. '"'r)
end
end
 
return table.concat(res) .. commentstr
end
 
function p.check (frame)
local args = frame.args
local pargs = frame:getParent().args
return p._check(args, pargs)
end