Module:Script doc auto - Revision history

SD0001: cleanup code

2025-02-14T07:38:56Z

cleanup code

← Previous revision		Revision as of 07:38, 14 February 2025
Line 12:		Line 12:

	p.core = function(page)		p.core = function(page)
	local ~~mfd~~ = ''		local text = ''

	local content = mw.title.new(page).content		local content = mw.title.new(page).content
	local result = content:match("/%* ({{mfd.-}})")		local result = content:match("/%* ({{mfd.-}})")
	if result then		if result then
	~~mfd~~ = mw.getCurrentFrame():preprocess(result)		text = text .. mw.getCurrentFrame():preprocess(result)
	end		end

	local len = page:len()		local len = page:len()
	if len < 4 then		if len < 4 then
	-- Too short page name, do nothing		-- Too short page name, do nothing more
	return ~~mfd~~		return text
	end		end

Line 27:		Line 29:
	local basepage = page:sub(0, -5)		local basepage = page:sub(0, -5)
	local sisterpage = basepage..'.js'		local sisterpage = basepage..'.js'
	~~return~~ ~~mfd~~ .. p.makeMessage('css', mw.title.new(basepage), mw.title.new(sisterpage), 'js')		text = text .. p.makeMessage('css', mw.title.new(basepage), mw.title.new(sisterpage), 'js')

	end
		⚫	elseif page:sub(-3, -1) == '.js' then

⚫	if page:sub(-3, -1) == '.js' then
	local basepage = page:sub(0, -4)		local basepage = page:sub(0, -4)
	local sisterpage = basepage..'.css'		local sisterpage = basepage..'.css'
	~~return~~ ~~mfd~~ .. p.makeMessage('js', mw.title.new(basepage), mw.title.new(sisterpage), 'css')		text = text .. p.makeMessage('js', mw.title.new(basepage), mw.title.new(sisterpage), 'css')
	end		end

	return ~~mfd~~		return text
	end		end

	local skins = {		local skins = TableTools.listToSet({
			'common', 'vector-2022', 'vector', 'timeless', 'minerva', 'monobook', 'modern', 'cologneblue'
	['common'] = true,
		⚫	})
	['vector-2022'] = true,
	['vector'] = true,
	['timeless'] = true,
	['minerva'] = true,
	['monobook'] = true,
	['modern'] = true,
	['cologneblue'] = true
⚫	}

	p.gadget_text = function(name, repo)		p.gadget_text = function(name, repo)

Pppery: Return mfd always

2024-11-23T17:19:21Z

Return mfd always

← Previous revision		Revision as of 17:19, 23 November 2024
Line 35:		Line 35:
	return mfd .. p.makeMessage('js', mw.title.new(basepage), mw.title.new(sisterpage), 'css')		return mfd .. p.makeMessage('js', mw.title.new(basepage), mw.title.new(sisterpage), 'css')
	end		end
			return mfd
	end		end

Pppery: Reapply that edit without unintended changes

2024-11-23T00:48:35Z

Reapply that edit without unintended changes

← Previous revision		Revision as of 00:48, 23 November 2024
Line 12:		Line 12:

	p.core = function(page)		p.core = function(page)
			local mfd = ''
			local content = mw.title.new(page).content
			local result = content:match("/%* ({{mfd.-}})")
			if result then
			mfd = mw.getCurrentFrame():preprocess(result)
			end
	local len = page:len()		local len = page:len()
	if len < 4 then		if len < 4 then
	-- Too short page name, do nothing		-- Too short page name, do nothing
	return ''		return mfd
	end		end

Line 21:		Line 27:
	local basepage = page:sub(0, -5)		local basepage = page:sub(0, -5)
	local sisterpage = basepage..'.js'		local sisterpage = basepage..'.js'
	return p.makeMessage('css', mw.title.new(basepage), mw.title.new(sisterpage), 'js')		return mfd .. p.makeMessage('css', mw.title.new(basepage), mw.title.new(sisterpage), 'js')
	end		end

