sublime如何一键格式化GraphQL查询语句?(API开发)

1次阅读

sublime text 默认不支持 graphql 格式化,需安装 graphql 插件与 jsprettier 并配置 parser 为 graphql,启用 inline formatting 才能正确缩进查询及内联模板字符串

sublime如何一键格式化GraphQL查询语句?(API开发)

GraphQL 查询没缩进?Sublime 默认不支持一键格式化

sublime text 原生根本不认识 graphql 语法,更不会解析查询结构做缩进或换行。你点 Ctrl+Shift+P 搜 “Format” 或 “Beautify”,出来的全是 json、JS、HTML 相关命令,graphql 查询块直接被当普通文本扔着——这是最常卡住人的起点。

真正能起作用的,是靠第三方插件把 GraphQL 当成一种“可解析的语言”来处理,而不是靠 Sublime 自带功能。

装什么插件?别选错:必须用 GraphQL + Prettier 组合

只装 GraphQL 插件(比如 GraphQL Syntax Highlighting)只能高亮,不能格式化;只装 Prettier 插件,默认也不认 .graphql 或内联查询字符串。得两者配合,并手动配好关联规则。

  • 装插件:Package Control → Install Package → GraphQL(作者:PrismJSGraphQL Language Support),再装 Prettier(推荐 JsPrettier,它自带对 GraphQL 的支持开关)
  • 关键配置:打开 JsPrettier 设置(Preferences → Package Settings → JsPrettier → Settings),加这一段:
{   "auto_format_on_save": true,   "custom_file_extensions": [     "js", "jsx", "ts", "tsx", "graphql", "gql"   ],   "prettier_cli_path": "/usr/local/bin/prettier", // 确保本地有 prettier CLI   "additional_cli_args": {     "--parser": "graphql"   } }

注意:--parser graphql 这个参数漏掉,Prettier 就会按 JS 解析你的查询,结果可能全乱套。

内联查询(比如 JS 文件里的模板字符串)怎么格式化?

API 开发里大量出现类似 const query = gql`{ user { id name } }` 这种写法,Sublime 默认根本识别不出这是 GraphQL。需要额外告诉 JsPrettier:在 JS/TS 文件里遇到 gqlgraphql 标签的模板字符串,就调用 GraphQL 解析器。

  • JsPrettierSettings – User 里补上:
"allow_inline_formatting": true, "inline_script_js_preprocess": true, "additional_cli_args": {   "--parser": "graphql",   "--prose-wrap": "always" }
  • 确保你的 JS 文件里用了标准标签名,比如 gql(来自 @apollo/client)或 graphql(来自 graphql-tag)。自定义标签名要改 JsPrettierinline_script_js_tag_name 配置项
  • 格式化快捷键还是 Ctrl+Alt+Fwindows/linux)或 Cmd+Alt+Fmacos),光标必须落在模板字符串内部才生效

为什么有时格式化后字段顺序变了?不是 bug,是 Prettier 的默认行为

prettiergraphql 解析器默认会对字段做字母排序(尤其在 fragment 或 input Object 中),这不是错误,但容易让开发者误以为“格式化错了”。比如 { name age id } 可能变成 { age id name }

  • 如果你依赖字段顺序(比如调试时对照 schema 文档),就别开自动排序;目前 prettier 没提供关闭选项,只能接受或换工具(比如用 eslint-plugin-graphql 配合自定义规则)
  • 另一个坑:schema 文件(.graphqls)和 query 文件(.graphql)在插件里可能被当不同类型处理,建议统一用 .graphql 后缀,避免解析器切换出错
  • 还有个小陷阱:prettier CLI 版本太低(–parser graphql,会报错 Unknown option: '--parser',必须升级到 prettier@^2.8.0+

GraphQL 查询看着简单,但格式化这事卡在语言识别、插件链路、CLI 版本、标签命名四个层面上,少对一环就白配。

text=ZqhQzanResources