Module:Check for unknown parameters

Module documentation

[create]

You might want to create a documentation page for this Scribunto module.
Editors can experiment in this module’s sandbox (create | mirror) and testcases (create) pages.
Please add categories to the /doc subpage. Subpages of this module.

-- 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 listlocalp={}localfunctiontrim(s)returns:match('^%s*(.-)%s*$')endlocalfunctionisnotempty(s)returnsands:match('%S')endlocalfunctionclean(text)-- Return text cleaned for display and truncated if too long.-- Strip markers are replaced with dummy text representing the original wikitext.localpos,truncatedlocalfunctiontruncate(text)iftruncatedthenreturn''endifmw.ustring.len(text)>25thentruncated=truetext=mw.ustring.sub(text,1,25)..'...'endreturnmw.text.nowiki(text)endlocalparts={}forbefore,tag,remainderintext:gmatch('([^\127]*)\127[^\127]*%-(%l+)%-[^\127]*\127()')dopos=remaindertable.insert(parts,truncate(before)..'<'..tag..'>...</'..tag..'>')endtable.insert(parts,truncate(text:sub(posor1)))returntable.concat(parts)endfunctionp._check(args,pargs)iftype(args)~="table"ortype(pargs)~="table"then-- TODO: error handlingreturnend-- create the list of known args, regular expressions, and the return stringlocalknownargs={}localregexps={}fork,vinpairs(args)doiftype(k)=='number'thenv=trim(v)knownargs[v]=1elseifk:find('^regexp[1-9][0-9]*$')thentable.insert(regexps,'^'..v..'$')endend-- loop over the parent args, and make sure they are on the listlocalignoreblank=isnotempty(args['ignoreblank'])localshowblankpos=isnotempty(args['showblankpositional'])localvalues={}fork,vinpairs(pargs)doiftype(k)=='string'andknownargs[k]==nilthenlocalknownflag=falsefor_,regexpinipairs(regexps)doifmw.ustring.match(k,regexp)thenknownflag=truebreakendendifnotknownflagand(notignoreblankorisnotempty(v))thentable.insert(values,clean(k))endelseiftype(k)=='number'andknownargs[tostring(k)]==nilthenlocalknownflag=falsefor_,regexpinipairs(regexps)doifmw.ustring.match(tostring(k),regexp)thenknownflag=truebreakendendifnotknownflagand(showblankposorisnotempty(v))thentable.insert(values,k..' = '..clean(v))endendend-- add results to the output tableslocalres={}if#values>0thenlocalunknown_text=args['unknown']or'Found _VALUE_, 'ifmw.getCurrentFrame():preprocess("{{REVISIONID}}")==""thenlocalpreview_text=args['preview']ifisnotempty(preview_text)thenpreview_text=require('Module:If preview')._warning({preview_text})elseifpreview==nilthenpreview_text=unknown_textendunknown_text=preview_textendfor_,vinpairs(values)do-- Fix odd bug for | = which gets stripped to the empty string and-- breaks category linksifv==''thenv=' 'end-- avoid error with v = 'example%2' ("invalid capture index")localr=unknown_text:gsub('_VALUE_',{_VALUE_=v})table.insert(res,r)endendreturntable.concat(res)endfunctionp.check(frame)localargs=frame.argslocalpargs=frame:getParent().argsreturnp._check(args,pargs)endreturnp