Line 27:		Line 33:
	local basepage = page:sub(0, -4)		local basepage = page:sub(0, -4)
	local sisterpage = basepage..'.css'		local sisterpage = basepage..'.css'
	return p.makeMessage('js', mw.title.new(basepage), mw.title.new(sisterpage), 'css')		return mfd .. p.makeMessage('js', mw.title.new(basepage), mw.title.new(sisterpage), 'css')
	end		end
	end		end
Line 119:		Line 125:
	})		})
	end		end
			return ''
	end		end

Pppery: Reverted edit by Pppery (talk) to last version by Izno

2024-11-23T00:45:57Z

Reverted edit by Pppery (talk) to last version by Izno

← Previous revision		Revision as of 00:45, 23 November 2024
Line 13:		Line 13:
	p.core = function(page)		p.core = function(page)
	local len = page:len()		local len = page:len()
	~~local~~ ~~mfd~~ = ''		if len < 4 then
	local content = mw.title.new(page).content
	local result = content:match("/%* ({{mfd.-}})")
⚫	if ~~result~~ then
	mfd = mw.getCurrentFrame():preprocess(result)
⚫	end

	if len < 5 then
	-- Too short page name, do nothing		-- Too short page name, do nothing
	return ~~mfd~~		return ''
	end		end

	if page:sub(-4) == '.css' then		if page:sub(-4, -1) == '.css' then
	local basepage = page:sub(0, -5)		local basepage = page:sub(0, -5)
	local sisterpage = basepage..'.js'		local sisterpage = basepage..'.js'
	return ~~mfd ..~~ p.makeMessage('css', mw.title.new(basepage), mw.title.new(sisterpage), 'js')		return p.makeMessage('css', mw.title.new(basepage), mw.title.new(sisterpage), 'js')
	end		end

	if page:sub(-3) == '.js' then		if page:sub(-3, -1) == '.js' then
	local basepage = page:sub(0, -4)		local basepage = page:sub(0, -4)
	local sisterpage = basepage..'.css'		local sisterpage = basepage..'.css'
	return ~~mfd ..~~ p.makeMessage('js', mw.title.new(basepage), mw.title.new(sisterpage), 'css')		return p.makeMessage('js', mw.title.new(basepage), mw.title.new(sisterpage), 'css')
	end		end

	if page:sub(-5) == '.json' then
	local basepage = page:sub(0, -6)
	return mfd .. p.makeMessage('json', mw.title.new(basepage), mw.title.new(sisterpage), '')
	end
	return mfd
	end		end

Line 61:		Line 48:
	if options.hidden ~= nil then		if options.hidden ~= nil then
	-- Find dependents		-- Find dependents
	for n, ~~conf~~ in pairs(repo) do		for n, c in pairs(repo) do
	local deps = ~~conf~~.options.dependencies and		local deps = c.options.dependencies and
	TableTools.listToSet(mw.text.split(~~conf~~.options.dependencies, ',', false)) or {}		TableTools.listToSet(mw.text.split(c.options.dependencies, ',', false)) or {}
	local peers = ~~conf~~.options.peers and		local peers = c.options.peers and
	TableTools.listToSet(mw.text.split(~~conf~~.options.peers, ',', false)) or {}		TableTools.listToSet(mw.text.split(c.options.peers, ',', false)) or {}
	if deps['ext.gadget.'..name] ~= nil or peers[name] ~= nil then		if deps['ext.gadget.'..name] ~= nil or peers[name] ~= nil then
	table.insert(dependents, '[[Special:Gadgets#gadget-'..n..'\|'..n..']]')		table.insert(dependents, '[[Special:Gadgets#gadget-'..n..'\|'..n..']]')
	end		end
	end		end
		⚫	end
			local usage = Gadgets.get_usage(name)
		⚫	if usage == -1 then
			usage = "an unknown number of"
			else
			usage = lang:formatNum(usage)
	end		end
	return 'This page is loaded as a part of the ' ..		return 'This page is loaded as a part of the ' ..
