Module:Check for unknown parameters - Revision history

Skritzer: 1 revision imported

2024-01-19T00:36:42Z

1 revision imported

w>BusterD: Changed protection settings for "Module:Check for unknown parameters": Highly visible template; requested at WP:RfPP ([Edit=Require administrator access] (indefinite) [Move=Require administrator access] (indefinite))

2022-02-21T05:24:13Z

Changed protection settings for "Module:Check for unknown parameters": Highly visible template; requested at WP:RfPP ([Edit=Require administrator access] (indefinite) [Move=Require administrator access] (indefinite))

Skritzer: 1 revision imported

2021-12-04T01:05:00Z

1 revision imported

wikipedia>MSGJ: update to allow check for unnamed parameters, code by User:Frietjes

2021-11-18T20:27:09Z

update to allow check for unnamed parameters, code by User:Frietjes

Skritzer: 1 revision imported

2020-01-23T00:32:07Z

1 revision imported

wikipedia>Gonnym: Added entry point for modules per talk page discussion. Report any errors on talk page.

2020-01-07T17:25:33Z

Added entry point for modules per talk page discussion. Report any errors on talk page.

Skritzer: 1 revision imported

2019-12-22T17:27:33Z

1 revision imported

Skritzer: 1 revision imported

2019-12-19T18:10:50Z

1 revision imported

wikipedia>Johnuniq: update from sandbox to sanitize displayed parameters, replacing strip markers with "..." per User talk:Johnuniq#Check for unknown parameters

2019-02-03T01:04:52Z

update from sandbox to sanitize displayed parameters, replacing strip markers with "<tag>...</tag>" per User talk:Johnuniq#Check for unknown parameters

wikipedia>Skritzer: 1 revision imported

2018-08-09T19:20:18Z

1 revision imported

New page

-- 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 trim(s) ~= ''
end

function p.check (frame)
local args = frame.args
local pargs = frame:getParent().args
local ignoreblank = isnotempty(frame.args['ignoreblank'])
local showblankpos = isnotempty(frame.args['showblankpositional'])
local knownargs = {}
local unknown = frame.args['unknown'] or 'Found _VALUE_, '
local preview = frame.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 i, 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
k = mw.ustring.gsub(k, '[^%w\-_ ]', '?')
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)
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

-- add resuls to the output tables
if #values > 0 then
if frame:preprocess( "{{REVISIONID}}" ) == "" then
unknown = preview
end
for k, 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
local r = unknown:gsub('_VALUE_', v)
table.insert(res, r)
end
end

return table.concat(res)
end

return p

@@ Line 35: / Line 35: @@
 end
-function p.check (frame)
+function p._check(args, pargs)
-	local args = frame.args
+	if type(args) ~= "table" or type(pargs) ~= "table" then
-	local pargs = frame:getParent().args
+		-- TODO: error handling
 	local ignoreblank = isnotempty(args['ignoreblank'])
 	local showblankpos = isnotempty(args['showblankpositional'])
@@ Line 86: / Line 89: @@
 	-- add results to the output tables
 	if #values > 0 then
-		if frame:preprocess( "{{REVISIONID}}" ) == "" then
+		if mw.getCurrentFrame():preprocess( "{{REVISIONID}}" ) == "" then
 			unknown = preview
 		end
@@ Line 102: / Line 105: @@
 	return table.concat(res)
 end
 return p

@@ Line 41: / Line 41: @@
 	end
-	local ignoreblank = isnotempty(args['ignoreblank'])
+	-- create the list of known args, regular expressions, and the return string
 	local knownargs = {}
 	local regexps = {}
 	for k, v in pairs(args) do
 		if type(k) == 'number' then
@@ Line 59: / Line 51: @@
 			table.insert(regexps, '^' .. v .. '$')
 		end
 	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
@@ Line 79: / Line 69: @@
 				table.insert(values, clean(k))
 			end
-		elseif type(k) == 'number' and
+		elseif type(k) == 'number' and knownargs[tostring(k)] == nil then
-			knownargs[tostring(k)] == nil and
+			local knownflag = false
-			( showblankpos or isnotempty(v) )
+			for _, regexp in ipairs(regexps) do
-		then
+				if mw.ustring.match(tostring(k), regexp) then
-			table.insert(values, k .. ' = ' .. clean(v))
+					knownflag = true
 		end
 	end
 	-- add results to the output tables
 	if #values > 0 then
 		if mw.getCurrentFrame():preprocess( "{{REVISIONID}}" ) == "" then
-			unknown = preview
+			local preview_text = args['preview']
 		end
 		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
+			if v == '' then v = ' ' end
-				v = ' '
 			-- avoid error with v = 'example%2' ("invalid capture index")
-			local r =  unknown:gsub('_VALUE_', {_VALUE_ = v})
+			local r = unknown_text:gsub('_VALUE_', {_VALUE_ = v})
 			table.insert(res, r)
 		end

@@ Line 9: / Line 9: @@
 local function isnotempty(s)
-	return s and trim(s) ~= ''
+	return s and s:match('%S')
 end
@@ Line 15: / Line 38: @@
 	local args = frame.args
 	local pargs = frame:getParent().args
-	local ignoreblank = isnotempty(frame.args['ignoreblank'])
+	local ignoreblank = isnotempty(args['ignoreblank'])
-	local showblankpos = isnotempty(frame.args['showblankpositional'])
+	local showblankpos = isnotempty(args['showblankpositional'])
 	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 = {}
@@ Line 34: / Line 57: @@
 		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
@@ Line 44: / Line 67: @@
 		if type(k) == 'string' and knownargs[k] == nil then
 			local knownflag = false
-			for i, regexp in ipairs(regexps) do
+			for _, regexp in ipairs(regexps) do
 				if mw.ustring.match(k, regexp) then
 					knownflag = true
@@ Line 51: / Line 74: @@
 			end
 			if not knownflag and ( not ignoreblank or isnotempty(v) )  then
-				k = mw.ustring.gsub(k, '[^%w\-_ ]', '?')
+				table.insert(values, clean(k))
 			end
 		elseif type(k) == 'number' and
 			knownargs[tostring(k)] == nil and
 			( showblankpos or isnotempty(v) )
 		then
-			local vlen = mw.ustring.len(v)
+			table.insert(values, k .. ' = ' .. clean(v))
 		end
 	end
-	-- add resuls to the output tables
+	-- add results to the output tables
 	if #values > 0 then
 		if frame:preprocess( "{{REVISIONID}}" ) == "" then
 			unknown = preview
 		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 = ' '
+				v = ' '
 			end
-			local r =  unknown:gsub('_VALUE_', v)
+			-- avoid error with v = 'example%2' ("invalid capture index")
 			table.insert(res, r)
 		end