Module:Check for unknown parameters: Difference between revisions

    m (1 revision imported)
    (Added entry point for modules per talk page discussion. Report any errors on talk page.)
    Line 9: Line 9:


    local function isnotempty(s)
    local function isnotempty(s)
    return s and trim(s) ~= ''
    return s and s:match('%S')
    end
    end


    function p.check (frame)
    local function clean(text)
    local args = frame.args
    -- Return text cleaned for display and truncated if too long.
    local pargs = frame:getParent().args
    -- Strip markers are replaced with dummy text representing the original wikitext.
    local ignoreblank = isnotempty(frame.args['ignoreblank'])
    local pos, truncated
    local showblankpos = isnotempty(frame.args['showblankpositional'])
    local function truncate(text)
    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 = frame.args['unknown'] or 'Found _VALUE_, '
    local unknown = args['unknown'] or 'Found _VALUE_, '
    local preview = frame.args['preview']
    local preview = args['preview']


    local values = {}
    local values = {}
    Line 34: Line 60:
    end
    end
    end
    end
    if isnotempty(preview) then  
    if isnotempty(preview) then
    preview = '<div class="hatnote" style="color:red"><strong>Warning:</strong> ' .. preview .. ' (this message is shown only in preview).</div>'
    preview = '<div class="hatnote" style="color:red"><strong>Warning:</strong> ' .. preview .. ' (this message is shown only in preview).</div>'
    elseif preview == nil then
    elseif preview == nil then
    Line 44: Line 70:
    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 77:
    end
    end
    if not knownflag and ( not ignoreblank or isnotempty(v) )  then
    if not knownflag and ( not ignoreblank or isnotempty(v) )  then
    k = mw.ustring.gsub(k, '[^%w\-_ ]', '?')
    table.insert(values, clean(k))
    table.insert(values, k)
    end
    end
    elseif type(k) == 'number' and  
    elseif type(k) == 'number' and
    knownargs[tostring(k)] == nil and
    knownargs[tostring(k)] == nil and
    ( showblankpos or isnotempty(v) )
    ( showblankpos or isnotempty(v) )
    then
    then
    local vlen = mw.ustring.len(v)
    table.insert(values, k .. ' = ' .. clean(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
    if #values > 0 then
    if #values > 0 then
    if frame:preprocess( "{{REVISIONID}}" ) == "" then
    if mw.getCurrentFrame():preprocess( "{{REVISIONID}}" ) == "" then
    unknown = preview
    unknown = preview
    end
    end
    for k, v in pairs(values) do
    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 = ' '
    end
    end
    local r =  unknown:gsub('_VALUE_', v)
    -- avoid error with v = 'example%2' ("invalid capture index")
    local r =  unknown:gsub('_VALUE_', {_VALUE_ = v})
    table.insert(res, r)
    table.insert(res, r)
    end
    end
    Line 82: Line 105:


    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


    return p
    return p
    Retrieved from "https://develop.consumerium.org/wiki/Module:Check_for_unknown_parameters"