0

0

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

尼克

尼克

发布时间:2026-03-10 14:50:01

|

821人浏览过

|

来源于php中文网

原创

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 解析你的查询,结果可能全乱套。

Quinvio AI
Quinvio AI

AI辅助下快速创建视频,虚拟代言人

下载

内联查询(比如 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+F(Windows/Linux)或 Cmd+Alt+F(macOS),光标必须落在模板字符串内部才生效

为什么有时格式化后字段顺序变了?不是 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 版本、标签命名四个层面上,少对一环就白配。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
Python GraphQL API 开发实战
Python GraphQL API 开发实战

本专题系统讲解 Python 在 GraphQL API 开发中的实际应用,涵盖 GraphQL 基础概念、Schema 设计、Query 与 Mutation 实现、权限控制、分页与性能优化,以及与现有 REST 服务和数据库的整合方式。通过完整示例,帮助学习者掌握 使用 Python 构建高扩展性、前后端协作友好的 GraphQL 接口服务,适用于中大型应用与复杂数据查询场景。

23

2026.01.21

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

454

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

546

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

334

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

82

2025.09.10

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

887

2023.07.31

python中的format是什么意思
python中的format是什么意思

python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

459

2024.06.27

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

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

562

2023.09.20

Go高并发任务调度与Goroutine池化实践
Go高并发任务调度与Goroutine池化实践

本专题围绕 Go 语言在高并发任务处理场景中的实践展开,系统讲解 Goroutine 调度模型、Channel 通信机制以及并发控制策略。内容包括任务队列设计、Goroutine 池化管理、资源限制控制以及并发任务的性能优化方法。通过实际案例演示,帮助开发者构建稳定高效的 Go 并发任务处理系统,提高系统在高负载环境下的处理能力与稳定性。

4

2026.03.10

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Node.js 教程
Node.js 教程

共57课时 | 13.1万人学习

Rust 教程
Rust 教程

共28课时 | 6.8万人学习

Vue 教程
Vue 教程

共42课时 | 9.4万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号