Line 76:		Line 69:
	(#dependents > 0 and ' used by '..mw.text.listToText(dependents)..'.' or '.') or		(#dependents > 0 and ' used by '..mw.text.listToText(dependents)..'.' or '.') or
	(options.default ~= nil and ', <b>which is enabled by default</b>.' or		(options.default ~= nil and ', <b>which is enabled by default</b>.' or
	(', used by '..~~lang:formatNum(Gadgets.get_usage(name))~~..' users. '))) ..		(', used by '..usage..' users. '))) ..
	'<br>'		'<br>'
	end		end
Line 82:		Line 75:
	p.makeMessage = function(pagetype, basepage, sisterpage, sistertype)		p.makeMessage = function(pagetype, basepage, sisterpage, sistertype)
	local text = ''		local text = ''
	if basepage.namespace == 2 ~~and pagetype ~= 'json'~~ then		if basepage.namespace == 2 then
	if skins[basepage.subpageText] ~= nil then		if skins[basepage.subpageText] ~= nil then
	-- We are on a user skin file		-- We are on a user skin file
Line 91:		Line 84:
	local docpageExists = basepage.exists		local docpageExists = basepage.exists
	local sisterpageExists = sisterpage.exists		local sisterpageExists = sisterpage.exists

	local desc = pagetype == 'js' and '[[Wikipedia:User scripts\|user script]]' or 'user stylesheet'

	if docpageExists and sisterpageExists then		if docpageExists and sisterpageExists then
	text = 'This ~~'..desc..'~~ seems to have a documentation page at [['..basepage.fullText..']] and an accompanying .'..sistertype..' page at [['..sisterpage.fullText..']].'		text = 'This [[Wikipedia:User scripts\|user script]] seems to have a documentation page at [['..basepage.fullText..']] and an accompanying .'..sistertype..' page at [['..sisterpage.fullText..']].'
	elseif docpageExists and not sisterpageExists then		elseif docpageExists and not sisterpageExists then
	text = 'This ~~'..desc..'~~ seems to have a documentation page at [['..basepage.fullText..']].'		text = 'This [[Wikipedia:User scripts\|user script]] seems to have a documentation page at [['..basepage.fullText..']].'
	elseif sisterpageExists then		elseif sisterpageExists then
	text = 'Documentation for this ~~'..desc..'~~ can be added at [['..basepage.fullText..']]. This user script seems to have an accompanying .'..sistertype..' page at [['..sisterpage.fullText..']]. '		text = 'Documentation for this [[Wikipedia:User scripts\|user script]] can be added at [['..basepage.fullText..']]. This user script seems to have an accompanying .'..sistertype..' page at [['..sisterpage.fullText..']]. '
	else		else
	text = 'Documentation for this ~~'..desc..'~~ can be added at [['..basepage.fullText..']].'		text = 'Documentation for this [[Wikipedia:User scripts\|user script]] can be added at [['..basepage.fullText..']].'
	end		end
	end		end
Line 118:		Line 109:

	if text ~= '' then		if text ~= '' then
	return ~~MessageBox~~.~~main~~(~~'fmbox',~~ {		return mw.getCurrentFrame():extensionTag{
			name = 'templatestyles', args = { src = 'Module:Script doc auto/styles.css' }
			} .. MessageBox.main('fmbox', {
			class = 'script-doc-auto-box',
	id = 'mw-script-doc',		id = 'mw-script-doc',
	type = 'system',		type = 'system',
	image = '[[File:Template-info.svg\|43x40px]]',		image = '[[File:Template-info.svg\|43x40px]]',
	style = 'background: var(--background-color-success-subtle, #d5fdf4); color: inherit; border: 1px solid var(--border-color-base, #a2ab91)',
	text = text		text = text
	})		})
	end		end
	return ''
	end		end

