Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ketho/vscode-wow-api

VS Code extension for World of Warcraft AddOns
https://github.com/ketho/vscode-wow-api

vscode-extension world-of-warcraft

Last synced: about 2 hours ago
JSON representation

VS Code extension for World of Warcraft AddOns

Host: GitHub
URL: https://github.com/ketho/vscode-wow-api
Owner: Ketho
License: mit
Created: 2020-05-10T11:54:47.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-10-29T12:15:56.000Z (3 months ago)
Last Synced: 2024-10-29T14:38:45.500Z (3 months ago)
Topics: vscode-extension, world-of-warcraft
Language: TypeScript
Homepage: https://marketplace.visualstudio.com/items?itemName=ketho.wow-api
Size: 27.3 MB
Stars: 150
Watchers: 6
Forks: 33
Open Issues: 10
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        ## WoW API for VS Code

[![](https://img.shields.io/github/license/Ketho/vscode-wow-api)](https://opensource.org/licenses/MIT)

[![](https://img.shields.io/github/v/release/Ketho/vscode-wow-api)](https://github.com/Ketho/vscode-wow-api/releases)

[![](https://img.shields.io/badge/mainline-11.0.7-yellow)](https://github.com/Ketho/BlizzardInterfaceResources/tree/11.0.7)

[![](https://img.shields.io/badge/cata-4.4.1-yellow)](https://github.com/Ketho/BlizzardInterfaceResources/tree/4.4.1)

[![](https://img.shields.io/badge/vanilla-1.15.5-yellow)](https://github.com/Ketho/BlizzardInterfaceResources/tree/1.15.5)

Adds IntelliSense features for World of Warcraft API to VS Code. This is a third party extension for [LuaLS](https://marketplace.visualstudio.com/items?itemName=sumneko.lua) with [annotations](https://luals.github.io/wiki/annotations/).

### Features

#### API

* Includes the WoW Lua 5.1 environment

* Loads the official Blizzard [API documentation](https://github.com/Gethe/wow-ui-source/tree/live/Interface/AddOns/Blizzard_APIDocumentationGenerated)

* Parses [Warcraft Wiki](https://warcraft.wiki.gg/wiki/World_of_Warcraft_API) API documentation

![](https://github.com/Ketho/vscode-wow-api/raw/master/img/readme/api.gif)

#### [Widgets](https://warcraft.wiki.gg/wiki/Widget_API)

![](https://github.com/Ketho/vscode-wow-api/raw/master/img/readme/widget.gif)

#### [Events](https://warcraft.wiki.gg/wiki/Events)

![](https://github.com/Ketho/vscode-wow-api/raw/master/img/readme/event.gif)

#### [CVars](https://warcraft.wiki.gg/wiki/Console_variables)

![](https://github.com/Ketho/vscode-wow-api/raw/master/img/readme/cvar.png)

#### [Enums](https://github.com/Ketho/BlizzardInterfaceResources/blob/mainline/Resources/LuaEnum.lua)

* `Enum` and `Constants` table

* `LE_` Lua Enums

![](https://github.com/Ketho/vscode-wow-api/raw/master/img/readme/enum.gif)

#### [GlobalStrings](https://github.com/Ketho/BlizzardInterfaceResources/blob/mainline/Resources/GlobalStrings.lua)

Shows completion for GlobalStrings at >3 uppercase letters to declutter fuzzy search.

![](https://github.com/Ketho/vscode-wow-api/raw/master/img/readme/globalstring.gif)

### Activation

This extension will only activate when either:

- A proper [.toc](https://warcraft.wiki.gg/wiki/TOC_format) file exists when the workspace is opened.

- The extension was previously loaded in the workspace.

- The "Activate WoW API extension" command is used.

![](img/readme/activate.png)

Note that if the `Configuration Scope` setting is set to `User` instead of `Workspace` and the extension has loaded once, then it will simply always load for Lua files, just like the old behavior.

## AddOn namespace

The [AddOn namespace](https://warcraft.wiki.gg/wiki/Using_the_AddOn_namespace) needs to be annotated with [@class](https://luals.github.io/wiki/annotations/#class) in each file. This way the language server knows about the shared table and also allows you to mutate it.

- `file1.lua`

```lua

---@class ns

local ns = select(2, ...)

ns.foo = "hello"

```

- `file2.lua`

```lua

---@class ns

local ns = select(2, ...)

ns.bar = "world"

```

![](https://github.com/Ketho/vscode-wow-api/assets/1073877/ec0d7c95-201c-4b4a-a378-29b058df558a)

## Deprecated API

If you intend to use deprecated APIs for Classic, the warning and strikethrough can be removed by disabling its diagnostic.

![](img/readme/deprecated.png)

### Documentation

More documentation is available on the [project wiki](https://github.com/Ketho/vscode-wow-api/wiki).

## Contributing

The extension *reflects* the state of the wiki, so if you create/update the wiki pages, it will be updated in the extension on the next release. Only functions on https://warcraft.wiki.gg/wiki/World_of_Warcraft_API which are not documented in [Blizzard_APIDocumentationGenerated](https://github.com/Gethe/wow-ui-source/tree/live/Interface/AddOns/Blizzard_APIDocumentationGenerated) will be synchronized.

For example [UnitLevel](https://warcraft.wiki.gg/wiki/API_UnitLevel) would be documented like so.

```lua

{{wowapi}}

Returns the level of the unit.

 level = UnitLevel(unit)

==Arguments==

:;unit:{{apitype|UnitToken}}

==Returns==

:;level:{{apitype|number}}

```

Alternatively, the script will look for a commented block in the wikitext of the API pages.

```lua

```

### Developing

- Linux: Refer to [SETUP.md](SETUP.md) if you want to run the Lua scripts which generate the documentation.

- Windows: I personally use LuaRocks on Windows but I like to shoot myself in the foot too. I should change this to use GitHub Actions or dev containers I suppose.

  - https://ketho.github.io/2024/07/04/luarocks-on-windows/

## Acknowledgements

- [Blizzard Entertainment](https://www.blizzard.com/)

- [Townlong Yak](https://www.townlong-yak.com/) - [Foxlit](https://www.townlong-yak.com/)

- [Wago Tools](https://wago.tools/) - [QartemisT](https://github.com/QartemisT)

- [Warcraft Wiki](https://warcraft.wiki.gg/) - [Kaydeethree](https://github.com/kaydeethree)

- [WoWInterface](https://wowinterface.com/)

- [Wowprogramming](https://wowprogramming.com/) - [jnwhiteh](https://twitter.com/jnwhiteh)

- [WoW.tools](https://wow.tools/) - [Marlamin](https://github.com/Marlamin)  

 

- **Annotations**: [Kozoaku](https://github.com/Kozoaku), [Numy](https://github.com/Numynum), [Oppzippy](https://github.com/Oppzippy), [Snakybo](https://github.com/Snakybo), [Torhal](https://github.com/Torhal), [Wutname](https://github.com/Wutname1)

- **FrameXML**: [funkydude](https://github.com/funkydude), [Gethe](https://github.com/Gethe), [Tekkub](https://github.com/tekkub)

- **LuaLS**: [Sumneko](https://github.com/Sumneko), [carsakiller](https://github.com/carsakiller)

- **VS Code extension**: [ChrisKader](https://github.com/ChrisKader), [DakJaniels](https://github.com/DakJaniels), [thatnerdjosh](https://github.com/thatnerdjosh), [Yuyuli](https://www.curseforge.com/members/yuyuli)

- **Wiki**: [DahkCeles](https://www.curseforge.com/members/dahkceles/projects), [Foxlit](https://www.townlong-yak.com/), [Iriel](https://warcraft.wiki.gg/wiki/Iriel), [Xelnath](https://warcraft.wiki.gg/wiki/Alexander_Brazie)  

 

- **Algalon**: [Ghost](https://github.com/Ghostopheles)

- **Amazing people**: [Andols](https://www.curseforge.com/members/andols/projects), [Cidan](https://github.com/Cidan), [Ferronn](https://github.com/ferronn-dev), [Meorawr](https://github.com/Meorawr), [Nevcairiel](https://github.com/Nevcairiel)

- **BlizzardInterfaceResources**: [Resike](https://github.com/Resike)

- **DeadlyBossMods**: [Tandanu](https://github.com/emmericp), [MysticalOS](https://github.com/MysticalOS)

- **IntelliJ-IDEA-Lua-IDE-WoW-API**: [Ellypse](https://github.com/Ellypse)

- **WeakAuras**: [Buds](https://github.com/mrbuds), [Stanzilla](https://github.com/Stanzilla)