Erlang语言服务器（Erlang LS）使用教程

Erlang语言服务器（Erlang LS）使用教程

erlang_lsThe Erlang Language Server项目地址:https://gitcode.com/gh_mirrors/er/erlang_ls

项目介绍

Erlang语言服务器（Erlang LS）是一个为Erlang编程语言提供语言特性的服务器。它实现了诸如自动补全、跳转到定义等功能，并且可以与多种文本编辑器和IDE（如Emacs、VSCode、Sublime Text 3、Vim等）配合使用。Erlang LS遵循语言服务器协议（LSP），这使得它能够与支持LSP的任何开发工具集成。

项目快速启动

环境要求

• Erlang OTP 24+
• rebar3 3.9.1+

编译和安装

1. 克隆项目仓库：

   git clone https://github.com/erlang-ls/erlang_ls.git
   cd erlang_ls
   

2. 编译项目：

   make
   

3. 安装生成的erlang_ls脚本到/usr/local/bin：

   make install
   

   如果要安装到其他目录，可以设置PREFIX环境变量：

   PREFIX=/path/to/directory make install
   

命令行参数

以下是erlang_ls脚本可用的命令行参数：

Usage: erlang_ls [-v] [-t [<transport>]] [-p [<port>]] [-d [<log_dir>]] [-l [<log_level>]]
  -v --version      打印Erlang LS的当前版本
  -t --transport    指定服务器使用的传输方式，可以是"tcp"或"stdio" [默认: tcp]
  -p --port         当传输方式为tcp时使用 [默认: 10000]
  -d --log_dir      指定日志目录
  -l --log_level    指定日志级别

应用案例和最佳实践

在VSCode中使用Erlang LS

1. 安装VSCode扩展：

   • 打开VSCode，进入扩展市场，搜索并安装“Erlang LS”扩展。

2. 配置Erlang LS：

   • 在VSCode的设置中，找到“Erlang LS”配置项，设置Erlang LS的路径和其他相关配置。

3. 启动Erlang LS：

   • 打开一个Erlang项目，VSCode会自动启动Erlang LS并提供语言服务。

在Emacs中使用Erlang LS

1. 安装Emacs LSP客户端：

   • 使用use-package或其他方式安装lsp-mode。

2. 配置Erlang LS：

   • 在Emacs配置文件中添加以下配置：

     (use-package lsp-mode
       :ensure t
       :hook (erlang-mode . lsp)
       :commands lsp)
     

3. 启动Erlang LS：

   • 打开一个Erlang文件，Emacs会自动启动Erlang LS并提供语言服务。

典型生态项目

rebar3

rebar3是一个用于构建和测试Erlang项目的工具，Erlang LS依赖于rebar3来识别项目结构和依赖。

Erlang/OTP

Erlang/OTP是Erlang编程语言的标准库和运行时系统，Erlang LS支持OTP 24及更高版本。

LSP协议

语言服务器协议（LSP）是一个开放协议，用于在开发工具和语言服务器之间进行通信，Erlang LS遵循这一协议以实现跨平台的兼容性。

通过以上步骤，您可以快速启动并使用Erlang LS，享受其提供的丰富语言服务功能。

erlang_lsThe Erlang Language Server项目地址:https://gitcode.com/gh_mirrors/er/erlang_ls