The Deadlock Wiki

Module:DependencyList: Difference between revisions

Browse history interactively
← Older edit

Cronos (talk | contribs)

4 user groups
1,336 edits
undo
osrsw>Gaz Lloyd
m use [^:] instead
m 20 revisions imported
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
require("strict")
local p = {}
local p = {}
local libraryUtil = require( 'libraryUtil' )
local libraryUtil = require('libraryUtil')
local arr = require( 'Module:Array' )
local arr = require('Module:Array')
local yn = require( 'Module:Yesno' )
local yn = require('Module:Yesno')
local param = require( 'Module:Paramtest' )
local param = require('Module:Paramtest')
local dpl = require( 'Module:DPLlua' )
local dpl = require('Module:DPLlua')
local tooltip = require( 'Module:Tooltip' )
local tooltip = require('Module:Tooltip')
local moduleIsUsed = false
local COLLAPSE_LIST_LENGTH_THRESHOLD = 5
local COLLAPSE_LIST_LENGTH_THRESHOLD = 5
local MAX_DYNAMIC_REQUIRE_LIST_LENGTH = 30
local MAX_DYNAMIC_REQUIRE_LIST_LENGTH = 30
Line 12: Line 12:


local builtins = {
local builtins = {
    ["libraryUtil"] = {
["libraryUtil"] = {
        link = "mw:Special:MyLanguage/Extension:Scribunto/Lua reference manual#libraryUtil",
link = "mw:Special:MyLanguage/Extension:Scribunto/Lua reference manual#libraryUtil",
        categories = {},
categories = {},
    },
},
    ["strict"] = {
["strict"] = {
        link = "mw:Special:MyLanguage/Extension:Scribunto/Lua reference manual#strict",
link = "mw:Special:MyLanguage/Extension:Scribunto/Lua reference manual#strict",
        categories = { "Strict mode modules" },
categories = { "[[Category:Strict mode modules]]" },
    },
},
}
}


--- Used in case 'require( varName )' is found. Attempts to find a string value stored in 'varName'.
-- Used in case 'require( varName )' is found. Attempts to find a string value stored in 'varName'.
---@param content string    The content of the module to search in
local function substVarValue( moduleContent, varName )
---@param varName string
local res = moduleContent:match( varName .. '%s*=%s*(%b""%s-%.*)' ) or moduleContent:match( varName .. "%s*=%s*(%b''%s-%.*)" ) or ''
---@return string
if res:find( '^(["\'])[Mm]odule:[%S]+%1' ) and not res:find( '%.%.' ) and not res:find( '%%%a' ) then
local function substVarValue( content, varName )
return mw.text.trim( res )
    local res = content:match( varName .. '%s*=%s*(%b""%s-%.*)' ) or content:match( varName .. "%s*=%s*(%b''%s-%.*)" ) or ''
else
    if res:find( '^(["\'])[Mm]odule:[%S]+%1' ) and not res:find( '%.%.' ) and not res:find( '%%%a' ) then
return ''
        return mw.text.trim( res )
end
    else
        return ''
    end
end
end


---@param capture string
local function extractModuleName( capture, moduleContent )
---@param content string    The content of the module to search in
capture = capture:gsub( '^%(%s*(.-)%s*%)$', '%1' )
---@return string
local function extractModuleName( capture, content )
    capture = capture:gsub( '^%(%s*(.-)%s*%)$', '%1' )


    if capture:find( '^(["\']).-%1$' ) then -- Check if it is already a pure string
if capture:find( '^(["\']).-%1$' ) then -- Check if it is already a pure string
        return capture
return capture
    elseif capture:find( '^[%a_][%w_]*$' ) then -- Check if if is a single variable
elseif capture:find( '^[%a_][%w_]*$' ) then -- Check if if is a single variable
        return substVarValue( content, capture )
return substVarValue( moduleContent, capture )
    end
end


    return capture
return capture
end
end


---@param str string
---@return string
local function formatPageName( str )
local function formatPageName( str )
    local name = mw.text.trim(str)
local name = mw.text.trim(str)
        :gsub( '^([\'\"])(.-)%1$', '%2' ) -- Only remove quotes at start and end of string if both are the same type
:gsub( '^([\'\"])(.-)%1$', '%2' ) -- Only remove quotes at start and end of string if both are the same type
        :gsub( '_', ' ' )
:gsub( '_', ' ' )
        :gsub( '^.', string.upper )
:gsub( '^.', string.upper )
        :gsub( '^([^:]-:)(.)', function(a,b) return a..string.upper(b) end )
:gsub( '^([^:]-:)(.)', function(a,b) return a..string.upper(b) end )


    return name
return name
end
end


---@param str string
---@param allowBuiltins? boolean
---@return string
local function formatModuleName( str, allowBuiltins )
local function formatModuleName( str, allowBuiltins )
    if allowBuiltins then
if allowBuiltins then
        local name = mw.text.trim(str)
local name = mw.text.trim(str)
            -- Only remove quotes at start and end of string if both are the same type
