Lua-LSP 项目使用教程

1. 项目目录结构及介绍

lua-lsp/
├── bin/
│   └── lua-lsp
├── lua-lsp/
│   ├── init.lua
│   ├── ...
├── rockspecs/
│   ├── lua-lsp-scm-0.rockspec
│   ├── ...
├── scripts/
│   ├── install.sh
│   ├── ...
├── spec/
│   ├── test_suite.lua
│   ├── ...
├── .gitignore
├── .luacheckrc
├── .luacompleterc
├── .travis.yml
├── LICENSE.md
├── editors.md
├── lua-lsp-scm-0.rockspec
├── readme.md
└── ...

目录结构说明

• bin/: 存放可执行文件，如 lua-lsp。
• lua-lsp/: 项目的主要代码目录，包含 Lua 语言服务器的核心逻辑。
• rockspecs/: 存放项目的 LuaRocks 配置文件。
• scripts/: 存放安装和构建脚本。
• spec/: 存放测试用例和测试套件。
• .gitignore: Git 忽略文件配置。
• .luacheckrc: LuaCheck 配置文件，用于代码检查。
• .luacompleterc: Lua 自动补全配置文件。
• .travis.yml: Travis CI 配置文件。
• LICENSE.md: 项目许可证文件。
• editors.md: 编辑器集成说明文件。
• lua-lsp-scm-0.rockspec: LuaRocks 配置文件。
• readme.md: 项目介绍和使用说明。

2. 项目启动文件介绍

启动文件

• bin/lua-lsp: 这是项目的可执行文件，用于启动 Lua 语言服务器。

启动方式

$ ./bin/lua-lsp

启动后，Lua 语言服务器将通过标准输入输出与客户端（如编辑器）进行通信。

3. 项目配置文件介绍

配置文件

• .luacheckrc: 用于配置 LuaCheck 的代码检查规则。
• .luacompleterc: 用于配置 Lua 自动补全的规则。

配置示例

.luacheckrc

-- 配置 LuaCheck 的规则
unused_args = true
unused_secondaries = true

.luacompleterc

-- 配置 Lua 自动补全的规则
luaVersion = "5.3"

通过这些配置文件，可以自定义 Lua 语言服务器的行为，以适应不同的开发需求。