sublime怎么配置graphql-schema校验_sublime安装LSP-graphql【技巧】

sublime Text 需通过 lsp + LSP-graphql 插件实现 GraphQL Schema 校验，关键在于正确安装依赖、配置 graphql.config.yml 中的 schemaPath（推荐本地 .graphql 文件）、启用 LSP-graphql 服务、声明 js/TS 模板字符串支持，并在配置变更或 schema 更新后手动重启 LSP 服务器。

sublime text 本身不带 GraphQL Schema 校验能力，必须通过 LSP + LSP-graphql 插件组合实现——但直接装插件不等于能用，关键在 graphql.config.yml 或 .graphqlrc 的路径配置是否被 LSP 正确读取。

确认 LSP-graphql 已正确安装并启用

LSP-graphql 不是独立运行的插件，它依赖 LSP（Language Server Protocol）主框架。如果只装了 LSP-graphql 而没装 LSP，补全和校验会完全静默失效。

• 先通过 Ctrl+Shift+P → 输入 Install Package，依次安装：LSP，再安装 LSP-graphql
• 安装后重启 Sublime，打开命令面板输入 LSP: Enable Language Server Globally，勾选 graphql
• 检查状态栏右下角：打开 .graphql 文件时，应显示 LSP-graphql（而非仅 GraphQL）

schemaPath 必须写对，且文件可读

LSP-graphql 不会自动猜 schema 位置，graphql.config.yml 中的 schema 字段若路径错误、格式非法或文件权限受限，就会静默降级为无校验模式——你敲错字段名也不会报红，只会“没提示”。

• 推荐使用本地 .graphql 文件方式（比远程 endpoint 更稳定）：

  schema: ./src/schema.graphql

• 路径是相对于项目根目录（即你通过 Project → Add Folder to Project 加入的那个文件夹），不是相对于配置文件本身
• 确保 schema.graphql 文件存在、UTF-8 编码、无 bom，且内容是合法 SDL（比如不能有 JS 注释 //，只能用 #）
• 如果用远程地址（如 schema: https://api.example.com/graphql），需确保服务已启动、CORS 允许、且 Sublime 能联网（部分企业代理会拦截）

gql 模板字符串内补全要额外激活

在 .js 或 .ts 文件里写 gql`query { ... }`，默认不会触发 GraphQL 补全——LSP-graphql 默认只监听 .graphql 和 .gql 后缀文件。

• 需在项目根目录的 graphql.config.yml 中显式声明模板支持：

  projects:   myapp:     schema: ./src/schema.graphql     includes:       - "**/*.js"       - "**/*.ts"     excludes:       - "node_modules/**/*"

• 同时确保文件中 gql 是全局变量或已 import，否则 LSP 无法识别该字符串上下文
• 若仍无效，可临时在 JS 文件顶部加注释提示：

  /* GraphQL */

  ，强制 LSP 将当前文件块当作 GraphQL 处理

最容易被忽略的是：LSP 配置变更后不会热重载，改完 graphql.config.yml 必须手动执行 LSP: Restart Servers，否则旧缓存 schema 一直生效。另外，schema.graphql 更新后也得手动重启服务器，不然补全还是旧字段。