VSCode 中配置 Elixir 开发环境需安装 ElixirLS 扩展、验证 Erlang/OTP 与 Elixir 版本、配置 settings.json、设置 launch.json 调试、重启语言服务器及启用 mix format 格式化。

如果您在 VSCode 中开发 Elixir 项目,但无法正确识别语法、跳转定义或启动调试会话,则可能是由于扩展未安装、配置缺失或 Erlang/OTP 环境未就绪。以下是完成 VSCode for Elixir 基础配置与调试功能的多种实现方式:
本文运行环境:MacBook Pro,macOS Sequoia。
一、安装核心扩展与依赖
VSCode 本身不原生支持 Elixir,需通过官方维护的扩展提供语言服务与调试能力,同时依赖本地 Erlang/OTP 和 Elixir 运行时环境。
1、打开 VSCode 扩展市场(Ctrl+Shift+X 或 Cmd+Shift+X),搜索并安装 ElixirLS: Elixir Support 扩展。
2、确保系统已安装 Erlang/OTP(推荐 26.x)与 Elixir(推荐 1.17.x),可通过终端执行 elixir --version 和 erl -version 验证。
3、重启 VSCode,使扩展加载 Erlang/OTP 路径并初始化语言服务器。
二、配置 elixirLS 启动参数
elixirLS 默认行为可能无法适配特定项目结构(如 umbrella 项目或自定义 build 目录),需通过 workspace 设置显式指定路径与选项。
1、在项目根目录创建 .vscode/settings.json 文件(若不存在)。
2、写入以下内容:
3、将 "elixirLS.projectDir" 的值设为当前项目路径(例如 "./" 或 "./apps/my_app")。
4、对 umbrella 项目,启用 "elixirLS.fetchDeps" 并设为 true,确保子应用依赖被索引。
三、启用断点调试(mix test 场景)
elixirLS 内置调试适配器,可直接在测试文件中设置断点并以 mix test 方式启动调试会话,无需额外插件。
1、在 test 文件中任意可执行行左侧点击,添加红色断点标记。
2、按下 Ctrl+Shift+D(或 Cmd+Shift+D)打开调试面板,点击齿轮图标生成 .vscode/launch.json。
3、选择 Elixir Test 模板,保存后 launch.json 中将包含 "request": "test" 配置项。
4、点击绿色三角形启动调试,控制台将输出 mix test --trace 日志并暂停于断点处。
四、手动触发代码分析与索引重建
当出现跳转失败、类型提示缺失或未识别新模块时,语言服务器缓存可能过期,需强制刷新项目索引。
1、按下 Ctrl+Shift+P(或 Cmd+Shift+P)打开命令面板。
2、输入并选择 ElixirLS: Restart Language Server。
3、等待右下角状态栏显示 ElixirLS is ready,此时所有模块路径与函数签名将重新解析。
五、配置格式化为 mix format
VSCode 默认使用内置格式器,需绑定至 Elixir 官方推荐的 mix format 工具以保持团队风格一致。
1、在 settings.json 中添加键值对:"elixir.formatTool": "mix"。
2、确保项目根目录存在 .formatter.exs 文件,否则 mix format 将拒绝运行。
3、保存文件时自动格式化需开启:"editor.formatOnSave": true。










