Module:Find sources/autodoc - Revision history

Ookami: 36 revisions imported

2020-09-03T04:29:36Z

36 revisions imported

← Older revision	Revision as of 04:29, 3 September 2020
(No difference)

meta>Mr. Stradivarius: use the 'invalid-template-name-error' message instead of hard-coding it

2014-12-02T03:24:48Z

use the 'invalid-template-name-error' message instead of hard-coding it

← Older revision		Revision as of 03:24, 2 December 2014
Line 3:		Line 3:
	local TEMPLATE_LIST = ROOT_PAGE .. '/templates' -- template config module list		local TEMPLATE_LIST = ROOT_PAGE .. '/templates' -- template config module list
	local TEMPLATE_ROOT = TEMPLATE_LIST .. '/' -- template config module prefix		local TEMPLATE_ROOT = TEMPLATE_LIST .. '/' -- template config module prefix
	local LINK_LIST = ROOT_PAGE .. '/links'		local LINK_LIST = ROOT_PAGE .. '/links' -- link config module list
	local LINK_ROOT = LINK_LIST .. '/' -- link config module prefix		local LINK_ROOT = LINK_LIST .. '/' -- link config module prefix
	local AUTODOC_SUFFIX = '/autodoc'		local AUTODOC_SUFFIX = '/autodoc'