Pppery: Display {{mfd}} if the page has it in a comment

2024-11-23T00:24:16Z

Display {{mfd}} if the page has it in a comment

← Previous revision		Revision as of 00:24, 23 November 2024
Line 13:		Line 13:
	p.core = function(page)		p.core = function(page)
	local len = page:len()		local len = page:len()
	if ~~len~~ < ~~4 then~~		local mfd = ''
			local content = mw.title.new(page).content
			local result = content:match("/%* ({{mfd.-}})")
		⚫	if result then
			mfd = mw.getCurrentFrame():preprocess(result)
		⚫	end

			if len < 5 then
	-- Too short page name, do nothing		-- Too short page name, do nothing
	return ''		return mfd
	end		end

	if page:sub(-4~~, -1~~) == '.css' then		if page:sub(-4) == '.css' then
	local basepage = page:sub(0, -5)		local basepage = page:sub(0, -5)
	local sisterpage = basepage..'.js'		local sisterpage = basepage..'.js'
	return p.makeMessage('css', mw.title.new(basepage), mw.title.new(sisterpage), 'js')		return mfd .. p.makeMessage('css', mw.title.new(basepage), mw.title.new(sisterpage), 'js')
	end		end

	if page:sub(-3~~, -1~~) == '.js' then		if page:sub(-3) == '.js' then
	local basepage = page:sub(0, -4)		local basepage = page:sub(0, -4)
	local sisterpage = basepage..'.css'		local sisterpage = basepage..'.css'
	return p.makeMessage('js', mw.title.new(basepage), mw.title.new(sisterpage), 'css')		return mfd .. p.makeMessage('js', mw.title.new(basepage), mw.title.new(sisterpage), 'css')
	end		end

			if page:sub(-5) == '.json' then
			local basepage = page:sub(0, -6)
			return mfd .. p.makeMessage('json', mw.title.new(basepage), mw.title.new(sisterpage), '')
			end
			return mfd
	end		end

Line 48:		Line 61:
	if options.hidden ~= nil then		if options.hidden ~= nil then
	-- Find dependents		-- Find dependents
	for n, c in pairs(repo) do		for n, conf in pairs(repo) do
	local deps = c.options.dependencies and		local deps = conf.options.dependencies and
	TableTools.listToSet(mw.text.split(c.options.dependencies, ',', false)) or {}		TableTools.listToSet(mw.text.split(conf.options.dependencies, ',', false)) or {}
	local peers = c.options.peers and		local peers = conf.options.peers and
	TableTools.listToSet(mw.text.split(c.options.peers, ',', false)) or {}		TableTools.listToSet(mw.text.split(conf.options.peers, ',', false)) or {}
	if deps['ext.gadget.'..name] ~= nil or peers[name] ~= nil then		if deps['ext.gadget.'..name] ~= nil or peers[name] ~= nil then
	table.insert(dependents, '[[Special:Gadgets#gadget-'..n..'\|'..n..']]')		table.insert(dependents, '[[Special:Gadgets#gadget-'..n..'\|'..n..']]')
	end		end
	end		end
⚫	end
	local usage = Gadgets.get_usage(name)
⚫	if ~~usage == -1~~ then
	usage = "an unknown number of"
	else
	usage = lang:formatNum(usage)
	end		end
	return 'This page is loaded as a part of the ' ..		return 'This page is loaded as a part of the ' ..
Line 69:		Line 76:
	(#dependents > 0 and ' used by '..mw.text.listToText(dependents)..'.' or '.') or		(#dependents > 0 and ' used by '..mw.text.listToText(dependents)..'.' or '.') or
	(options.default ~= nil and ', <b>which is enabled by default</b>.' or		(options.default ~= nil and ', <b>which is enabled by default</b>.' or
	(', used by '..~~usage~~..' users. '))) ..		(', used by '..lang:formatNum(Gadgets.get_usage(name))..' users. '))) ..
	'<br>'		'<br>'
	end		end
