|
| 1 | +# Introduction to the features of the EmmyLua Language Server |
| 2 | + |
| 3 | +[中文介绍](./features_CN.md) |
| 4 | + |
| 5 | +## Auto Completion |
| 6 | + |
| 7 | +Supports standard code completion, including functions, variables, table fields, and modules. In addition, EmmyLua includes more advanced completion features: |
| 8 | +- `auto require` Shows Lua modules that have return values in the completion list. When pressing Tab, it automatically adds the require statement for that module at the top of the file after existing require statements. |
| 9 | +- `alias enum` Automatically completes corresponding alias or enum fields based on the parameter type in the current function. |
| 10 | +- `function` Suggests lambda expressions if the current function parameter is a function type. |
| 11 | +- `namespace` If the current variable is a namespace type, EmmyLua automatically completes sub-namespaces or class names. Declare a namespace type using `---@type namespace<"ClassName">`. |
| 12 | +- `module path` When typing within the argument of require, EmmyLua completes module paths, supporting both '.' and '/' as separators. |
| 13 | +- `file system path` In any string containing '/' or '\\', EmmyLua tries to complete file system paths based on relevant settings. |
| 14 | +- `postfix` When typing the '@' symbol after any variable, the corresponding postfix expressions are suggested. This symbol can also be replaced with '.'. |
| 15 | +- `snippet` Provides basic code snippet completions. Future releases may support custom templates via a file template system. |
| 16 | + |
| 17 | +## Code Hints |
| 18 | + |
| 19 | +Displays traditional hover hints for variables, functions, table fields, and modules. EmmyLua also offers additional features for code hints: |
| 20 | +- `const` If the current variable is a constant type, hovering over it displays the variable’s value. For constant expressions, EmmyLua calculates and shows the expression result. |
| 21 | + |
| 22 | +## Code Checks |
| 23 | + |
| 24 | +EmmyLua leverages EmmyLua doc for comprehensive code checks. These checks can be disabled or enabled via configuration files, or controlled using annotations such as: |
| 25 | +```lua |
| 26 | +---@diagnostic disable: undefined-global |
| 27 | +``` |
| 28 | +This disables undefined-global checks in the current file. |
| 29 | + |
| 30 | +```lua |
| 31 | +---@diagnostic disable-next-line: undefined-global |
| 32 | +``` |
| 33 | +This disables undefined-global checks for the following line. |
| 34 | + |
| 35 | +You can configure these checks in a config file, for example: |
| 36 | +```json |
| 37 | +{ |
| 38 | + "diagnostics": { |
| 39 | + "disable": ["undefined-global"] |
| 40 | + } |
| 41 | +} |
| 42 | +``` |
| 43 | + |
| 44 | +## Document Symbols |
| 45 | + |
| 46 | +EmmyLua supports structured document symbols. In VSCode, these can be viewed in the OUTLINE panel on the left or by pressing Ctrl+Shift+O. |
| 47 | + |
| 48 | +## Workspace Symbol Search |
| 49 | + |
| 50 | +EmmyLua supports workspace-wide symbol searches. In VSCode, press Ctrl+T, type '@', then the symbol name to search for the corresponding symbol. |
| 51 | + |
| 52 | +## Refactoring |
| 53 | + |
| 54 | +EmmyLua supports variable and field rename refactoring. In VSCode, use the F2 shortcut for this operation. |
| 55 | + |
| 56 | +## Code Formatting |
| 57 | + |
| 58 | +EmmyLua supports the "Format Document" and "Format Selection" features in VSCode, using [EmmyLuaCodeStyle](https://github.com/CppCXY/EmmyLuaCodeStyle). Refer to its documentation for related configurations. |
| 59 | + |
| 60 | +## Code Folding |
| 61 | + |
| 62 | +EmmyLua supports standard code folding for functions, if-statements, for-loops, while-loops, etc. Additionally, it supports folding for comment blocks marked by `--region` and `--endregion`. |
| 63 | + |
| 64 | +## Go to Definition |
| 65 | + |
| 66 | +In VSCode, EmmyLua supports "Go to Definition" and "Peek Definition." You can also Ctrl+click with the mouse to jump to definition. |
| 67 | + |
| 68 | +## Find References |
| 69 | + |
| 70 | +EmmyLua supports "Find All References" in VSCode. You can also Ctrl+click with the mouse to find references. Special cases include: |
| 71 | +- String reference search: If you select a string, you can use "Find All References" or Ctrl+click to find all references of that string. |
| 72 | +- Fuzzy references: If a selected variable has no definition, EmmyLua attempts a fuzzy reference search. This can be enabled or disabled via the configuration file. |
| 73 | + |
| 74 | +## Document Color |
| 75 | + |
| 76 | +EmmyLua attempts to detect sequences of six or eight hexadecimal digits in a string and interpret them as color values, displaying a color preview. |
| 77 | + |
| 78 | +## Document Link |
| 79 | + |
| 80 | +EmmyLua tries to detect possible file paths in strings and displays clickable links to open those paths. |
| 81 | + |
| 82 | +## Semantic Highlighting |
| 83 | + |
| 84 | +EmmyLua supports `semanticHighlighting` as defined by the LSP, assigning appropriate highlighting based on token analysis. |
| 85 | + |
| 86 | +## EmmyLua Annotator |
| 87 | + |
| 88 | +EmmyLua extends code rendering through a private protocol, for example, underlining mutable local variables. |
| 89 | + |
| 90 | +## Inlay Hints |
| 91 | + |
| 92 | +EmmyLua can display additional hints, such as parameter types, variable types, and whether a function overrides a parent class method or is an await call. These hints can be enabled or disabled via configuration. |
| 93 | + |
| 94 | +## Document Highlight |
| 95 | + |
| 96 | +Although VSCode’s built-in document highlight is sufficient, EmmyLua also provides its own highlight feature for variable references and related keywords. This is especially useful for editors that require language server-based highlighting. |
| 97 | + |
0 commit comments