🕷 Tarantool VS Code Extension

Tarantool VS Code Extension helps you to develop Tarantool applications in VS Code. It enhances your text editor with completions, suggestions, and snippets.

Features

This extension offers the following features.

• Static type checks and documentation for the most popular Lua and Tarantool builtin modules.
• Cluster configuration schema validation for Tarantool 3.0+.
• tt cluster management utility inside the command palette.
• Other auxiliary commands, e.g. install Tarantool of a specific version right from VS Code.

Usage

That's how you use this extension.

• Install the extension from the VS Code marketplace.
• Open a Tarantool project in VS Code.
• Run Tarantool: Initialize VS Code extension in existing app command from the command palette (Ctrl+Shift+P or Cmd+Shift+P on macOS).

You may statically type your Lua functions as follows.

---@class user_info
---@field name string User's name.
---@field age? number User's age (optional).

---@alias user_tuple [string, number]

---@param tuples user_tuple[]
---@return user_info[]
local function deflatten_users(tuples)
    -- ...
end

---@type user_info
local unnamed_user = { name = 'Unnamed' }

For more examples, refer to the examples folder with tutorials on how to type your Lua code.

Contributing

Feel free to open issues on feature requests, wrong type annotations and bugs. If you're dealing with a problem related to LSP we'd appreciate addressing a direct issue to the used external Lua Language server.

We also appreciate contributions via pull requests.

Thank you for your interest in Tarantool and its development tools!

References & acknowledgments

This is an extension for the Tarantool database. It uses VS Code EmmyLua extension with emmylua-analyzer-rust under the hood and RedHat YAML extension dependencies as providers of Lua and YAML language servers and extend them with Tarantool-specific annotations.

A lot of the initial work has been done by Tarantool community in the original Tarantool VS Code annotations.