๐ EmmyLua2 for IntelliJ IDEA
โจ Features
Powered by the robust emmylua-analyzer-rust engine
๐ฏ Core Features
- Smart Code Completion - Context-aware precise code suggestions
- Syntax Highlighting - Support for Lua 5.1/5.2/5.3/5.4 syntax
- Error Detection - Real-time syntax and semantic error reporting
- Code Navigation - Quick jump to definitions, find references
- Refactoring Support - Rename, extract variables and other refactoring operations
๐ง Advanced Features
- EmmyLua Annotations Support - Complete type annotation system
- Debugger Integration - Built-in EmmyLua debugger (TCP connect/listen); Emmy Attach Debugger for attaching to running processes (Windows only)
- Multi-platform Support - Full support for Windows, macOS, Linux (Emmy Attach Debugger is Windows only)
- Performance Optimization - High-performance language server based on Rust
๐ ๏ธ Installation
Install from JetBrains Marketplace (Recommended)
- Open IntelliJ IDEA
- Go to
File โ Settings โ Plugins
- Search for "EmmyLua2"
- Click
Install to install the plugin
- Restart IDE
Manual Installation
- Download the latest version from Releases
- In IntelliJ IDEA, go to
File โ Settings โ Plugins
- Click the gear icon โ
Install Plugin from Disk...
- Select the downloaded plugin file
- Restart IDE
๐ Quick Start
Create Lua Project
File โ New โ Project
- Select
Lua project type
- Configure project settings
- Start writing Lua code!
Configure EmmyLua Annotations
---@class Player
---@field name string
---@field level number
local Player = {}
---Create new player
---@param name string Player name
---@param level number Player level
---@return Player
function Player:new(name, level)
return setmetatable({
name = name,
level = level
}, { __index = self })
end
๐ง Supported IDE Versions
| IDE Version |
Plugin Version |
Status |
| 2024.3+ |
0.8.x |
โ
Actively Supported |
| 2025.2+ |
0.12.x |
โ
Actively Supported |
๐ค Contributing
We welcome contributions of all kinds! Please check the Contributing Guide to learn how to participate in the project.
Development Environment Setup
๐ Prerequisites
- JDK 17+ - Recommended to use OpenJDK or Oracle JDK
- IntelliJ IDEA 2024.3+ - Ultimate or Community Edition
- Git - Version control tool
๐จ Build Steps
Clone Repository
git clone https://github.com/CppCXY/Intellij-EmmyLua2.git
cd Intellij-EmmyLua2
Import Project
- Open the project with IntelliJ IDEA
- Wait for Gradle sync to complete
Build Plugin
./gradlew buildPlugin
Run Development Environment
./gradlew runIde
๐ฏ Available Gradle Tasks
| Task |
Description |
buildPlugin |
Build plugin distribution package |
runIde |
Run plugin in IDE sandbox |
test |
Run test suite |
downloadEmmyLuaAnalyzer |
Download Emmy Lua Analyzer |
installDependencies |
Install all dependencies |
cleanDependencies |
Clean downloaded dependencies |
๐ Acknowledgments
๐ License
This project is open source under the MIT License.
โญ If this project helps you, please give us a Star!
Made with โค๏ธ by CppCXY