Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cppcxy/emmyluacodestyle
fast, powerful, and feature-rich Lua formatting and checking tool.
https://github.com/cppcxy/emmyluacodestyle
emmylua formatter linter lsp lua
Last synced: 6 days ago
JSON representation
fast, powerful, and feature-rich Lua formatting and checking tool.
- Host: GitHub
- URL: https://github.com/cppcxy/emmyluacodestyle
- Owner: CppCXY
- License: mit
- Created: 2021-10-07T14:17:54.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-01T10:58:34.000Z (4 months ago)
- Last Synced: 2024-10-13T08:24:31.816Z (3 months ago)
- Topics: emmylua, formatter, linter, lsp, lua
- Language: C++
- Homepage:
- Size: 7.62 MB
- Stars: 138
- Watchers: 4
- Forks: 27
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# EmmyLuaCodeStyle
[English doc](README_EN.md)
## 编辑器支持
vscode:
[vscode-EmmyLuaCodeStyle](https://marketplace.visualstudio.com/items?itemName=CppCXY.emmylua-codestyle)
[vscode-Lua](https://marketplace.visualstudio.com/items?itemName=sumneko.lua)
intellij:
[intellij-EmmyLuaCodeStyle](https://plugins.jetbrains.com/plugin/21973-emmyluacodestyle)
neovim:
[Lua Language Server](https://github.com/LuaLS/lua-language-server)
## 项目介绍
该项目`不是lua代码格式的规范`, 而是基于C++实现的lua代码解析\格式化\代码诊断算法库和语言服务实例
该项目主要追求的是合理的格式化，多样的代码风格
该项目除了提供语言服务实例，也提供独立的命令行工具CodeFormat，他能用于批量的代码格式化和代码风格检查。
## Feature
* 支持lua5.1, lua5.2, lua5.3, lua5.4, luajit
* 文档格式化
* 范围格式化
* 命名风格检查
* 代码格式检查
* 代码拼写检查
* 可以作为lua库/cli工具/C++解析lua库/语言服务使用
## RoadMap
* plugin[0%]
## 文档
* [格式化行为介绍](docs/format_action.md)
* [如何配置格式化](docs/format_config.md)
* [如何配置命名风格检查](docs/name_style.md)
# Contribute
任何pr或者issue都是欢迎的
## Build
如果希望能自己编译该项目，确保自己的编译器能基本支持C++20：
* VS2019 16.10以上
* gcc 10以上
* clang 10以上
```
mkdir build && cd build
cmake ..
cmake --build .
```
## Developed By
[**@CppCXY**](https://github.com/CppCXY)
**Contributors**
[**@obszczymucha**](https://github.com/obszczymucha)
[**@Rainer Poisel**](https://github.com/rpoisel)
[**@AndreaWalchshoferSCCH**](https://github.com/AndreaWalchshoferSCCH)
[**@一醉青衫**](https://github.com/qq792453582)
## License
[MIT](LICENSE)