# EmmyLua Analyzer ## Docs - [@alias - Type Alias](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/annotations/alias.md): Create reusable type aliases, enumerations, and simplified complex type expressions - [@async - Async Function Marker](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/annotations/async.md): Mark asynchronous functions for coroutine support and async patterns - [@cast - Type Casting](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/annotations/cast.md): Force type conversion and type narrowing for variables - [@class - Class Definition](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/annotations/class.md): Define classes and interfaces with inheritance, fields, and access control - [@deprecated - Deprecation Marker](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/annotations/deprecated.md): Mark functions, classes, or fields as deprecated with guidance for alternatives - [@diagnostic - Diagnostic Control](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/annotations/diagnostic.md): Control diagnostic warnings and errors for specific code sections - [@enum - Enumeration Definition](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/annotations/enum.md): Mark Lua tables as enumerations with runtime-available values - [@field - Field Definition](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/annotations/field.md): Define fields for classes with access control, optionality, and index signatures - [@generic - Generic Types](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/annotations/generic.md): Define generic parameters for type-safe, reusable functions and classes - [Introduction to Annotations](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/annotations/introduction.md): Learn about EmmyLua annotations and how they enhance Lua development with type checking and auto-completion - [@meta - Metadata File](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/annotations/meta.md): Mark files as containing only type definitions and metadata, not runtime code - [@module - Module Declaration](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/annotations/module.md): Declare module information and export types for better organization - [@nodiscard - Non-discardable Return Value](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/annotations/nodiscard.md): Mark function return values that must be checked and should not be ignored - [@operator - Operator Overloading](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/annotations/operator.md): Define operator overloads for classes to enable custom operator behavior - [@overload - Function Overload](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/annotations/overload.md): Define multiple function signatures for flexible parameter combinations - [@param - Parameter Definition](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/annotations/param.md): Define parameter types, optional parameters, and variadic arguments with IDE support - [@return - Return Value Definition](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/annotations/return.md): Document return types, multiple return values, and conditional returns - [@see - Reference to Other Symbols](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/annotations/see.md): Create references to related functions, classes, or external documentation - [@source - Source Code Reference](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/annotations/source.md): Specify the original source location for generated or imported code - [Annotation Syntax](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/annotations/syntax.md): Learn the basic syntax rules and formatting for writing EmmyLua annotations - [@type - Type Declaration](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/annotations/type.md): Declare explicit type information for variables, expressions, and values - [@version - Version Requirements](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/annotations/version.md): Specify version requirements for APIs, features, or compatibility - [emmylua_check](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/cli/emmylua-check.md): Static analysis and diagnostics tool for Lua codebases - [emmylua_doc](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/cli/emmylua-doc.md): Generate beautiful API documentation from Lua source code and annotations - [emmylua_ls](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/cli/emmylua-ls.md): Language Server Protocol (LSP) implementation for Lua development - [Diagnostic Configuration](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/config/diagnostics.md): Configure diagnostic rules, severity levels, and file-level control - [.emmyrc.json Reference](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/config/emmyrc.md): Complete reference for all EmmyLua Analyzer configuration options - [Formatting Configuration](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/config/formatting.md): Configure code formatting with EmmyLua Analyzer and external tools - [Configuration Overview](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/config/overview.md): Learn how to configure EmmyLua Analyzer using .emmyrc.json - [Editor Setup](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/editor-setup.md): Configure EmmyLua Analyzer in your favorite editor - [Smart Completion](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/features/completion.md): Industry-leading intelligent code completion with auto require, lambda generation, and more - [Code Diagnostics](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/features/diagnostics.md): Real-time error detection and code quality analysis with EmmyLua annotations - [Code Formatting](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/features/formatting.md): Professional code formatting with EmmyLuaCodeStyle integration and customizable options - [Code Navigation](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/features/navigation.md): Powerful navigation features for quickly locating and browsing code in large projects - [Refactoring](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/features/refactoring.md): Safe and efficient code refactoring tools with scope analysis and conflict detection - [Architecture Overview](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/guides/architecture.md): Understanding the structure and design of EmmyLua Analyzer - [Building from Source](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/guides/building.md): Learn how to build EmmyLua Analyzer from source code - [Code Style](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/guides/code-style.md): Configure code formatting, style rules, and enforce team conventions - [Contributing Guide](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/guides/contributing.md): Guidelines for contributing to EmmyLua Analyzer - [External Formatters](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/guides/external-formatters.md): Integrate StyLua, lua-format, or custom formatters with EmmyLua Analyzer - [IntelliJ IDEA Setup](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/guides/intellij.md): Set up EmmyLua Analyzer in IntelliJ IDEA and other JetBrains IDEs - [Neovim Setup](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/guides/neovim.md): Set up EmmyLua Analyzer in Neovim with native LSP support - [Other Editors Setup](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/guides/other-editors.md): Set up EmmyLua Analyzer in Sublime Text, Emacs, Vim, and other LSP-compatible editors - [Performance Optimization](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/guides/performance.md): Optimize EmmyLua Analyzer for large codebases and improve analysis speed - [Type Checking](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/guides/type-checking.md): Advanced type checking patterns, strict mode, and type inference configuration - [VS Code Setup](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/guides/vscode.md): Set up EmmyLua Analyzer in Visual Studio Code - [Installation](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/installation.md): Install EmmyLua Analyzer components using various methods - [Introduction](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/introduction.md): A powerful, high-performance Lua language analyzer built with Rust - [Quick Start](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/quickstart.md): Get up and running with EmmyLua Analyzer in 5 minutes ## OpenAPI Specs - [openapi](https://mintlify.wiki/EmmyLuaLs/emmylua-analyzer-rust/api-reference/openapi.json)