-- Only remove quotes at start and end of string if both are the same type
            :gsub([[^(['"])(.-)%1$]], '%2')
:gsub([[^(['"])(.-)%1$]], '%2')


        if builtins[name] then
if builtins[name] then
            return name
return name
        end
end
    end
end


    local module = formatPageName( str )
local module = formatPageName( str )


    if not string.find( module, '^[Mm]odule:' ) then
if not string.find( module, '^[Mm]odule:' ) then
        module = 'Module:' .. module
module = 'Module:' .. module
    end
end


    return module
return module
end
end


local function dualGmatch( str, pat1, pat2 )
local function dualGmatch( str, pat1, pat2 )
    local f1 = string.gmatch( str, pat1 )
local f1 = string.gmatch( str, pat1 )
    if pat2 then
if pat2 then
        local f2 = string.gmatch( str, pat2 )
local f2 = string.gmatch( str, pat2 )
        return function()
return function()
            return f1() or f2()
return f1() or f2()
        end
end
    else
else
        return f1
return f1
    end
end
end
end


local function isDynamicPath( str )
local function isDynamicPath( str )
    return string.find( str, '%.%.' ) or string.find( str, '%%%a' )
return string.find( str, '%.%.' ) or string.find( str, '%%%a' )
end
end


--- Used in case a construct like 'require( "Module:wowee/" .. isTheBest )' is found.
-- Used in case a construct like 'require( "Module:wowee/" .. isTheBest )' is found.
--- Will return a list of pages which satisfy this pattern where 'isTheBest' can take any value.
-- Will return a list of pages which satisfy this pattern where 'isTheBest' can take any value.
---@param query string
---@return string[]
local function getDynamicRequireList( query )
local function getDynamicRequireList( query )
    if query:find( '%.%.' ) then
if query:find( '%.%.' ) then
        query = mw.text.split( query, '..', true )
query = mw.text.split( query, '..', true )
        query = arr.map( query, function(x) return mw.text.trim(x) end )
query = arr.map( query, function(x) return (x:match('^%s*[\'\"](.-)[\'\"]%s*$') or '%') end )
        query = arr.map( query, function(x) return (x:match('^[\'\"](.-)[\'\"]$') or '%') end )
query = table.concat( query )
        query = table.concat( query )
else
    else
local _, _query = query:match( '(["\'])(.-)%1' )
        local _, _query = query:match( '(["\'])(.-)%1' )
query = _query:gsub( '%%%a', '%%' ) -- Replace lua string.format specifiers with a dpl wildcard
        query = _query:gsub( '%%%a', '%%' )
end
    end
query = query:gsub( '^[Mm]odule:', '' )
    query = query:gsub( '^[Mm]odule:', '' )


    if query:find( '^[Ee]xchange/' ) or query:find( '^[Dd]ata/' ) then
query = mw.language.getContentLanguage():ucfirst(query)
        return { 'Module:' .. query }  -- This format will later be used by formatDynamicQueryLink()
if query:find( '^Exchange/' ) or query:find( '^Data/' ) then
    end
return { 'Module:' .. query }  -- This format will later be used by formatDynamicQueryLink()
end


    if dynamicRequireListQueryCache[ query ] then
if dynamicRequireListQueryCache[ query ] then
        return dynamicRequireListQueryCache[ query ]
return dynamicRequireListQueryCache[ query ]
    end
end


    local list = dpl.ask{
local list = dpl.ask{
        namespace = 'Module',
namespace = 'Module',
        titlematch = query,
titlematch = query,
        nottitlematch = '%/doc|'..query..'/%',
nottitlematch = '%/doc|'..query..'/%',
        distinct = 'strict',
distinct = 'strict',
        ignorecase = true,
ordermethod = 'title',
        ordermethod = 'title',
count = MAX_DYNAMIC_REQUIRE_LIST_LENGTH + 1,
        count = MAX_DYNAMIC_REQUIRE_LIST_LENGTH + 1,
skipthispage = 'no',
        skipthispage = 'no',
allowcachedresults = true,
        allowcachedresults = true,
cacheperiod = 604800 -- One week
        cacheperiod = 604800 -- One week
}
    }


    if #list > MAX_DYNAMIC_REQUIRE_LIST_LENGTH then
if #list > MAX_DYNAMIC_REQUIRE_LIST_LENGTH then
        list = { 'Module:' .. query }
list = { 'Module:' .. query }
    end
end


    dynamicRequireListQueryCache[ query ] = list
dynamicRequireListQueryCache[ query ] = list


    return list
return list
end
end


--- Returns a list of modules loaded and required by module 'moduleName'.
--- Returns a list of modules loaded and required by module 'moduleName'.
---@param moduleName string
local function getRequireLists( moduleContent )
---@param searchForUsedTemplates? boolean
local requireList = arr{}
---@return table<string, string[]>
local loadDataList = arr{}
local function getRequireList( moduleName, searchForUsedTemplates )
local loadJsonDataList = arr{}
    local content = mw.title.new( moduleName ):getContent()
local dynamicRequirelist = arr{}
    local requireList = arr{}
local dynamicLoadDataList = arr{}
    local loadDataList = arr{}
local dynamicLoadJsonDataList = arr{}
    local loadJsonDataList = arr{}
local extraCategories = arr{}
    local usedTemplateList = arr{}
    local dynamicRequirelist = arr{}
    local dynamicLoadDataList = arr{}
    local dynamicLoadJsonDataList = arr{}
    local extraCategories = arr{}


    assert( content ~= nil, string.format( '%s does not exist', moduleName ) )
local function getList( pat1, pat2, list, dynList )
for match in dualGmatch( moduleContent, pat1, pat2 ) do
match = mw.text.trim( match )
local name = extractModuleName( match, moduleContent )


    content = content:gsub( '%-%-%[(=-)%[.-%]%1%]', '' ):gsub( '%-%-[^\n]*', '' ) -- Strip comments
if isDynamicPath( name ) then
dynList:insert( getDynamicRequireList( name ), true )
elseif name ~= '' then
name = formatModuleName( name, true )
table.insert( list, name )


    local function getList( pat1, pat2, list, dynList )
if builtins[name] then
        for match in dualGmatch( content, pat1, pat2 ) do
extraCategories = extraCategories:insert( builtins[name].categories, true )
            match = mw.text.trim( match )
end
            local name = extractModuleName( match, content )
end
end
end


            if isDynamicPath( name ) then
getList( 'require%s*(%b())', 'require%s*((["\'])%s*[Mm]odule:.-%2)', requireList, dynamicRequirelist )
                dynList:insert( getDynamicRequireList( name ), true )
getList( 'mw%.loadData%s*(%b())', 'mw%.loadData%s*((["\'])%s*[Mm]odule:.-%2)', loadDataList, dynamicLoadDataList )
            elseif name ~= '' then
getList( 'mw%.loadJsonData%s*(%b())', 'mw%.loadJsonData%s*((["\'])%s*[Mm]odule:.-%2)', loadJsonDataList, dynamicLoadJsonDataList )
                name = formatModuleName( name, true )
getList( 'pcall%s*%(%s*require%s*,([^%),]+)', nil, requireList, dynamicRequirelist )
                table.insert( list, name )
getList( 'pcall%s*%(%s*mw%.loadData%s*,([^%),]+)', nil, loadDataList, dynamicLoadDataList )
getList( 'pcall%s*%(%s*mw%.loadJsonData%s*,([^%),]+)', nil, loadJsonDataList, dynamicLoadJsonDataList )


                if builtins[name] then
requireList = requireList .. dynamicRequirelist
                    extraCategories = extraCategories:insert( builtins[name].categories, true )
requireList = requireList:unique()
                end
loadDataList = loadDataList .. dynamicLoadDataList .. loadJsonDataList .. dynamicLoadJsonDataList
            end
loadDataList = loadDataList:unique()
        end
extraCategories = extraCategories:unique()
    end
table.sort( requireList )
table.sort( loadDataList )
table.sort( extraCategories )


    getList( 'require%s*(%b())', 'require%s*((["\'])%s*[Mm]odule:.-%2)', requireList, dynamicRequirelist )
return {
    getList( 'mw%.loadData%s*(%b())', 'mw%.loadData%s*((["\'])%s*[Mm]odule:.-%2)', loadDataList, dynamicLoadDataList )
require = requireList,
    getList( 'mw%.loadJsonData%s*(%b())', 'mw%.loadJsonData%s*((["\'])%s*[Mm]odule:.-%2)', loadJsonDataList, dynamicLoadJsonDataList )
loadData = loadDataList,
    getList( 'pcall%s*%(%s*require%s*,([^%),]+)', nil, requireList, dynamicRequirelist )
extraCategories = extraCategories,
    getList( 'pcall%s*%(%s*mw%.loadData%s*,([^%),]+)', nil, loadDataList, dynamicLoadDataList )
}
    getList( 'pcall%s*%(%s*mw%.loadJsonData%s*,([^%),]+)', nil, loadJsonDataList, dynamicLoadJsonDataList )
end
 
local function getUsedTemplatesList( moduleContent )
local usedTemplateList = arr{}


    if searchForUsedTemplates then
for preprocess in string.gmatch( moduleContent, ':preprocess%s*(%b())' ) do
        for preprocess in string.gmatch( content, ':preprocess%s*(%b())' ) do
local function recursiveGMatch( str, pat )
            local function recursiveGMatch( str, pat )
local list = {}
                local list = {}
local i = 0
                local i = 0
repeat
                repeat
for match in string.gmatch( list[i] or str, pat ) do
                    for match in string.gmatch( list[i] or str, pat ) do
table.insert( list, match )
                        table.insert( list, match )
end
                    end
i =  i + 1
                    i =  i + 1
until i > #list or i > 100
                until i > #list or i > 100


                i = 0
i = 0
                return function()
return function()
                    i = i + 1
i = i + 1
                    return list[i]
return list[i]
                end
end
            end
end


            for template in recursiveGMatch( preprocess, '{(%b{})}' ) do
for template in recursiveGMatch( preprocess, '{(%b{})}' ) do
                local name = string.match( template, '{(.-)[|{}]' )
local name = string.match( template, '{(.-)[|{}]' )
                if name ~= '' then
if name ~= '' then
                    if name:find( ':' ) then
if name:find( ':' ) then
                        local ns = name:match( '^(.-):' )
local ns = name:match( '^(.-):' )
                        if arr.contains( {'', 'template', 'calculator', 'user'}, ns:lower() ) then
if arr.contains( {'', 'template', 'calculator', 'user'}, ns:lower() ) then
                            table.insert( usedTemplateList, name )
table.insert( usedTemplateList, name )
                        elseif ns == ns:upper() then
elseif ns == ns:upper() then
                            table.insert( usedTemplateList, ns ) -- Probably a magic word
table.insert( usedTemplateList, ns ) -- Probably a magic word
                        end
end
                    else
else
                        if name:match( '^%u+$' ) or name == '!' then
if name:match( '^%u+$' ) or name == '!' then
                            table.insert( usedTemplateList, name ) -- Probably a magic word
table.insert( usedTemplateList, name ) -- Probably a magic word
                        else
else
                            table.insert( usedTemplateList, 'Template:'..name )
table.insert( usedTemplateList, 'Template:'..name )
                        end
end
                    end
end
                end
end
            end
end
        end
end
    end


    requireList = requireList .. dynamicRequirelist
usedTemplateList = usedTemplateList:unique()
    requireList = requireList:unique()
table.sort( usedTemplateList )
    loadDataList = loadDataList .. dynamicLoadDataList
    loadDataList = loadDataList:unique()
    loadJsonDataList = loadJsonDataList .. dynamicLoadJsonDataList
    usedTemplateList = usedTemplateList:unique()
    extraCategories = extraCategories:unique()
    table.sort( requireList )
    table.sort( loadDataList )
    table.sort( loadJsonDataList )
    table.sort( usedTemplateList )
    table.sort( extraCategories )


    return {
return usedTemplateList
        requireList = requireList,
        loadDataList = loadDataList,
        loadJsonDataList = loadJsonDataList,
        usedTemplateList = usedTemplateList,
        extraCategories = extraCategories
    }
end
end


--- Returns a list with module and function names used in all '{{#Invoke:moduleName|funcName}}' found on page 'templateName'.
-- Returns a list with module and function names used in all '{{#Invoke:moduleName|funcName}}' found on page 'templateName'.
---@param templateName string
local function getInvokeCallList( pageName )
---@return table<string, string>[]
local pageContent = mw.title.new( pageName ):getContent()
local function getInvokeCallList( templateName )
local invokeList = {}
    local content = mw.title.new( templateName ):getContent()
    local invokeList = {}


    assert( content ~= nil, string.format( '%s does not exist', templateName ) )
assert( pageContent, string.format( 'Failed to retrieve text content of page "%s"', pageName ) )


    for moduleName, funcName in string.gmatch( content, '{{[{|safeubt:}]-#[Ii]nvoke:([^|]+)|([^}|]+)[^}]*}}' ) do
for moduleName, funcName in string.gmatch( pageContent, '{{[{|safeubt:}]-#[Ii]nvoke:([^|]+)|([^}|]+)[^}]*}}' ) do
        moduleName = formatModuleName( moduleName )
moduleName = formatModuleName( moduleName )
        funcName = mw.text.trim( funcName )
funcName = mw.text.trim( funcName )
        if string.find( funcName, '^{{{' ) then
if string.find( funcName, '^{{{' ) then
            funcName = funcName ..  '}}}'
funcName = funcName ..  '}}}'
        end
end
        table.insert( invokeList, {moduleName=moduleName, funcName=funcName} )
table.insert( invokeList, {moduleName=moduleName, funcName=funcName} )
    end
end


    -- For form calcs invoking the module directly
-- For form calcs invoking the module directly
    for config in dualGmatch( content, '<pre%s+class%s*=%s*["\']jcConfig["\'](.-)</pre>', '{{[Ff]orm calculator%s*|(.+)}}' ) do
for config in dualGmatch( pageContent, '<[pd][ri][ev]%s+class%s*=%s*["\']jcConfig["\'](.-)</[pd][ri][ev]>', '{{[Ff]orm calculator%s*|(.+)}}' ) do
        local moduleName = string.match( config, 'module%s*=%s*(.-)[\n|]' )
local moduleName = string.match( config, 'module%s*=%s*(.-)[\n|]' )
        if param.has_content( moduleName ) then
if param.has_content( moduleName ) then
            moduleName = formatModuleName( moduleName )
moduleName = formatModuleName( moduleName )
            local funcName = string.match( config, 'modulefunc%s*=%s*(.-)[\n|]' ) or 'main'
local funcName = string.match( config, 'modulefunc%s*=%s*(.-)[\n|]' ) or 'main'
            table.insert( invokeList, {moduleName=moduleName, funcName=funcName} )
table.insert( invokeList, {moduleName=moduleName, funcName=funcName} )
        end
end
    end
end


    invokeList = arr.unique( invokeList, function(x) return x.moduleName..x.funcName end )
invokeList = arr.unique( invokeList, function(x) return x.moduleName..x.funcName end )
    table.sort( invokeList, function(x, y) return x.moduleName..x.funcName < y.moduleName..y.funcName end )
table.sort( invokeList, function(x, y) return x.moduleName..x.funcName < y.moduleName..y.funcName end )


    return invokeList
return invokeList
end
end


---@param pageName string
local function getInvokedByList( moduleName )
---@param addCategories boolean
local whatTemplatesLinkHere = dpl.ask( {
---@return string
namespace = 'Template|Calculator',
local function messageBoxUnused( pageName, addCategories )
linksto = moduleName,
    local html = mw.html.create( 'table' ):addClass( 'messagebox obsolete plainlinks' )
distinct = 'strict',
    html:tag( 'td' )
ordermethod = 'title',
        :attr( 'width', '40xp' )
allowcachedresults = true,
        :wikitext( '[[File:Willow logs (historical).png|center|30px|link=]]' )
cacheperiod = 604800 -- One week
    :done()
} )
    :tag( 'td' )
 
        :wikitext( "'''This module is unused.'''" )
local function lcfirst( str )
        :tag( 'div' )
return string.gsub( str, '^[Mm]odule:.', string.lower )
            :css{ ['font-size']='0.85em', ['line-height']='1.45em' }
end
            :wikitext( string.format( 'This module is neither invoked by a template nor required/loaded by another module. If this is in error, make sure to add <code>{{[[Template:Documentation|Documentation]]}}</code>/<code>{{[[Template:No documentation|No&nbsp;documentation]]}}</code> to the calling template\'s or parent\'s module documentation.', pageName ) )
            :wikitext( addCategories and '[[Category:Unused modules]]' or '' )
        :done()
    :done()


    return tostring( html )
local invokedByList = {}
 
for _, templateName in ipairs( whatTemplatesLinkHere ) do
local invokeList = getInvokeCallList( templateName )
 
for _, invokeData in ipairs( invokeList ) do
if lcfirst( invokeData.moduleName ) == lcfirst( moduleName ) then
table.insert( invokedByList, { templateName=templateName, funcName=invokeData.funcName } )
end
end
end
 
return invokedByList
end
 
local function messageBoxUnused()
local html = mw.html.create( 'table' ):addClass( 'messagebox obsolete plainlinks' )
html:tag( 'td' )
:attr( 'width', '40xp' )
:wikitext( '[[File:Willow logs (historical).png|center|30px|link=]]' )
:done()
:tag( 'td' )
:wikitext( "'''This module is unused.'''" )
:tag( 'div' )
:css{ ['font-size']='0.85em', ['line-height']='1.45em' }
:wikitext( 'This module is neither invoked by a template nor required/loaded by another module. If this is in error, make sure to add <code>{{[[Template:Documentation|Documentation]]}}</code>/<code>{{[[Template:No documentation|No&nbsp;documentation]]}}</code> to the calling template\'s or parent\'s module documentation.' )
:done()
:done()
 
return tostring( html )
end
end


local function collapseList( list, id, listType )
local function collapseList( list, id, listType )
    local text = string.format( '%d %s', #list, listType )
local text = string.format( '%d %s', #list, listType )
    local button = tooltip._span{ name=id, alt=text }
local button = tooltip._span{ name=id, alt=text }
    list = arr.map( list, function(x) return '\n# '..x end )
list = arr.map( list, function(x) return '\n# '..x end )
    local content = tooltip._div{ name=id, content='\n'..table.concat( list )..'\n\n' }
local content = tooltip._div{ name=id, content='\n'..table.concat( list )..'\n\n' }


    return { tostring( button ) .. tostring( content ) }
return { tostring( button ) .. tostring( content ) }
end
end


--- Creates a link to [[Special:Search]] showing all pages found by getDynamicRequireList() in case it found more than MAX_DYNAMIC_REQUIRE_LIST_LENGTH pages.
-- Creates a link to [[Special:Search]] showing all pages found by getDynamicRequireList() in case it found more than MAX_DYNAMIC_REQUIRE_LIST_LENGTH pages.
---@param query string      @This will be in a format like 'Module:Wowee/%' or 'Module:Wowee/%/data'
-- Input query uses DPL % wildcards like 'Module:Wowee/%' or 'Module:Wowee/%/data'
---@return string
local function formatDynamicQueryLink( query )
local function formatDynamicQueryLink( query )
    local prefix = query:match( '^([^/]+)' )
local prefix = query:match( '^([^/]+)' )
    local linkText = query:gsub( '%%', '&lt; ... &gt;' )
local linkText = query:gsub( '%%', '&lt; ... &gt;' )


    query = query:gsub( '^Module:',  '' )
query = query:gsub( '^Module:',  '' )


    query = query:gsub( '([^/]+)/?', function ( match )
query = query:gsub( '([^/]+)/?', function ( match )
        if match == '%' then
if match == '%' then
            return '\\/[^\\/]+'
return '\\/[^\\/]+'
        else
else
            return '\\/"' .. match .. '"'
return '\\/"' .. match .. '"'
        end
end
    end )
end )


    query = query:gsub( '^\\/', '' )
query = query:gsub( '^\\/', '' )


    query = string.format(
query = string.format(
        'intitle:/%s%s/i -intitle:/%s\\/""/i -intitle:doc prefix:"%s"',
'intitle:/%s%s/i -intitle:/%s\\/""/i -intitle:doc prefix:"%s"',
        query,
query,
        query:find( '"$' ) and '' or '""',
query:find( '"$' ) and '' or '""',
        query,
query,
        prefix
prefix
    )
)


    return string.format( '<span class="plainlinks">[%s %s]</span>', tostring( mw.uri.fullUrl( 'Special:Search', { search = query } ) ), linkText )
return string.format( '<span class="plainlinks">[%s %s]</span>', tostring( mw.uri.fullUrl( 'Special:Search', { search = query } ) ), linkText )
end
end


---@param templateName string
local function formatModuleLinks( pages )
---@param addCategories boolean
local links = arr{}
---@param invokeList table<string, string>[]    @This is the list returned by getInvokeCallList()
 
---@return string
for _, moduleName in ipairs(pages) do
local function formatInvokeCallList( templateName, addCategories, invokeList )
if moduleName:find( '%%' ) then
    local category = addCategories and '[[Category:Lua-based templates]]' or ''
links:insert( formatDynamicQueryLink( moduleName ) )
    local res = {}
elseif builtins[moduleName] then
links:insert( '[[' .. builtins[moduleName].link .. '|' .. moduleName .. ']]' )
else
links:insert( '[[' .. moduleName .. ']]' )
end
end
 
return links
end


    for _, item in ipairs( invokeList ) do
local function formatTemplateLinks( pages )
        table.insert( res, string.format(
local links = arr{}
            "<div class='seealso'>'''%s''' invokes function '''%s''' in [[%s]] using [[RuneScape:Lua|Lua]].</div>",
            templateName,
            item.funcName,
            item.moduleName
        ) )
    end


    if #invokeList > 0 then
for _, templateName in ipairs(pages) do
        table.insert( res, category )
if string.find( templateName, ':' ) then -- Real templates are prefixed by a namespace, magic words are not
    end
links:insert( '[['..templateName..']]' )
else
links:insert( "'''&#123;&#123;"..templateName.."&#125;&#125;'''" ) -- Magic words don't have a page so make them bold instead
end
end


    return table.concat( res )
return links
end
end


---@param moduleName string
local function formatInvokeCallList( templateName, invokeList )
---@param addCategories boolean
local res = {}
---@param whatLinksHere string    @A list generated by a dpl of pages in the Template or Calculator namespace which link to moduleName.
---@return string
local function formatInvokedByList( moduleName, addCategories, whatLinksHere )
    local function lcfirst( str )
        return string.gsub( str, '^[Mm]odule:.', string.lower )
    end


    local templateData = arr.map( whatLinksHere, function(x) return {templateName=x, invokeList=getInvokeCallList(x)} end )
for _, item in ipairs( invokeList ) do
    templateData = arr.filter( templateData, function(x)
table.insert( res, string.format(
        return arr.any( x.invokeList, function(y)
"<div class='seealso'>'''%s''' invokes function '''%s''' in [[%s]] using [[RuneScape:Lua|Lua]].</div>",
            return lcfirst(y.moduleName) == lcfirst(moduleName)
templateName,
        end )
item.funcName,
    end )
item.moduleName
) )
end


    local invokedByList = {}
return table.concat( res )
 
end
    for _, template in ipairs( templateData ) do
        for _, invoke in ipairs( template.invokeList ) do
            table.insert( invokedByList, string.format( "function '''%s''' is invoked by [[%s]]", invoke.funcName, template.templateName ) )
        end
    end


    table.sort( invokedByList)
local function formatInvokedByList( moduleName, invokedByList )
for i, invoke in ipairs( invokedByList ) do
invokedByList[i] = string.format( "function '''%s''' is invoked by [[%s]]", invoke.funcName, invoke.templateName )
end


    local res = {}
table.sort( invokedByList)


    if #invokedByList > COLLAPSE_LIST_LENGTH_THRESHOLD then
local res = {}
        table.insert( res, string.format(
            "<div class='seealso'>'''%s''' is invoked by %s.</div>",
            moduleName,
            collapseList( invokedByList, 'invokedBy', 'templates' )[1]
        ) )
    else
        for _, item in ipairs( invokedByList ) do
            table.insert( res, string.format(
                "<div class='seealso'>'''%s's''' %s.</div>",
                moduleName,
                item
            ) )
        end
    end


    if #templateData > 0 then
if #invokedByList > COLLAPSE_LIST_LENGTH_THRESHOLD then
        moduleIsUsed = true
table.insert( res, string.format(
        table.insert( res, (addCategories and '[[Category:Template invoked modules]]' or '') )
"<div class='seealso'>'''%s''' is invoked by %s.</div>",
    end
moduleName,
collapseList( invokedByList, 'invokedBy', 'templates' )[1]
) )
else
for _, item in ipairs( invokedByList ) do
table.insert( res, string.format(
"<div class='seealso'>'''%s's''' %s.</div>",
moduleName,
item
) )
end
end


    return table.concat( res )
return table.concat( res )
end
end


---@param moduleName string
local function formatRequiredByList( moduleName, requiredByLists )
---@param addCategories boolean
local requiredByList = formatModuleLinks( requiredByLists.require )
---@param whatLinksHere string      @A list generated by a dpl of pages in the Module namespace which link to moduleName.
local loadedByList = formatModuleLinks( requiredByLists.loadData )
---@return string
local function formatRequiredByList( moduleName, addCategories, whatLinksHere )
    local childModuleData = arr.map( whatLinksHere, function ( title )
        local lists = getRequireList( title )
        return {name=title, requireList=lists.requireList, loadDataList=lists.loadDataList .. lists.loadJsonDataList}
    end )


    local requiredByList = arr.map( childModuleData, function ( item )
if #requiredByList > COLLAPSE_LIST_LENGTH_THRESHOLD then
        if arr.any( item.requireList, function(x) return x:lower()==moduleName:lower() end ) then
requiredByList = collapseList( requiredByList, 'requiredBy', 'modules' )
            if item.name:find( '%%' ) then
end
                return formatDynamicQueryLink( item.name )
            else
                return '[[' .. item.name .. ']]'
            end
        end
    end )


    local loadedByList = arr.map( childModuleData, function ( item )
if #loadedByList > COLLAPSE_LIST_LENGTH_THRESHOLD then
        if arr.any( item.loadDataList, function(x) return x:lower()==moduleName:lower() end ) then
loadedByList = collapseList( loadedByList, 'loadedBy', 'modules' )
            if item.name:find( '%%' ) then
end
                return formatDynamicQueryLink( item.name )
            else
                return '[[' .. item.name .. ']]'
            end
        end
    end )


    if #requiredByList > 0 or #loadedByList > 0 then
local res = {}
        moduleIsUsed  = true
    end


    if #requiredByList > COLLAPSE_LIST_LENGTH_THRESHOLD then
for _, requiredByModuleName in ipairs( requiredByList ) do
        requiredByList = collapseList( requiredByList, 'requiredBy', 'modules' )
table.insert( res, string.format(
    end
"<div class='seealso'>'''%s''' is required by %s.</div>",
moduleName,
requiredByModuleName
) )
end


    if #loadedByList > COLLAPSE_LIST_LENGTH_THRESHOLD then
for _, loadedByModuleName in ipairs( loadedByList ) do
        loadedByList = collapseList( loadedByList, 'loadedBy', 'modules' )
table.insert( res, string.format(
    end
"<div class='seealso'>'''%s''' is loaded by %s.</div>",
moduleName,
loadedByModuleName
) )
end


    local res = {}
return table.concat( res )
 
end
    for _, requiredByModuleName in ipairs( requiredByList ) do
        table.insert( res, string.format(
            "<div class='seealso'>'''%s''' is required by %s.</div>",
            moduleName,
            requiredByModuleName
        ) )
    end


    if #requiredByList > 0 then
local function formatImportList( currentPageName, moduleList, id, message )
        table.insert( res, (addCategories and '[[Category:Modules required by modules]]' or '') )
moduleList = formatModuleLinks( moduleList )
    end


    for _, loadedByModuleName in ipairs( loadedByList ) do
if #moduleList > COLLAPSE_LIST_LENGTH_THRESHOLD then
        table.insert( res, string.format(
moduleList = collapseList( moduleList, id, 'modules' )
            "<div class='seealso'>'''%s''' is loaded by %s.</div>",
end
            moduleName,
            loadedByModuleName
        ) )
    end


    if #loadedByList > 0 then
local res = arr.map( moduleList, function( moduleName )
        table.insert( res, (addCategories and '[[Category:Module data]]' or '') )
return '<div class="seealso">' .. string.format( message, currentPageName, moduleName ) .. '</div>'
    end
end )


    return table.concat( res )
return table.concat( res )
end
end


local function formatImportList( currentPageName, moduleList, id, message, category )
local function formatUsedTemplatesList( currentPageName, usedTemplateList )
    if #moduleList > COLLAPSE_LIST_LENGTH_THRESHOLD then
usedTemplateList = formatTemplateLinks( usedTemplateList )
        moduleList = collapseList( moduleList, id, 'modules' )
local res = {}
    end


    local res = arr.map( moduleList, function( moduleName )
if #usedTemplateList > COLLAPSE_LIST_LENGTH_THRESHOLD then
        return '<div class="seealso">' .. string.format( message, currentPageName, moduleName ) .. '</div>'
usedTemplateList = collapseList( usedTemplateList, 'usedTemplates', 'templates' )
    end )
end


    if #moduleList > 0 and category then
for _, templateName in ipairs( usedTemplateList ) do
        table.insert( res, string.format( '[[Category:%s]]', category ) )
table.insert( res, string.format(
    end
"<div class='seealso'>'''%s''' transcludes %s using <samp>frame:preprocess()</samp>.</div>",
currentPageName,
templateName
) )
end


    return table.concat( res )
return table.concat( res )
end
end


local function formatUsedTemplatesList( currentPageName, addCategories, usedTemplateList )
local function setBucketFields( requireLists )
    local res = {}
if mw.title.getCurrentTitle().subpageText ~= 'doc' and (#requireLists.require > 0 or #requireLists.loadData > 0) then
bucket( 'dependency_list' ).put{
require = requireLists.require,
load_data = requireLists.loadData
}
end
end


    if #usedTemplateList > COLLAPSE_LIST_LENGTH_THRESHOLD then
local function getRequiredByLists( currentPageName )
        usedTemplateList = collapseList( usedTemplateList, 'usedTemplates', 'templates' )
local requiredByListRaw = bucket( 'dependency_list' ).select( 'page_name' ).where( 'require', currentPageName ).run()
    end
local loadedByListRaw = bucket( 'dependency_list' ).select( 'page_name' ).where( 'load_data', currentPageName ).run()
local requiredByList = {}
local loadedByList = {}


    for _, templateName in ipairs( usedTemplateList ) do
for _, bucketItem in ipairs( requiredByListRaw ) do
        table.insert( res, string.format(
table.insert( requiredByList, bucketItem.page_name )
            "<div class='seealso'>'''%s''' transcludes %s using <samp>frame:preprocess()</samp>.</div>",
end
            currentPageName,
for _, bucketItem in ipairs( loadedByListRaw ) do
            templateName
table.insert( loadedByList, bucketItem.page_name )
        ) )
end
    end


    return table.concat( res )
requiredByList = arr.unique( requiredByList )
loadedByList = arr.unique( loadedByList )
table.sort( requiredByList )
table.sort( loadedByList )
 
return {
require = requiredByList,
loadData = loadedByList
}
end
end


function p.main( frame )
local function templateDependencyList( currentPageName, addCategories )
    local args = frame:getParent().args
local invokeList = getInvokeCallList( currentPageName )
    return p._main( args[1], args.category, args.isUsed )
local res = formatInvokeCallList( currentPageName, invokeList )
 
if addCategories and #invokeList > 0 then
res = res .. '[[Category:Lua-based templates]]'
end
 
return res
end
end


---@param currentPageName string|nil
local function moduleDependencyList( currentPageName, addCategories, isUsed )
---@param addCategories boolean|string|nil
local moduleContent = mw.title.new( currentPageName ):getContent()
---@return string
assert( moduleContent, string.format( 'Failed to retrieve text content of page "%s"', currentPageName ) )
function p._main( currentPageName, addCategories, isUsed )
moduleContent = moduleContent:gsub( '%-%-%[(=-)%[.-%]%1%]', '' ):gsub( '%-%-[^\n]*', '' ) -- Strip comments
    libraryUtil.checkType( 'Module:RequireList._main', 1, currentPageName, 'string', true )
    libraryUtil.checkTypeMulti( 'Module:RequireList._main', 2, addCategories, {'boolean', 'string', 'nil'} )
    libraryUtil.checkTypeMulti( 'Module:RequireList._main', 3, isUsed, {'boolean', 'string', 'nil'} )


    local title = mw.title.getCurrentTitle()
local requireLists = getRequireLists( moduleContent )
local usedTemplateList = getUsedTemplatesList( moduleContent )
local requiredByLists = getRequiredByLists( currentPageName )
local invokedByList = getInvokedByList( currentPageName )


    -- Leave early if not in module, template or calculator namespace or if module is part of exchange or data groups
setBucketFields( requireLists )
    if param.is_empty( currentPageName ) and (
        ( not arr.contains( {'Module', 'Template', 'Calculator'}, title.nsText ) ) or
        ( title.nsText == 'Module' and ( arr.contains( {'Exchange', 'Exchange historical', 'Data'}, title.text:match( '^(.-)/' ) ) ) )
    ) then
        return ''
    end


    currentPageName = param.default_to( currentPageName, title.fullText )
local res = arr{}
    currentPageName = string.gsub( currentPageName, '/[Dd]oc$', '' )
    currentPageName = formatPageName( currentPageName )
    addCategories = yn( param.default_to( addCategories, title.subpageText~='doc' ) )
    moduleIsUsed = yn( param.default_to( isUsed, false ) )


    if title.text:lower():find( 'sandbox' ) then
res:insert( formatInvokedByList( currentPageName, invokedByList ) )
        moduleIsUsed = true -- Don't show sandbox modules as unused
res:insert( formatImportList( currentPageName, requireLists.require, 'require', "'''%s''' requires %s." ) )
    end
res:insert( formatImportList( currentPageName, requireLists.loadData, 'loadData', "'''%s''' loads data from %s." ) )
res:insert( formatUsedTemplatesList( currentPageName, usedTemplateList ) )
res:insert( formatRequiredByList( currentPageName, requiredByLists ) )


    if currentPageName:find( '^Template:' ) or currentPageName:find( '^Calculator:' ) then
if addCategories then
        local invokeList = getInvokeCallList( currentPageName )
res:insert( requireLists.extraCategories, true )
        return formatInvokeCallList(currentPageName, addCategories, invokeList)
    end


    local whatTemplatesLinkHere, whatModulesLinkHere = dpl.ask( {
if #requireLists.require > 0 then
        namespace = 'Template|Calculator',
res:insert( '[[Category:Modules requiring modules]]')
        linksto = currentPageName,
end
        distinct = 'strict',
if #requireLists.loadData > 0 then
        ignorecase = true,
res:insert( '[[Category:Modules using data]]')
        ordermethod = 'title',
end
        allowcachedresults = true,
if #requiredByLists.require > 0 then
        cacheperiod = 604800 -- One week
res:insert( '[[Category:Modules required by modules]]')
    }, {
end
        namespace = 'Module',
if #requiredByLists.loadData > 0 then
        linksto = currentPageName,
res:insert( '[[Category:Module data]]')
        nottitlematch = '%/doc|Exchange/%|Exchange historical/%|Data/%|' .. currentPageName:gsub( 'Module:', '' ),
end
        distinct = 'strict',
if #invokedByList > 0 then
        ignorecase = true,
res:insert( '[[Category:Template invoked modules]]')
        ordermethod = 'title',
end
        allowcachedresults = true,
end
        cacheperiod = 604800 -- One week
    } )


    local lists = getRequireList( currentPageName, true )
if
not (
yn( isUsed )
or currentPageName:lower():find( 'sandbox' )
or #requiredByLists.require > 0
or #requiredByLists.loadData > 0
or #invokedByList > 0
)
then
table.insert( res, 1, messageBoxUnused() )


    local requireList = arr.map( lists.requireList, function ( moduleName )
if addCategories then
        if moduleName:find( '%%' ) then
res:insert( '[[Category:Unused modules]]')
            return formatDynamicQueryLink( moduleName )
end
        elseif builtins[moduleName] then
end
            return '[[' .. builtins[moduleName].link .. '|' .. moduleName .. ']]'
        else
            return '[[' .. moduleName .. ']]'
        end
    end )


    local loadDataList = arr.map( lists.loadDataList, function ( moduleName )
return table.concat( res )
        if moduleName:find( '%%' ) then
end
            return formatDynamicQueryLink( moduleName )
        else
            return '[[' .. moduleName .. ']]'
        end
    end )


    local loadJsonDataList = arr.map( lists.loadJsonDataList, function ( moduleName )
function p.main( frame )
        if moduleName:find( '%%' ) then
local args = frame:getParent().args
            return formatDynamicQueryLink( moduleName )
return p._main( args[1], args.category, args.isUsed )
        else
end
            return '[[' .. moduleName .. ']]'
        end
    end )


    local usedTemplateList = arr.map( lists.usedTemplateList, function( templateName )
function p._main( currentPageName, addCategories, isUsed )
        if string.find( templateName, ':' ) then -- Real templates are prefixed by a namespace, magic words are not
libraryUtil.checkType( 'Module:RequireList._main', 1, currentPageName, 'string', true )
            return '[['..templateName..']]'
libraryUtil.checkTypeMulti( 'Module:RequireList._main', 2, addCategories, {'boolean', 'string', 'nil'} )
        else
libraryUtil.checkTypeMulti( 'Module:RequireList._main', 3, isUsed, {'boolean', 'string', 'nil'} )
            return "'''&#123;&#123;"..templateName.."&#125;&#125;'''" -- Magic words don't have a page so make them bold instead
        end
    end )


    local res = {}
local title = mw.title.getCurrentTitle()


    table.insert( res, formatInvokedByList( currentPageName, addCategories, whatTemplatesLinkHere ) )
-- Leave early if not in module, template or calculator namespace or if module is part of exchange or data groups
    table.insert( res, formatImportList( currentPageName, requireList, 'require', "'''%s''' requires %s.", addCategories and 'Modules requiring modules' ) )
if param.is_empty( currentPageName ) and (
    table.insert( res, formatImportList( currentPageName, loadDataList, 'loadData', "'''%s''' loads data from %s.", addCategories and 'Modules using data' ) )
( not arr.contains( {'Module', 'Template', 'Calculator'}, title.nsText ) ) or
    table.insert( res, formatImportList( currentPageName, loadJsonDataList, 'loadJsonData', "'''%s''' loads data from %s.", addCategories and 'Modules using data' ) )
( title.nsText == 'Module' and ( arr.contains( {'Exchange', 'Exchange historical', 'Data'}, title.text:match( '^(.-)/' ) ) ) )
    table.insert( res, formatUsedTemplatesList( currentPageName, addCategories, usedTemplateList ) )
) then
    table.insert( res, formatRequiredByList( currentPageName, addCategories, whatModulesLinkHere ) )
return ''
end


    if addCategories then
currentPageName = param.default_to( currentPageName, title.fullText )
        local extraCategories = arr.map( lists.extraCategories, function( categoryName )
currentPageName = string.gsub( currentPageName, '/[Dd]oc$', '' )
            return "[[Category:" .. categoryName .. "]]"
currentPageName = formatPageName( currentPageName )
        end )


        table.insert( res, table.concat( extraCategories ) )
if (addCategories == nil) then
    end
addCategories = title.subpageText~='doc'
end
addCategories = yn(addCategories)


    if not moduleIsUsed then
if currentPageName:find( '^Template:' ) or currentPageName:find( '^Calculator:' ) then
        table.insert( res, 1, messageBoxUnused( currentPageName:gsub( 'Module:', '' ), addCategories ) )
return templateDependencyList( currentPageName, addCategories )
    end
end


    return table.concat( res )
return moduleDependencyList( currentPageName, addCategories, isUsed )
end
end


return p
return p
Retrieved from "https://deadlock.wiki/Module:DependencyList"