Revise README_EN.md for improved clarity and structure#209
Open
waddie96 wants to merge 1 commit intoCppCXY:masterfrom
Open
Revise README_EN.md for improved clarity and structure#209waddie96 wants to merge 1 commit intoCppCXY:masterfrom
waddie96 wants to merge 1 commit intoCppCXY:masterfrom
Conversation
Updated README_EN.md to enhance clarity and structure, including an introduction to EmmyLuaCodeStyle, editor integration, features, use cases, and build instructions.
CppCXY
reviewed
Oct 23, 2025
| In addition to providing language service examples, the project also provides an independent command line tool CodeFormat, which can be used for batch code formatting and code style checking. | ||
| - [Lua for VSCode](https://marketplace.visualstudio.com/items?itemName=sumneko.lua) or [EmmyLuaCodeStyle for VSCode](https://marketplace.visualstudio.com/items?itemName=CppCXY.emmylua-codestyle) | ||
| - [SumnekoLua for IntelliJ](https://plugins.jetbrains.com/plugin/22315-sumnekolua) or [EmmyLuaCodeStyle in JetBrains IntelliJ](https://plugins.jetbrains.com/plugin/21973-emmyluacodestyle) | ||
| - [LuaLS for Neovim](https://github.com/LuaLS/lua-language-server) |
Owner
There was a problem hiding this comment.
Add emmylua: https://marketplace.visualstudio.com/items?itemName=tangzx.emmylua
Add emmylua-analyzer: https://github.com/EmmyLuaLs/emmylua-analyzer-rust
Add intellij-emmylua2: https://plugins.jetbrains.com/plugin/25076-emmylua2
| ## RoadMap | ||
| * plugin[0%] | ||
| - **80+ configuration options**: Customise indentation, alignment, spacing, and line wrapping using `.editconfig` syntax. | ||
| - **Extended syntax support**: Handles EmmyLua annotations and Lua extensions seamlessly. |
| # EmmyLuaCodeStyle | ||
|
|
||
| If possible, you can help me improve the English document | ||
| _Fast, configurable, and feature-rich Lua formatting and checking language server._ |
Contributor
Author
There was a problem hiding this comment.
Sorry I don't understand what you mean. Could you be more specific?
Owner
There was a problem hiding this comment.
This project mainly exists in the form of a library and command-line tool; the language server part can be ignored. Both luals and emmylua-ls are introduced as libraries.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updated README_EN.md to enhance clarity and structure, including an introduction to EmmyLuaCodeStyle, editor integration, features, use cases, and build instructions.