Sublime配置GraphQL查询开发环境_内置Schema内省与自动补全

夜萱吖_2822

夜萱吖_2822

2026-05-24

371人浏览

原创

sublime text 的 graphql 补全需 lsp-graphql + sdl 格式 schema.graphql(非 schema.json),且须正确配置 graphql.config.yml、编码与路径,否则仅语法高亮。

sublime配置graphql查询开发环境_内置schema内省与自动补全

Sublime Text 本身不提供 GraphQL Schema 内省能力,必须靠 LSP-graphql + 本地 schema.graphql 文件(非 schema.json)才能触发字段补全和类型校验。 光装插件、光有后缀、光写 gql 模板字符串,都不行——缺了内省数据源,补全就是摆设。

为什么 schema.json 在 Sublime 里基本没用

LSP-graphql 不读 introspection JSON 格式;它只认 SDL 文本(即 type Query { ... } 那种写法)。很多教程让你用 get-graphql-schema 导出 schema.json,这在 VSCode 里可能凑合,但在 Sublime 的 LSP 生态中会静默失效。

  • 必须把 introspection 结果转成 SDL:用 npx @graphql-codegen/cli@latest init 或 apollo schema:download(加 --format=SDL)生成 schema.graphql
  • schema.graphql 文件必须是 UTF-8 编码、无 BOM、不含 JS 风格注释(//),只允许 # 注释
  • 路径写错或文件不可读时,LSP-graphql 不报错,只是退化为纯语法高亮——你敲错字段名也不会标红

graphql.config.yml 的写法陷阱

这个文件必须放在你通过 Project → Add Folder to Project 加入的项目根目录下,不是随便哪个子文件夹。LSP-graphql 只认这个位置的配置。

Qclaw
Qclaw

一款AI开发辅助工具,主要用于腾讯电脑管家打造的桌面智能体AI助手,随时随地,微信一下,Qclaw帮你搞定一切,适合需要提升相关任务效率的用户。

下载
  • 正确写法(相对路径,以项目根为起点):
    projects:
      default:
        schema: ./src/schema.graphql
  • 错误写法:schema: src/schema.graphql(缺 ./,YAML 解析会忽略前导点)、schema: $HOME/project/schema.graphql(Sublime 不展开环境变量)
  • 如果 Schema 拆成多个文件,必须用数组:schema: ["./schema/types.graphql", "./schema/queries.graphql"]
  • Windows 用户别用反斜杠:.\schema\schema.graphql 是非法 YAML,一律用正斜杠

JS/TS 里 gql 模板字符串怎么启用补全

默认情况下,LSP-graphql 只监听 .graphql 和 .gql 后缀文件。要在 .ts 或 .js 里获得补全,必须显式声明上下文。

  • 在 graphql.config.yml 中加 includes 字段:
    projects:
      default:
        schema: ./src/schema.graphql
        includes:
          - "**/*.ts"
          - "**/*.js"
  • gql 必须是全局变量或已 import(如 import { gql } from '@apollo/client';),否则 LSP 无法识别该字符串属于 GraphQL 上下文
  • 模板字符串需独立成行、无拼接:const q = gql`query { user { id } }`; ✅;const q = gql`` + 'query { user { id } }'; ❌
  • 状态栏右下角必须显示 LSP-graphql,不是 GraphQL——后者只是语法高亮插件,不带语言服务器

补全卡住或不响应?先看日志和状态栏

Sublime 没有后台进程管理界面,LSP 启动失败时几乎不提示。唯一可靠线索在两个地方:

  • 状态栏左下角:出现 LSP-graphql: Ready 才算真正就位;若一直卡在 Starting...,大概率是 Node.js 版本低于 16.14,或 schema 路径指向了不存在的文件
  • 命令面板输入 LSP: Toggle Log Panel,查看是否有 Failed to start server 或 ENOENT 类错误
  • 改完 graphql.config.yml 或更新 schema.graphql 后,必须手动执行 LSP: Restart Servers,不会自动热重载

最常被忽略的一点:LSP-graphql 对语法结构极其敏感——光标必须落在 { 后面、且前面不能有未闭合的引号或括号,否则补全引擎直接放弃解析。这不是 bug,是设计使然。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

sublime

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3209

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2328

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1260

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1218

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1356

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2198

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3500

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

16015

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程