Complete Guide on Setting up VSCode for Lua and KOReader

[Maimun Ahmed]

Hi there, I am here with another issue.

I am currently working on a plugin for KOReader for which I require to clone KOReader into my Linux computer (specifically ubuntu on VM). For that, I require to install lua and some other cool features like hyperlinking (clicking on the path inside the require function takes me to that code file in that path) and auto suggestions (like suggestions of the code imported from another directory within koreader), etc (much like setting up a javascript framework like next.js). My current IDE is VSCode.

Hope so you guys can understand and help. I have been using next.js for a very long time and it would be very great if I could set up a similar development experience for lua as well.



PS: I currently have lua installed in my computer and VSCode running but I have to work without any suggestions. There were not enough tutorials available on YouTube for ubuntu as well.

[pazos]

Not very familiar with vscode, but it seems all you need is a client that talks LSP, such as https://github.com/LuaLS/lua-language-server and all the "go to definition" et al functions should work out of the box with any competent editor.

Also, you'll want editorconfig because the coding style differs from most lua codebases (ie: identation at 4 spaces)

[Frenzie]

I think if you open a Lua file VS Code will prompt you to install a variety of Lua support extensions, after which basic linting, go to and code completion should just work.

You'll still have to follow some of the steps in https://github.com/koreader/koreader...-and-derivates though (provided you want to compile and not just edit)

[jospalau]

There are several extensions.

To debug you can use the Local Lua Debugger. It works really good.