VSCode如何配置YAML和JSON校验_VSCode YAML与JSON校验配置方案

小强小哥_3638

小强小哥_3638

2026-04-17

605人浏览

原创

装对插件并配置yaml.schemas或json.schemas后,yaml/json才具备字段级校验能力;须安装redhat.vscode-yaml、禁用冲突插件、设对语言模式、用相对路径绑定本地或远程schema。

vscode如何配置yaml和json校验_vscode yaml与json校验配置方案

装对插件、配好 Schema,YAML 和 JSON 才算真正“可校验”。只装 redhat.vscode-yaml 或依赖 VSCode 内置 JSON 支持,90% 的字段级错误(比如 Kubernetes 中写错 imagePullPolicy: Always 拼成 Alaways)根本不会报。

必须安装 redhat.vscode-yaml,禁用所有冲突插件

VSCode 1.86+ 虽内置基础 YAML 支持,但会与非 Red Hat 插件(如 YAML Tools、Auto Close Tag)抢语言服务器,导致补全失效、悬停无响应、甚至 yaml-language-server 连接拒绝。

  • 在扩展市场搜索 Red Hat YAML,认准发布者为 Red Hat、ID 为 redhat.vscode-yaml
  • 安装后执行 Cmd+Shift+P → 输入 Developer: Reload Window 重载窗口
  • 打开扩展视图,禁用所有名称含 YAML Tools、YAML Validation、Auto Close Tag 的插件
  • 右下角状态栏确认当前文件语言模式是 YAML(不是 Plain Text),否则点击切换

yaml.schemas 必须手动配置,否则只是“语法高亮”

没配 yaml.schemas,插件只会检查缩进、冒号、引号等基础语法;Kubernetes 字段名、Ansible 模块参数、GitHub Actions 的 on.push.branches 是否合法——全都不会校验。

Wjs Localizing Video
Wjs Localizing Video

用于端到端视频本地化流程的轻量编排器,路由至四个专注子技能——/wjs-transcribing-audio、/wjs-translating-subtitles...

下载
  • 在项目根目录创建 .vscode/settings.json(工作区级配置,避免污染全局)
  • 添加如下片段(以 GitHub Actions 为例):
    "yaml.schemas": {
      "https://json.schemastore.org/github-workflow.json": "/.github/workflows/*.yml"
    }
  • 路径匹配基于工作区根目录,* 表示单层通配,** 表示递归;不要写绝对路径或正则
  • 确保远程 Schema 地址返回 HTTP 200(若网络受限,改用本地 Schema 文件,见下一条)

JSON 校验依赖 language mode + json.schemas,注释是关键陷阱

VSCode 对 JSON 的校验行为高度依赖右下角显示的语言模式:JSON 模式严格拒绝注释;JSONC 模式允许注释但会跳过部分语义检查——很多团队误以为“能格式化=已校验”,结果上线后因注释未被清除而解析失败。

  • 打开文件后先看右下角:若显示 Plain Text 或 JSONC,点击它 → 选择 Configure File Association for '.xxx' → 设为 JSON
  • 在 .vscode/settings.json 中配置 Schema 绑定:
    "json.schemas": [
      {
        "fileMatch": ["package.json"],
        "url": "https://json.schemastore.org/package.json"
      }
    ]
  • 如果文件含 // 或 /* */ 注释,且你希望保留它们,必须用 JSONC 模式;但此时 eslint 或 CI 中的 jq 校验仍会失败——注释不是 JSON 标准的一部分

本地 Schema 是离线/定制场景的唯一可靠方案

远程 Schema 加载失败(超时、404、公司代理拦截)时,yaml-language-server 会静默降级,编辑器表现和没配 Schema 一样。这时候必须切到本地文件路径,且路径必须相对于工作区根目录。

  • 生成本地 Kubernetes Schema 示例:
    kubectl get --raw "/openapi/v2" | jq '.definitions' > .vscode/schema/kubernetes-schema.json
  • 在 .vscode/settings.json 中绑定:
    "yaml.schemas": {
      "./.vscode/schema/kubernetes-schema.json": "**/k8s/*.yaml"
    }
  • 注意 ./ 开头表示相对路径;如果路径写成 .vscode/schema/...(缺 ./),插件会当成 URL 去请求,必然 404
  • 自定义 Schema 文件建议用 .schema.json 后缀,并提交到 Git,确保团队成员获得一致校验逻辑

Schema 绑定不是“配一次就完事”的设置——它依赖路径匹配精度、网络可达性、语言模式识别准确性三者同时成立。一个 **/deploy/*.yml 匹配不到 helm/templates/deployment.yaml,往往是因为 glob 没覆盖子目录层级,而不是插件坏了。

相关文章

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

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

下载

相关标签:

vscode js json

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

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1295

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

2712

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1929

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1727

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

2587

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1818

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1242

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1116

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

474

5

热门下载

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

精品课程

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