Lua Language Server Addon for MediaWiki Scribunto

This is an addon for MediaWiki Scribunto that can be used by the Lua Language Server. It adds definitions for Scribunto APIs.

How to use

The addon manager for VS Code allows users to easily install and manage their addons. The addons are pulled from LLS-Addons. It is recommended to use this addon along with Wikitext extension, which pulls module pages from MW and streamlines the editing flow.

For other editors, you will need to manually download the addon and configure your editor to use it. This can be done by:

• Create a directory for all LuaLS addons.
• git clone this repository into that directory.
• Open a LuaLS configuration file. Either
  • Use client configuration (editor-specific), or
  • Use luarc.json file (project-specific)
• Configure your editor to use the directory as the addon path.

{
  "workspace.userThirdParty": ["/path/to/luals/addons"]
}

Progress

Definitions for all vanilla Scribunto APIs are now complete. The definitions for extensions are still in progress.

Details

• mw
• frame object
• mw.hash
• mw.html
• mw.language
• mw.message
• mw.site
• mw.svg
• mw.text
• mw.title
• mw.uri
• mw.ustring
• bit32
• libraryUtil
• luabit
• strict
• ustring

Extensions

• mw.wikibase
• mw.wikibase.lexeme
• mw.wikibase.mediainfo
• mw.bcmath
• mw.smw
• mw.ext.data
• mw.ext.cargo
• mw.ext.cattools
• mw.ext.FlaggedRevs
• mw.ext.tabber
• mw.ext.TitleBlacklist
• mw.ext.translate.messageBundle
• mw.ext.ParserFunctions
• mw.ext.proofreadPage
• mw.ext.articlePlaceholder
• mw.ext.externalData
• mw.ext.UnlinkedWikibase
• mw.ext.seo
• mw.ext.VariablesLua
• mw.slots
• bucket

Licensing and acknowledgements

This addon is licensed under the MIT license. See LICENSE for the full license text.

The definition documentations are derived from Lua reference manual on MediaWiki.org, which is further derived from the Lua 5.1 reference manual, both of which are available under the MIT license.

Generative AI is used to help generate the definitions based on the manual, which are further refined by human.

(Last updated to revision 8338227)