Module:Check for unknown parameters: Difference between revisions

From Test Wiki
Newer edit →
Content deleted Content added
Anoop Rao (talk | contribs)
211 edits
m 1 revision imported
 
per edit request (permalink); + require ('strict');
Line 2: Line 2:
-- with a list of arguments, returning a specified result if an argument is
-- with a list of arguments, returning a specified result if an argument is
-- not on the list
-- not on the list

require ('strict');

local p = {}
local p = {}


Line 9: Line 12:


local function isnotempty(s)
local function isnotempty(s)
return s and trim(s) ~= ''
return s and s:match('%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 showblankpos = isnotempty(frame.args['showblankpositional'])
⚫
if truncated then
⚫
local knownargs = {}
return ''
⚫
local unknown = frame.args['unknown'] or 'Found _VALUE_, '
⚫
end
⚫
local preview = frame.args['preview']
⚫
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)
⚫
local values = {}
if type(args) ~= "table" or type(pargs) ~= "table" then
⚫
local res = {}
-- TODO: error handling
⚫
local regexps = {}
return
end


-- create the list of known args, regular expressions, and the return string
-- create the list of known args, regular expressions, and the return string
⚫
local knownargs = {}
⚫
local regexps = {}
for k, v in pairs(args) do
for k, v in pairs(args) do
if type(k) == 'number' then
if type(k) == 'number' then
Line 33: Line 54:
table.insert(regexps, '^' .. v .. '$')
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
end


-- loop over the parent args, and make sure they are on the list
-- loop over the parent args, and make sure they are on the list
⚫
local ignoreblank = isnotempty(args['ignoreblank'])
⚫
local showblankpos = isnotempty(args['showblankpositional'])
⚫
local values = {}
for k, v in pairs(pargs) do
for k, v in pairs(pargs) do
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 i, regexp in ipairs(regexps) do
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 70:
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\-_ ]', '?')
end
⚫
table.insert(values, k)
⚫
elseif type(k) == 'number' and knownargs[tostring(k)] == nil then
local knownflag = false
for _, regexp in ipairs(regexps) do
if mw.ustring.match(tostring(k), regexp) then
knownflag = true
break
end
end
⚫
if not knownflag and ( showblankpos or isnotempty(v) ) then
⚫
table.insert(values, k .. ' = ' .. clean(v))
end
end
⚫
elseif type(k) == 'number' and
knownargs[tostring(k)] == nil and
⚫
( showblankpos or isnotempty(v) )
then
⚫
local vlen = mw.ustring.len(v)
⚫
v = mw.ustring.sub(v, 1, (vlen < 25) and vlen or 25)
v = mw.ustring.gsub(v, '[^%w\-_ ]', '?')
⚫
table.insert(values, k .. ' = ' .. v .. ((vlen >= 25) and ' ...' or ''))
end
end
end
end


-- add resuls to the output tables
-- add results to the output tables
local res = {}
if #values > 0 then
if #values > 0 then
⚫
local unknown_text = args['unknown'] or 'Found _VALUE_, '
⚫
if frame:preprocess( "{{REVISIONID}}" ) == "" then

unknown = preview
⚫
if mw.getCurrentFrame():preprocess( "{{REVISIONID}}" ) == "" then
⚫
local preview_text = args['preview']
⚫
if isnotempty(preview_text) then
preview_text = require('Module:If preview')._warning({preview_text})
⚫
elseif preview_text == nil then
preview_text = unknown_text
end
unknown_text = preview_text
end
end
for k, v in pairs(values) do
for _, v in pairs(values) do
⚫
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 = ' '
if v == '' then v = ' ' end

⚫
end
-- avoid error with v = 'example%2' ("invalid capture index")
local r = unknown:gsub('_VALUE_', v)
local r = unknown_text:gsub('_VALUE_', {_VALUE_ = v})
table.insert(res, r)
table.insert(res, r)
end
end
Line 82: Line 112:


return table.concat(res)
return table.concat(res)
end

⚫
function p.check(frame)
⚫
local args = frame.args
⚫
local pargs = frame:getParent().args
return p._check(args, pargs)
end
end


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