Line 75:		Line 82:
	p.makeMessage = function(pagetype, basepage, sisterpage, sistertype)		p.makeMessage = function(pagetype, basepage, sisterpage, sistertype)
	local text = ''		local text = ''
	if basepage.namespace == 2 then		if basepage.namespace == 2 and pagetype ~= 'json' then
	if skins[basepage.subpageText] ~= nil then		if skins[basepage.subpageText] ~= nil then
	-- We are on a user skin file		-- We are on a user skin file
Line 84:		Line 91:
	local docpageExists = basepage.exists		local docpageExists = basepage.exists
	local sisterpageExists = sisterpage.exists		local sisterpageExists = sisterpage.exists

			local desc = pagetype == 'js' and '[[Wikipedia:User scripts\|user script]]' or 'user stylesheet'

	if docpageExists and sisterpageExists then		if docpageExists and sisterpageExists then
	text = 'This ~~[[Wikipedia:User scripts\|user script]]~~ seems to have a documentation page at [['..basepage.fullText..']] and an accompanying .'..sistertype..' page at [['..sisterpage.fullText..']].'		text = 'This '..desc..' seems to have a documentation page at [['..basepage.fullText..']] and an accompanying .'..sistertype..' page at [['..sisterpage.fullText..']].'
	elseif docpageExists and not sisterpageExists then		elseif docpageExists and not sisterpageExists then
	text = 'This ~~[[Wikipedia:User scripts\|user script]]~~ seems to have a documentation page at [['..basepage.fullText..']].'		text = 'This '..desc..' seems to have a documentation page at [['..basepage.fullText..']].'
	elseif sisterpageExists then		elseif sisterpageExists then
	text = 'Documentation for this ~~[[Wikipedia:User scripts\|user script]]~~ can be added at [['..basepage.fullText..']]. This user script seems to have an accompanying .'..sistertype..' page at [['..sisterpage.fullText..']]. '		text = 'Documentation for this '..desc..' can be added at [['..basepage.fullText..']]. This user script seems to have an accompanying .'..sistertype..' page at [['..sisterpage.fullText..']]. '
	else		else
	text = 'Documentation for this ~~[[Wikipedia:User scripts\|user script]]~~ can be added at [['..basepage.fullText..']].'		text = 'Documentation for this '..desc..' can be added at [['..basepage.fullText..']].'
	end		end
	end		end
Line 109:		Line 118:

	if text ~= '' then		if text ~= '' then
	return mw.~~getCurrentFrame~~(~~):extensionTag~~{		return MessageBox.main('fmbox', {
	name = 'templatestyles', args = { src = 'Module:Script doc auto/styles.css' }
	} .. MessageBox.main('fmbox', {
	class = 'script-doc-auto-box',
	id = 'mw-script-doc',		id = 'mw-script-doc',
	type = 'system',		type = 'system',
	image = '[[File:Template-info.svg\|43x40px]]',		image = '[[File:Template-info.svg\|43x40px]]',
			style = 'background: var(--background-color-success-subtle, #d5fdf4); color: inherit; border: 1px solid var(--border-color-base, #a2ab91)',
	text = text		text = text
	})		})
	end		end
			return ''
	end		end

Izno: add templatestyles

2024-10-09T21:32:03Z

add templatestyles

← Previous revision		Revision as of 21:32, 9 October 2024
Line 109:		Line 109:

	if text ~= '' then		if text ~= '' then
	return ~~MessageBox~~.~~main~~(~~'fmbox',~~ {		return mw.getCurrentFrame():extensionTag{
			name = 'templatestyles', args = { src = 'Module:Script doc auto/styles.css' }
			} .. MessageBox.main('fmbox', {
			class = 'script-doc-auto-box',
	id = 'mw-script-doc',		id = 'mw-script-doc',
	type = 'system',		type = 'system',
	image = '[[File:Template-info.svg\|43x40px]]',		image = '[[File:Template-info.svg\|43x40px]]',
	style = 'background: #ecfcf4;',
	text = text		text = text
	})		})

