Difference between revisions of "Module:Check for unknown parameters/sandbox"
Jump to navigation
Jump to search
blackwiki>Frietjes (sync) |
blackwiki>Johnuniq (minor refactoring before thinking about nowiki per my talk) |
||
Line 9: | Line 9: | ||
local function isnotempty(s) | local function isnotempty(s) | ||
− | return s and | + | return s and s:match('%S') |
end | end | ||
Line 15: | Line 15: | ||
local args = frame.args | local args = frame.args | ||
local pargs = frame:getParent().args | local pargs = frame:getParent().args | ||
− | local ignoreblank = isnotempty( | + | local ignoreblank = isnotempty(args['ignoreblank']) |
− | local showblankpos = isnotempty( | + | local showblankpos = isnotempty(args['showblankpositional']) |
local knownargs = {} | local knownargs = {} | ||
− | local unknown = | + | local unknown = args['unknown'] or 'Found _VALUE_, ' |
− | local preview = | + | local preview = args['preview'] |
local values = {} | local values = {} | ||
Line 44: | Line 44: | ||
if type(k) == 'string' and knownargs[k] == nil then | if type(k) == 'string' and knownargs[k] == nil then | ||
local knownflag = false | local knownflag = false | ||
− | for | + | for _, regexp in ipairs(regexps) do |
if mw.ustring.match(k, regexp) then | if mw.ustring.match(k, regexp) then | ||
knownflag = true | knownflag = true | ||
Line 51: | Line 51: | ||
end | end | ||
if not knownflag and ( not ignoreblank or isnotempty(v) ) then | if not knownflag and ( not ignoreblank or isnotempty(v) ) then | ||
− | |||
table.insert(values, k) | table.insert(values, k) | ||
end | end | ||
Line 59: | Line 58: | ||
then | then | ||
local vlen = mw.ustring.len(v) | local vlen = mw.ustring.len(v) | ||
− | v = mw.ustring.sub(v, 1, | + | if vlen > 25 then |
− | + | v = mw.ustring.sub(v, 1, 25) .. '...' | |
− | table.insert(values, k .. ' = ' .. v | + | end |
+ | table.insert(values, k .. ' = ' .. v) | ||
end | end | ||
end | end | ||
− | -- add | + | -- add results to the output tables |
if #values > 0 then | if #values > 0 then | ||
if frame:preprocess( "{{REVISIONID}}" ) == "" then | if frame:preprocess( "{{REVISIONID}}" ) == "" then | ||
unknown = preview | unknown = preview | ||
end | end | ||
− | for | + | for _, v in pairs(values) do |
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 | ||
-- breaks category links | -- breaks category links | ||
v = ' ' | v = ' ' | ||
+ | else | ||
+ | v = mw.text.encode(mw.text.encode(v),'%c%[%]=') | ||
end | end | ||
-- avoid error with v = 'example%2' ("invalid capture index") | -- avoid error with v = 'example%2' ("invalid capture index") |
Revision as of 04:16, 27 January 2019
Documentation for this module may be created at Module:Check for unknown parameters/sandbox/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 trim(s)
return s:match('^%s*(.-)%s*$')
end
local function isnotempty(s)
return s and s:match('%S')
end
function p.check (frame)
local args = frame.args
local pargs = frame:getParent().args
local ignoreblank = isnotempty(args['ignoreblank'])
local showblankpos = isnotempty(args['showblankpositional'])
local knownargs = {}
local unknown = args['unknown'] or 'Found _VALUE_, '
local preview = args['preview']
local values = {}
local res = {}
local regexps = {}
-- 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 = trim(v)
knownargs[v] = 1
elseif k:find('^regexp[1-9][0-9]*$') then
table.insert(regexps, '^' .. 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 = 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 = false
for _, 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
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)
if vlen > 25 then
v = mw.ustring.sub(v, 1, 25) .. '...'
end
table.insert(values, k .. ' = ' .. v)
end
end
-- add results to the output tables
if #values > 0 then
if frame:preprocess( "{{REVISIONID}}" ) == "" then
unknown = preview
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 = ' '
else
v = mw.text.encode(mw.text.encode(v),'%c%[%]=')
end
-- avoid error with v = 'example%2' ("invalid capture index")
local r = unknown:gsub('_VALUE_', {_VALUE_ = v})
table.insert(res, r)
end
end
return table.concat(res)
end
return p