Does anyone have a good setup for Luau on PyCharm (or other Jetbrains IDEs)

[LouChiSoft]

Hi, I have no experience with Luau (or Lua) and was hoping to use PyCharm as my IDE. I have seen that it has a couple of Lua extensions, but none mention support for Lua.

Has anyone got a good setup for Luau that they would be willing to share?

Thanks

[goldenstein64]

Unfortunately, I don't use PyCharm as my IDE. I use VSCode, which has unbelievably good Luau support thanks to JohnnyMorganz/luau-lsp.

I think EmmyLua offers similar support for a JetBrains IDE? I wouldn't know...

If you really want the same support coming from a JetBrains IDE, you could maybe create a language client extension that uses Luau LSP, I'm not sure how viable that is.

[JohnnyMorganz]

Since then there is also https://github.com/AleksandrSl/intellij-luau which has some development

[virus-rpi]

well for https://github.com/AleksandrSl/intellij-luau there isn't even a release yet and the last commit was a year ago

[JohnnyMorganz]

See dev branch

[angelozerr]

you can use the luau-lsp and then just use the LSP4IJ plugin to connect it to any Jetbrains IDE.

Config:

• for command put in path/to/your/luau-lsp.exe lsp --definitions=path/to/your/globalTypes.d.luau --docs=path/to/your/rb-docs.json
• for mappings add entries for file type and file names with the launguage ids luau and lua. you can set file type to auto detect and file name pattern to *.luau and *.lua

I think it could be a good idea that you share your config with template https://github.com/redhat-developer/lsp4ij/blob/main/docs/UserDefinedLanguageServerTemplate.md in order to user could benefit from your work just by installing LSP4IJ like for instance for astro-ls https://github.com/redhat-developer/lsp4ij/blob/main/docs/user-defined-ls/astro-ls.md#install-the-language-server

I have worked on install support (which will be soon released) of language server and several language servers like astro, rust, clangd, clojure, typescript, etc can be downloaded when language server starts, so you don't need to do something. Just create the language server with the dialog (by using template) and it should work out of the box.

I noticed that luau-lsp provides https://github.com/JohnnyMorganz/luau-lsp/releases so it is doable to do that. You need just to write https://github.com/redhat-developer/lsp4ij/blob/main/docs/UserDefinedLanguageServerTemplate.md#github-asset-download

If you need help, please ask me.

there are some small bugs with this solution: syntax highlighting sometimes is broken for luau specific stuff (normal lua works fine) and if you import types from another module you sometimes have to restart the lsp server for it to work correctly

@virus-rpi which version of LSP4IJ are you using? I suggest that you try https://github.com/redhat-developer/lsp4ij?tab=readme-ov-file#testing-nightly-builds If you have again troubles please create issues.

[angelozerr]

@virus-rpi I noticed also that it exists a DAP debugger for luau at https://github.com/sssooonnnggg/luau-debugger

LSP4IJ supports DAP support and you can also write a template for DAP (no need to create an IJ plugin). Just write few JSON file like https://github.com/redhat-developer/lsp4ij/tree/main/src/main/resources/templates/dap/vscode-js-debug

[angelozerr]

Ok I have integrated quickly luau-lsp in LSP4IJ, you can install for the moment https://github.com/redhat-developer/lsp4ij?tab=readme-ov-file#testing-nightly-builds and follow the demo redhat-developer/lsp4ij#1094 to know how to create the language server

It is not perfect since the language server is registered with this template https://github.com/redhat-developer/lsp4ij/tree/main/src/main/resources/templates/lsp/luau-lsp If you want to have a better integration, you will need to create an IJ plugin based on LSP4IJ.