🎯 What Makes Us Different

🏗️ Architecture & Crates

Our project is meticulously organized into specialized crates, each serving a critical role in the Lua analysis ecosystem:

Crate	Badge	Description
🔍 emmylua_parser		The foundational Rust-based Lua parser engineered for maximum efficiency and accuracy. Powers all downstream analysis tools.
🧠 emmylua_code_analysis		Advanced semantic analysis engine providing deep code understanding, type inference, and cross-reference resolution.
🖥️ emmylua_ls		The complete Language Server Protocol implementation offering rich IDE features across all major editors.
📚 emmylua_doc_cli		Professional documentation generator creating beautiful, searchable API docs from your Lua code and annotations.
✅ emmylua_check		Comprehensive static analysis tool for code quality assurance, catching bugs before they reach production.

✨ Features

🚀 Quick Start

Prerequisites

Before getting started, ensure you have Rust installed on your system:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

📦 Installation

Choose your preferred installation method:

# Install the language server
cargo install emmylua_ls

# Install documentation generator
cargo install emmylua_doc_cli

# Install static analyzer
cargo install emmylua_check

git clone https://github.com/CppCXY/emmylua-analyzer-rust.git
cd emmylua-analyzer-rust
cargo build --release -p emmylua_ls

🎮 Editor Integration

vim.lsp.enable({"emmylua_ls"})

📖 Documentation

• 📖 Features Guide - Comprehensive feature documentation
• ⚙️ Configuration - Advanced configuration options
• 🎨 Code Style - Formatting and style guidelines

🛠️ Usage & Examples

🖥️ Language Server (emmylua_ls)

Start the language server with default settings:

emmylua_ls

Advanced usage with custom configuration:

# TCP mode for remote debugging
emmylua_ls -c tcp --port 5007 --log-level debug --log-path ./logs

# Stdio mode (default)
emmylua_ls -c stdio --log-level info

# Stdio mode default parameters
emmylua_ls

Server Parameters:

• -c, --communication: Communication method (stdio | tcp)
• --port: TCP port when using TCP mode (default: 5007)
• --log-level: Logging level (debug | info | warn | error)
• --log-path: Directory for log files

📚 Documentation Generator (emmylua_doc_cli)

Generate beautiful API documentation:

# Basic usage
emmylua_doc_cli --input ./src --output ./docs

✅ Static Analyzer (emmylua_check)

Perform comprehensive code analysis:

# Analyze current workspace
emmylua_check .

# Analyze specific directory with detailed output
emmylua_check ./src --verbose --format json

🏗️ Development

Building from Source

# Clone the repository
git clone https://github.com/CppCXY/emmylua-analyzer-rust.git
cd emmylua-analyzer-rust

# Build all crates
cargo build --release

# Build specific components
cargo build --release -p emmylua_ls
cargo build --release -p emmylua_doc_cli
cargo build --release -p emmylua_check

Testing

# Run all tests
cargo test

# Run tests for specific crate
cargo test -p emmylua_parser

# Run with coverage
cargo test --all-features --no-fail-fast

Contributing

We welcome contributions!.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.