Erlang Language Server 项目教程

1. 项目的目录结构及介绍

Erlang Language Server（以下简称 Erlang LS）是一个为 Erlang 语言提供语言服务器协议（LSP）支持的开源项目。以下是该项目的主要目录结构及其介绍：

• apps/: 包含 Erlang LS 的主要应用程序。

  • els_lsp/: 语言服务器协议的实现。
  • els_code_navigation/: 代码导航功能。
  • els_code_lens/: 代码镜头功能。
  • els_completion/: 代码补全功能。
  • els_diagnostics/: 代码诊断功能。
  • els_dtl/: Django 模板语言支持。
  • els_formatting/: 代码格式化功能。
  • els_hover/: 悬停提示功能。
  • els_signature_help/: 签名帮助功能。
  • els_workspace_symbols/: 工作区符号功能。

• config/: 包含项目的配置文件。

  • erlang_ls.config: 主配置文件。

• doc/: 包含项目的文档文件。

  • README.md: 项目说明文档。
  • CONTRIBUTING.md: 贡献指南。
  • CHANGELOG.md: 变更日志。

• rebar.config: 项目的构建配置文件。

• test/: 包含项目的测试文件。

  • els_lsp_tests/: 语言服务器协议的测试。

2. 项目的启动文件介绍

Erlang LS 的启动文件位于 apps/els_lsp/src/els_lsp.erl。该文件是 Erlang LS 的主入口点，负责启动语言服务器并初始化各种功能模块。以下是该文件的主要功能：

• start/0: 启动语言服务器。
• init/1: 初始化服务器状态。
• handle_request/2: 处理客户端请求。
• handle_notification/2: 处理客户端通知。

3. 项目的配置文件介绍

Erlang LS 的配置文件位于 config/erlang_ls.config。该文件定义了语言服务器的各种配置选项，包括代码路径、诊断规则、代码镜头设置等。以下是该文件的主要配置项：

• apps/: 应用程序路径。
• include/: 包含文件路径。
• deps/: 依赖路径。
• diagnostics/: 诊断规则。
• code_lens/: 代码镜头设置。
• completion/: 代码补全设置。
• formatting/: 代码格式化设置。

通过编辑 erlang_ls.config 文件，用户可以根据自己的需求自定义 Erlang LS 的行为。