VSCode的GraphQL插件:语法高亮与查询支持

19次阅读

需安装Prisma官方graphql插件并配置文件关联、启用GraphQL Language Server及Apollo插件;步骤包括安装扩展、设置文件关联、配置graphql.config.yml、添加Apollo支持。

VSCode的GraphQL插件:语法高亮与查询支持

如果您在vscode中编写GraphQL代码时发现没有语法高亮、自动补全或查询验证功能,则可能是由于缺少对应的语言支持或插件配置未生效。以下是启用GraphQL语法高亮与查询支持的具体操作步骤:

本文运行环境:macBook air,macOS Sequoia。

一、安装GraphQL官方插件

VSCode本身不内置GraphQL语言支持,需通过扩展市场安装由Prisma官方维护的GraphQL插件,该插件提供语法高亮、片段补全、错误提示等基础能力。

1、打开VSCode,点击左侧活动栏的扩展图标(方块拼图形状)。

2、在扩展搜索框中输入GraphQL,找到作者为Prisma的插件,名称显示为GraphQL for VSCode

3、点击“安装”按钮,等待安装完成并重启VSCode窗口(可使用Cmd+Shift+P调出命令面板,执行Reload window)。

二、配置文件关联规则

插件默认仅对.graphql和.gql后缀文件启用语法高亮,若项目中使用其他扩展名(如.js、.ts内嵌GraphQL模板字符串),需手动指定语言模式或配置文件关联。

1、打开任意一个含GraphQL内容的文件(例如schema.graphql)。

2、点击VSCode右下角显示的语言模式(如Plain Text),在弹出菜单中选择GraphQL

3、若需永久关联某类文件,按下Cmd+Shift+P,输入Settings jsON,打开settings.json,在其中添加如下配置:

4、在”files.associations”字段内插入键值对“*.gql”: “graphql”“*.graphql”: “graphql”

三、启用GraphQL Language Server支持

仅安装插件不足以实现查询验证与Schema感知,需配合GraphQL Language Server,它能解析本地Schema文件并提供字段提示、类型检查等功能。

1、确保项目根目录下存在schema.graphqlschema.json文件,或已配置指向远程Schema的endpoint。

2、在项目根目录创建graphql.config.yml文件,内容包含schema路径与documents路径声明。

3、在配置中设置schema字段为本地文件路径,例如:schema: ./schema.graphql

4、保存后,VSCode底部状态栏应出现GraphQL标识,且悬停字段时显示类型信息。

四、集成Apollo Client开发工具

若项目使用Apollo Client,可通过Apollo GraphQL插件获得更深入的查询支持,包括运行时查询预览、变量调试及Operation自动提取。

1、在扩展市场中搜索并安装Apollo GraphQL插件(作者为Apollo GraphQL)。

2、在项目中确认存在apollo.config.js或apollo.config.ts,并已定义client对象与service引用。

3、在GraphQL文件中书写query时,按Cmd+Shift+P调出命令面板,执行Apollo: Run Query,验证是否触发本地模拟响应。

4、在JS/TS文件中使用gql模板字面量时,确保导入语句为import { gql } from ‘@apollo/client’;,以激活插件识别。

text=ZqhQzanResources