信息发布→ 登录 注册 退出

VSCode for Elixir:Phoenix框架开发环境配置

发布时间:2026-01-08

点击量:
需安装ElixirLS和Phoenix Snippets扩展,配置elixirLS路径与文件关联,设置launch.json调试器,并启用mix format自动格式化。

如果您希望在 Visual Studio Code 中高效开发 Phoenix 框架应用,但缺少必要的语言支持、调试能力或项目集成,则可能是由于 Elixir 和 Phoenix 相关扩展未正确安装或配置。以下是完成 VSCode for Elixir:Phoenix 框架开发环境配置的具体步骤:

本文运行环境:MacBook Pro,macOS Sequoia。

一、安装核心扩展

VSCode 本身不原生支持 Elixir 语法高亮、代码补全与跳转,需通过官方维护的扩展实现语言服务器协议(LSP)集成,确保编辑器能理解 .ex 和 .eex 文件结构并提供智能提示。

1、打开 VSCode,点击左侧活动栏的扩展图标(或按 Cmd+Shift+X)。

2、在搜索框中输入 ElixirLS,选择由 Jake Beale 发布的官方扩展(名称为 “ElixirLS: Elixir support and debugger”)。

3、点击“安装”,安装完成后重启 VSCode。

4、再次打开扩展面板,搜索 Phoenix Framework Snippets,安装由 Andrew C. Pong 提供的代码片段扩展,用于快速插入常用 Phoenix 模板、路由和控制器结构。

二、配置 ElixirLS 启动参数

ElixirLS 需要明确指向当前项目的 Mix 工程路径及 Erlang/OTP 安装位置,否则无法启动语言服务器,导致所有功能失效。手动配置可避免自动探测失败引发的空白提示或报错。

1、按下 Cmd+, 打开设置界面,切换至“工作区”选项卡。

2、点击右上角“打开设置(JSON)”图标,编辑 settings.json 文件。

3、添加以下键值对:

"elixirLS.projectDir": "./",

"elixirLS.erlangPath": "/opt/homebrew/bin/erl",

"elixirLS.mixEnv": "dev",

"elixirLS.fetchDeps": true

4、保存文件,重新加载窗口(Cmd+Shift+P → “Developer: Reload Window”)。

三、启用 Phoenix 特定文件关联

VSCode 默认将 .eex、.leex 和 .html.eex 文件识别为纯 HTML,导致无法触发 Elixir 语法解析与嵌入式表达式高亮。需强制指定文件类型映射,使编辑器将其交由 ElixirLS 处理。

1、打开命令面板(Cmd+Shift+P),输入并选择 “Preferences: Configure File Association”。

2、在弹出的输入框中键入 *.eex,回车后选择 elixir

3、重复操作,为 *.leex*.html.eex 分别绑定至 elixir 文件类型。

4、关闭并重新打开任意一个 .eex 文件,确认左下角状态栏显示 “Elixir” 而非 “HTML”。

四、配置调试启动器

Phoenix 应用默认以 mix phx.server 启动,但 VSCode 的调试器需通过 launch.json 显式声明运行命令、环境变量与端口监听策略,才能实现断点命中与变量检查。

1、在项目根目录下创建 .vscode/launch.json(若不存在该路径则手动新建)。

2、写入以下 JSON 内容:

{

"version": "0.2.0",

"configurations": [

{

"type": "mix_task",

"name": "mix phx.server",

"request": "launch",

"task": "phx.server",

"projectPath": "${workspaceFolder}",

"env": {

"MIX_ENV": "dev"

}

}

]

}

3、保存后,点击左侧调试图标,选择“mix phx.server”配置,点击绿色 ▶ 按钮启动调试会话。

五、设置格式化与保存行为

Phoenix 社区广泛采用 standard Elixir 格式规范(即使用 mix format),需确保 VSCode 在保存时自动执行格式化,并禁用冲突的第三方格式化器,防止代码被错误重排。

1、打开设置(Cmd+,),搜索 format on save,勾选 “Editor: Format On Save”。

2、搜索 default formatter,找到 “Editor: Default Formatter”,点击下拉菜单,选择 ElixirLS

3、搜索 elixir format,确保 “ElixirLS: Format On Save” 已启用,同时关闭 “ElixirLS: Format On Type” 避免输入过程中频繁触发。

4、在项目根目录的 .formatter.exs 文件中确认已包含 import_deps: [:phoenix] 行,以支持 Phoenix 特有宏的格式化规则。

标签:# format  # 报错  # 跳转  # 按下  # 将其  # 如果您  # 运行环境  # 调试器  # 启动器  # 文件关联  # 编辑器  # visual studio code  # visual studio  # default  # vscode  # for  # erlang  # 开发环境  # win  # 环境变量  # macos  # 路由  # mac  # macbook  # 端口  # json  # js  # html  
在线客服
服务热线

服务热线

4008888355

微信咨询
二维码
返回顶部
×二维码

截屏,微信识别二维码

打开微信

微信号已复制,请打开微信添加咨询详情!