Pppery: Oops

2024-06-01T19:32:32Z

Oops

← Previous revision		Revision as of 19:32, 1 June 2024
Line 58:		Line 58:
	end		end
	end		end
	local usage = ~~Gadget~~.get_usage(name)		local usage = Gadgets.get_usage(name)
	if usage == -1 then		if usage == -1 then
	usage = "an unknown number of"		usage = "an unknown number of"

Pppery: Don't say "used by -1 users" for new gadgets not yet added to GUStoWiki

2024-06-01T19:31:14Z

Don't say "used by -1 users" for new gadgets not yet added to GUStoWiki

← Previous revision		Revision as of 19:31, 1 June 2024
Line 57:		Line 57:
	end		end
	end		end
			end
			local usage = Gadget.get_usage(name)
			if usage == -1 then
			usage = "an unknown number of"
			else
			usage = lang:formatNum(usage)
	end		end
	return 'This page is loaded as a part of the ' ..		return 'This page is loaded as a part of the ' ..
Line 63:		Line 69:
	(#dependents > 0 and ' used by '..mw.text.listToText(dependents)..'.' or '.') or		(#dependents > 0 and ' used by '..mw.text.listToText(dependents)..'.' or '.') or
	(options.default ~= nil and ', <b>which is enabled by default</b>.' or		(options.default ~= nil and ', <b>which is enabled by default</b>.' or
	(', used by '..~~lang:formatNum(Gadgets.get_usage(name))~~..' users. '))) ..		(', used by '..usage..' users. '))) ..
	'<br>'		'<br>'
	end		end

Pppery: More grammar changes

2024-01-26T16:15:54Z

More grammar changes

← Previous revision		Revision as of 16:15, 26 January 2024
Line 62:		Line 62:
	(options.hidden ~= nil and ', a hidden gadget'..		(options.hidden ~= nil and ', a hidden gadget'..
	(#dependents > 0 and ' used by '..mw.text.listToText(dependents)..'.' or '.') or		(#dependents > 0 and ' used by '..mw.text.listToText(dependents)..'.' or '.') or
	(options.default ~= nil and ' <b>enabled by default</b>.' or		(options.default ~= nil and ', <b>which is enabled by default</b>.' or
	(', used by '..lang:formatNum(Gadgets.get_usage(name))..' users. '))) ..		(', used by '..lang:formatNum(Gadgets.get_usage(name))..' users. '))) ..
	'<br>'		'<br>'

Pppery: Ce grammar

2024-01-26T16:14:41Z

Ce grammar

← Previous revision		Revision as of 16:14, 26 January 2024
Line 58:		Line 58:
	end		end
	end		end
	return 'This page is loaded as a part of ' ..		return 'This page is loaded as a part of the ' ..
	'[[Special:Gadgets#gadget-'..name..'\|'..name..']] gadget' ..		'[[Special:Gadgets#gadget-'..name..'\|'..name..']] gadget' ..
	(options.hidden ~= nil and ', a hidden gadget'..		(options.hidden ~= nil and ', a hidden gadget'..
	(#dependents > 0 and ' used by '..mw.text.listToText(dependents)..'.' or '') or		(#dependents > 0 and ' used by '..mw.text.listToText(dependents)..'.' or '.') or
	(options.default ~= nil and ' <b>enabled by default</b>.' or		(options.default ~= nil and ' <b>enabled by default</b>.' or
	(', used by '..lang:formatNum(Gadgets.get_usage(name))..' users. '))) ..		(', used by '..lang:formatNum(Gadgets.get_usage(name))..' users. '))) ..