Line 312:		Line 312:
	local templateCfg = maybeLoadData(TEMPLATE_ROOT .. template)		local templateCfg = maybeLoadData(TEMPLATE_ROOT .. template)
	if not isValidTemplateCfg(templateCfg) then		if not isValidTemplateCfg(templateCfg) then
	error(~~string.format~~(		error(substituteParams(
	"invalid template name '~~%s'; no template config found at [[%s]~~]",		cfg['invalid-template-name-error'],
	template,		template,
	TEMPLATE_ROOT .. template		TEMPLATE_ROOT .. template

meta>Mr. Stradivarius: remove mw.text.unstrip and fix a mistaken global

2014-12-02T03:08:12Z

remove mw.text.unstrip and fix a mistaken global

← Older revision		Revision as of 03:08, 2 December 2014
Line 1:		Line 1:
	-- Define constants		-- Define constants
	local ROOT_PAGE = 'Module:Find sources'		local ROOT_PAGE = 'Module:Find sources'
	local ~~TEMPLATE_ROOT~~ = ROOT_PAGE .. '/templates/' -- ~~for~~ template config ~~modules~~		local TEMPLATE_LIST = ROOT_PAGE .. '/templates' -- template config module list
	local ~~LINK_ROOT~~ = ROOT_PAGE .. '/links/' -- ~~for~~ link config ~~modules~~		local TEMPLATE_ROOT = TEMPLATE_LIST .. '/' -- template config module prefix
			local LINK_LIST = ROOT_PAGE .. '/links'
			local LINK_ROOT = LINK_LIST .. '/' -- link config module prefix
	local AUTODOC_SUFFIX = '/autodoc'		local AUTODOC_SUFFIX = '/autodoc'

Line 20:		Line 22:
	end		end

	local function ~~escapePattern~~(s)		local function sortKeys(t)
	~~return s:gsub('%p', '%%%0')~~		local ret = {}
	~~end~~		for k in pairs(t) do
			ret[#ret + 1] = k
	~~local function getPrefixPagenames(prefix)~~
	~~local specialText = string.format('{{Special:PrefixIndex/%s}}', prefix)~~
	~~specialText = mw.getCurrentFrame():preprocess(specialText)~~
	~~specialText = mw.text.unstrip(specialText~~)
	local ~~pagenames~~ = {}
	for s in ~~string.gmatch~~(~~specialText, '<a href="[^"]" title="([^"])"[^>]>[^<]</a>'~~) do
	~~pagenames~~[#~~pagenames~~ + 1] = ~~mw.text.decode(s)~~
	end		end
	return ~~pagenames~~		table.sort(ret)
			return ret
	end		end

	~~local function getSubpages(pagenames, prefix)~~
	~~local stripped = {}~~
	~~for i, page in ipairs(pagenames) do~~
	~~local pattern = '^' .. escapePattern(prefix) -- Turn the prefix into a Lua pattern~~
	~~stripped[i] = mw.ustring.gsub(page, pattern, '')~~
	~~end~~
	~~return stripped~~
	~~end~~

	~~local function getPrefixSubpages(prefix)~~
	~~return getSubpages(getPrefixPagenames(prefix), prefix)~~
	~~end~~

	~~local function getFilteredPrefixSubpages(prefix)~~
	~~-- Filter out unwanted pages from the subpage list. For now, this means~~
	~~-- the autodoc pages.~~
	~~local subpages = getPrefixSubpages(prefix)~~
	~~local pattern = escapePattern(AUTODOC_SUFFIX) .. '$'~~
	~~local filtered = {}~~
	~~for _, subpage in ipairs(subpages) do~~
	~~if not mw.ustring.find(subpage, pattern) then~~
	~~filtered[#filtered + 1] = subpage~~
	~~end~~
	~~end~~
	~~return filtered~~
	~~end~~

	local function isValidLinkCfg(linkCfg)		local function isValidLinkCfg(linkCfg)
Line 101:		Line 70:
	end		end
	end		end
	if templateCfg~~[s]~~ and templateCfg~~[s]~~ ~= true then		if templateCfg.isUsedInMainspace and templateCfg.isUsedInMainspace ~= true then
	return false		return false
	end		end
Line 225:		Line 194:

	function p.linkTable()		function p.linkTable()
	local codes = ~~getFilteredPrefixSubpages~~(~~LINK_ROOT~~)		local codes = sortKeys(require(LINK_LIST))
	local headers = {		local headers = {
	cfg['link-table-code-header'],		cfg['link-table-code-header'],
Line 279:		Line 248:

	function p.templateTable()		function p.templateTable()
	local templates = ~~getFilteredPrefixSubpages~~(~~TEMPLATE_ROOT~~)		local templates = sortKeys(require(TEMPLATE_LIST))
	local headers = {		local headers = {
	cfg['template-table-template-header'],		cfg['template-table-template-header'],

meta>Mr. Stradivarius: put calls to find sources through pcall

2014-09-29T15:38:48Z

put calls to find sources through pcall

← Older revision		Revision as of 15:38, 29 September 2014
Line 242:		Line 242:
	linkData = {}		linkData = {}
	end		end

			-- Make the example link.
			local success, link = pcall(
			mFindSources._renderLink,
			code,
			{cfg['example-search-term']}
			)
			if not success then
			link = makeWikitextError(link)
			end

			-- Build the row.
	local row = {		local row = {
	bold(code),		bold(code),
	linkData.description or grey("''No description available''"),		linkData.description or grey("''No description available''"),
	~~mFindSources._renderLink(code, {cfg['example-search-term']})~~,		link,
	table.concat({		table.concat({
	makeWikilink(configPage, cfg['link-table-main-config-link-display']),		makeWikilink(configPage, cfg['link-table-main-config-link-display']),
Line 283:		Line 295:
	templateData = {}		templateData = {}
	end		end

			-- Make the example text
			local success, example = pcall(
			mFindSources._main,
			template,
			{cfg['example-search-term']}
			)
			if not success then
			example = makeWikitextError(example)
			end

			-- Build the row.
	local row = {		local row = {
	bold(makeWikilink(mw.site.namespaces[10].name .. ':' .. template, template)),		bold(makeWikilink(mw.site.namespaces[10].name .. ':' .. template, template)),
	templateData.description or grey("''No description available''"),		templateData.description or grey("''No description available''"),
	~~mFindSources._main(template, {cfg['~~example~~-search-term']})~~,		example,
	table.concat({		table.concat({
	makeWikilink(configPage, cfg['template-table-main-config-link-display']),		makeWikilink(configPage, cfg['template-table-main-config-link-display']),

meta>Mr. Stradivarius: fix function order

2014-09-29T15:28:02Z

fix function order

← Older revision		Revision as of 15:28, 29 September 2014
Line 61:		Line 61:
	return filtered		return filtered
	end		end

	~~local function isValidLink(code)~~
	~~if type(code) ~= 'string' or code == '' then~~
	~~return false~~
	~~end~~
	~~local linkCfg = maybeLoadData(LINK_ROOT .. code)~~
	~~return isValidLinkCfg(linkCfg)~~
	~~end~~

	local function isValidLinkCfg(linkCfg)		local function isValidLinkCfg(linkCfg)
Line 87:		Line 79:
	end		end

	local function ~~isValidTemplate~~(~~template~~)		local function isValidLink(code)
	if type(~~template~~) ~= 'string' or ~~template~~ == '' then		if type(code) ~= 'string' or code == '' then
	return false		return false
	end		end
	local ~~templateCfg~~ = maybeLoadData(~~TEMPLATE_ROOT~~ .. ~~template~~)		local linkCfg = maybeLoadData(LINK_ROOT .. code)
	return ~~isValidTemplateCfg~~(~~templateCfg~~)		return isValidLinkCfg(linkCfg)
	end		end

Line 139:		Line 131:

	return true		return true
			end

			local function isValidTemplate(template)
			if type(template) ~= 'string' or template == '' then
			return false
			end
			local templateCfg = maybeLoadData(TEMPLATE_ROOT .. template)
			return isValidTemplateCfg(templateCfg)
	end		end

meta>Mr. Stradivarius: do more thorough type checking in the documentation function

2014-09-29T15:26:48Z

do more thorough type checking in the documentation function

← Older revision		Revision as of 15:26, 29 September 2014
Line 67:		Line 67:
	end		end
	local linkCfg = maybeLoadData(LINK_ROOT .. code)		local linkCfg = maybeLoadData(LINK_ROOT .. code)
			return isValidLinkCfg(linkCfg)
			end

			local function isValidLinkCfg(linkCfg)
	if type(linkCfg) ~= 'table' then		if type(linkCfg) ~= 'table' then
	return false		return false
Line 88:		Line 92:
	end		end
	local templateCfg = maybeLoadData(TEMPLATE_ROOT .. template)		local templateCfg = maybeLoadData(TEMPLATE_ROOT .. template)
			return isValidTemplateCfg(templateCfg)
			end

			local function isValidTemplateCfg(templateCfg)
	if type(templateCfg) ~= 'table' then		if type(templateCfg) ~= 'table' then
	return false		return false
Line 300:		Line 308:
	local function documentation(template)		local function documentation(template)
	-- This function makes documentation for the template specified in		-- This function makes documentation for the template specified in
	-- ~~frame.args[1]~~. The template ~~name~~ should be without the "Template:"		-- the template parameter. The template should be without the "Template:"
	-- prefix.		-- prefix.

Line 310:		Line 318:
	-- Load the config files		-- Load the config files
	local templateCfg = maybeLoadData(TEMPLATE_ROOT .. template)		local templateCfg = maybeLoadData(TEMPLATE_ROOT .. template)
	if not templateCfg then		if not isValidTemplateCfg(templateCfg) then
	error(string.format(		error(string.format(
	"invalid template name '%s'; no template config found at [[%s]]",		"invalid template name '%s'; no template config found at [[%s]]",
Line 317:		Line 325:
	))		))
	end		end
	local autodocCfg = maybeLoadData(TEMPLATE_ROOT .. template .. AUTODOC_SUFFIX) or {}		local autodocCfg = maybeLoadData(TEMPLATE_ROOT .. template .. AUTODOC_SUFFIX)
			if not isValidTemplateAutdocCfg(autodocCfg) then
			autodocCfg = {}
			end

	-- Get the documentation content		-- Get the documentation content
Line 337:		Line 348:
	end		end
	for i, code in ipairs(codes) do		for i, code in ipairs(codes) do
	local linkAutodocCfg = maybeLoadData(LINK_ROOT .. code .. AUTODOC_SUFFIX) or {}		local linkAutodocCfg = maybeLoadData(LINK_ROOT .. code .. AUTODOC_SUFFIX)
	~~local description = linkAutodocCfg.description~~		if not isValidLinkAutdocCfg(linkAutodocCfg) then
	codes[i] = ~~type(description) == 'string' and~~ description or code		linkAutodocCfg = {}
			end
			codes[i] = linkAutodocCfg.description or code
	end		end
	local linkDescriptions = mList.bulleted(codes)		local linkDescriptions = mList.bulleted(codes)

meta>Mr. Stradivarius: use strong tags rather than span tags for wikitext errors

2014-09-29T15:12:43Z

use strong tags rather than span tags for wikitext errors

← Older revision		Revision as of 15:12, 29 September 2014
Line 205:		Line 205:

	local function makeWikitextError(msg)		local function makeWikitextError(msg)
	return string.format('<~~span~~ class="error">%s</~~span~~>', msg)		return string.format('<strong class="error">%s</strong>', msg)
	end		end

meta>Mr. Stradivarius: use mw.message for substituting parameters

2014-09-29T15:11:41Z

use mw.message for substituting parameters

← Older revision		Revision as of 15:11, 29 September 2014
Line 14:		Line 14:
	local success, data = pcall(mw.loadData, page)		local success, data = pcall(mw.loadData, page)
	return success and data		return success and data
			end

			local function substituteParams(msg, ...)
			return mw.message.newRawMessage(msg, ...):plain()
	end		end

Line 242:		Line 246:
	rows[i] = row		rows[i] = row
	else		else
	local msg = ~~string.format~~(		local msg = substituteParams(
	cfg['invalid-link-config-error'],		cfg['invalid-link-config-error'],
	LINK_ROOT .. code		LINK_ROOT .. code
Line 282:		Line 286:
	rows[i] = row		rows[i] = row
	else		else
	local msg = ~~string.format~~(		local msg = substituteParams(
	cfg['invalid-template-config-error'],		cfg['invalid-template-config-error'],
	TEMPLATE_ROOT .. template		TEMPLATE_ROOT .. template

meta>Mr. Stradivarius: use cfg table vales for the error messages

2014-09-29T15:08:28Z

use cfg table vales for the error messages

← Older revision		Revision as of 15:08, 29 September 2014
Line 243:		Line 243:
	else		else
	local msg = string.format(		local msg = string.format(
	'~~Invalid~~ link ~~code detected on page [[%s~~]~~].'~~,		cfg['invalid-link-config-error'],
	LINK_ROOT .. code		LINK_ROOT .. code
	)		)
Line 283:		Line 283:
	else		else
	local msg = string.format(		local msg = string.format(
	'~~Invalid~~ template ~~configuration detected on page [[%s~~]~~].'~~,		cfg['invalid-template-config-error'],
	TEMPLATE_ROOT .. template		TEMPLATE_ROOT .. template
	)		)

meta>Mr. Stradivarius: check type of the link descriptions in the documentation function

2014-09-29T15:03:13Z

check type of the link descriptions in the documentation function

← Older revision		Revision as of 15:03, 29 September 2014
Line 334:		Line 334:
	for i, code in ipairs(codes) do		for i, code in ipairs(codes) do
	local linkAutodocCfg = maybeLoadData(LINK_ROOT .. code .. AUTODOC_SUFFIX) or {}		local linkAutodocCfg = maybeLoadData(LINK_ROOT .. code .. AUTODOC_SUFFIX) or {}
	codes[i] = ~~linkAutodocCfg.~~description or code		local description = linkAutodocCfg.description
			codes[i] = type(description) == 'string' and description or code
	end		end
	local linkDescriptions = mList.bulleted(codes)		local linkDescriptions = mList.bulleted(codes)