Editing Module:Check for unknown parameters

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. Read the Privacy Policy to learn what information we collect about you and how we use it.

If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 9: Line 9:


local function isnotempty(s)
local function isnotempty(s)
return s and s:match('%S')
return s and trim(s) ~= ''
end
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
text = mw.ustring.sub(text, 1, 25) .. '...'
end
return mw.text.nowiki(text)
end
local parts = {}
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(args['ignoreblank'])
local showblankpos = isnotempty(args['showblankpositional'])
local knownargs = {}
local knownargs = {}
local unknown = args['unknown'] or 'Found _VALUE_, '
local unknown = 'Found _VALUE_, '
local preview = args['preview']
local preview = nil


local values = {}
local res = {}
local res = {}
local regexps = {}
local regexps = {}
local comments = {}
local commentstr = ''
local ispreview = frame:preprocess( "{{REVISIONID}}" ) == "" and 1 or 0


-- create the list of known args, regular expressions, and the return string
-- create the list of known args, regular expressions, and the return string
Line 56: Line 33:
v = trim(v)
v = trim(v)
knownargs[v] = 1
knownargs[v] = 1
elseif k == 'unknown' and ispreview == 0 then
unknown = v
elseif k == 'preview' and ispreview == 1 then
preview = v
elseif k:find('^regexp[1-9][0-9]*$') then
elseif k:find('^regexp[1-9][0-9]*$') then
table.insert(regexps, '^' .. v .. '$')
table.insert(regexps, '^' .. v .. '$')
end
end
end
end
if isnotempty(preview) then
if ispreview == 1 and preview then unknown = preview end
preview = '<div class="hatnote" style="color:red"><strong>Warning:</strong> ' .. preview .. ' (this message is shown only in preview).</div>'
elseif preview == nil then
-- adds one result to the output tables
preview = unknown
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 = unknown:gsub('_VALUE_', k)
table.insert(res, r)
table.insert(comments, '"' .. k .. '"')
end
end


Line 70: Line 59:
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 _, regexp in ipairs(regexps) do
for i, regexp in ipairs(regexps) do
if mw.ustring.match(k, regexp) then
if mw.ustring.match(k, regexp) then
knownflag = true
knownflag = true
Line 77: Line 66:
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, clean(k))
k = mw.ustring.gsub(k, '[^%w\-_ ]', '?')
addresult(k)
end
end
elseif type(k) == 'number' and
elseif checkpos and
type(k) == 'number' and  
knownargs[tostring(k)] == nil and
knownargs[tostring(k)] == nil and
( showblankpos or isnotempty(v) )
( not ignoreblank or isnotempty(v) )
then
then
table.insert(values, k .. ' = ' .. clean(v))
addresult(k)
end
end
end
end


-- add results to the output tables
if #comments > 0 then
if #values > 0 then
commentstr = '<!-- Module:Check for unknown parameters results: ' ..
if mw.getCurrentFrame():preprocess( "{{REVISIONID}}" ) == "" then
table.concat(comments, ', ') .. '-->'
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 = ' '
end
-- avoid error with v = 'example%2' ("invalid capture index")
local r =  unknown:gsub('_VALUE_', {_VALUE_ = v})
table.insert(res, r)
end
end
end
 
return table.concat(res)
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
end


return p
return p
Please note that all contributions to Nonbinary Wiki are considered to be released under the Creative Commons Attribution-ShareAlike (see Nonbinary Wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)

Template used on this page:

Retrieved from "https://nonbinary.wiki/wiki/Module:Check_for_unknown_parameters"