Lua for Visual Studio Code
Provides Intellisense and Linting for Lua in VSCode
Features
- Autocompletion
- Go to Symbol
- Error checking
- Linting
- Formatting
- Code Snippets
Installing
- Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter:
ext install vscode-lua
Alternatively, you can download the extension from the marketplace.
Settings
lua.luacheckPath (Default: null)
Specifies the path to luacheck binary (if not found on PATH).
lua.preferLuaCheckErrors (Default: false)
Specifies whether to prefer luacheck errors over the standard luaparse errors if luacheck is available.
lua.targetVersion (Default: 5.1)
Specifies the target version of Lua. Valid options:
- 5.1
- 5.2
- 5.3
Can also be changed using the version selector in the bottom right of the IDE.
lua.format.enabled (Default: true)
Specifies whether to use the Lua formatter
lua.format.lineWidth (Default: 120)
Maximum length of a line before it will be wrapped.
lua.format.indentCount (Default: 4)
Number of characters to indent.
lua.format.singleQuote (Default: false)
Whether to use single or double quotes on strings. Defaults to double quotes.
lua.linting.enabled (Default: true)
Specifies whether to enable linting of source files
lua.linting.luaCheckConfig (Default: null)
Path to a .luacheckrc to be used for linting, instead of the default luacheck search path
lua.linting.luaCheckArgs (Default: [])
Additional arguments to pass to luacheck
Luacheck
Support for linting is provided via luacheck. Installation instructions can be found on the luacheck repository.
Once installed, luacheck support can be activated by assigning the lua.luacheckPath setting to the path of the luacheck executable. Additionally, since luacheck provides vastly more detailed and contextually aware errors that may sometimes duplicate those created by luaparse, the setting lua.preferLuaCheckErrors can be set to true to suppress luaparse errors.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Acknowledgments
- Oskar Schรถldstrรถm - luaparse: A Lua parser written in JavaScript
- Mikael Hermansson - node-hot: Hot-reloading for Node.js
- Peter Melnichenko - luacheck: A tool for linting and static analysis of Lua code.