Skip to content

Home

Jump to bottom
carsakiller edited this page Aug 3, 2023 · 30 revisions

⚠️ Warning

This wiki has been replaced by the wiki on our website. This wiki will be removed in the future.

Welcome

Lua development just got a whole lot better 🧠

Welcome to Sumneko's Lua language server wiki!

This repository is home to the Lua language server used by sumneko/vscode-lua which is a Visual Studio Code extension that operates as the client for this language server using the LSP protocol.

Don't use Visual Studio Code? The server can also be used from the command line so you can use it with other editors that support language servers.

Features

The language server has plenty of features to explore, here is a list of some of them:

Get Started

Check out Getting Started to start using the Lua language server and start developing better.

Learn

Below are some resources to learn more about the language server and some of its more advanced features.

Configuration

To configure the language server just the way you want it, view the configuration file page and settings page.

Libraries

Libraries are supported in a number of ways. There are some super powerful library features that allow you to define your libraries elsewhere and link them to your current workspace with your source code.

Plugins

If you are looking to extend or modify the Lua syntax but still want to use the language server, plugins can allow you to do just that.

Code Formatter

Making your code look pretty can be a time-sink that can be hard to justify spending time on. Luckily, the language server also comes with a code formatter to help you write your prettiest code.

FAQ

For answers to some frequently asked questions, take a look at the FAQ page.

You can also visit the discussions page to discuss ideas, ask questions, and get help.

Please make sure to check for duplicate discussions first ❤️

It can help you find an answer quicker and helps keeps things organized.

Privacy

In order to provide error reports and statistics to the developers, there is opt-in telemetry logging. Please read the privacy policy in one of the available languages below before using this software.

The results of the telemetry logging are public and can be found at http://154.23.191.39/.

Contributing

Thank you for your interest in helping improve the language server!

Found a bug or want to suggest a new feature? The issues page is the place to go!

Are you able to provide translations? There is also a translations page.

Looking to get right into coding? Head over to the developing section.

Have improvements for this wiki? You are absolutely welcome to open up an issue to provide fixes and suggest improvements!

Sponsor

Sponsorships are appreciated and help continue development of the language server. More info can be found in #484.

Clone this wiki locally