首先安装 YAML 插件，再创建 JSON Schema 并通过 settings.json 或内联注释关联，使 VSCode 实现自动补全、错误提示与类型校验，提升 YAML 编写准确性与团队协作效率。
在使用 VSCode 编辑 YAML 文件时，启用自定义模式与校验能显著提升编写准确性和效率。通过集成 JSON Schema，VSCode 可以对 YAML 文件提供自动补全、语法高亮和错误提示。以下是配置自定义 YAML 校验的实用方法。
1. 安装 YAML 插件
确保已安装官方 YAML Language Support by Red Hat 插件，它支持基于 JSON Schema 的验证和智能提示。
- 打开 VSCode 扩展面板（Ctrl+Shift+X）
- 搜索 "YAML" 并安装由 Red Hat 提供的插件
- 该插件默认启用语言服务器，支持 schema 关联
2. 创建或获取 JSON Schema
为你的 YAML 结构定义一个 JSON Schema，用于描述合法字段、类型和约束。
例如，假设你有一个配置文件 config.yaml，其结构如下：
name: app1version: 1.0
services:
- name: api
port: 8080
对应的 schema 文件 config-schema.json 可以是：
{"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"name": { "type": "string" },
"version": { "type": "string" },
"services": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": { "type": "string" },
"port": { "type": "integer" }
}
}
}
},
"required": ["name", "version"]
}
3. 在 VSCode 中关联 Schema
告诉 VSCode 哪些 YAML 文件应使用哪个 schema 进行校验。可通过以下任一方式实现。
方式一：通过 settings.json 配置
- 打开 VSCode 设置（Ctrl+,），点击右上角“打开设置 (JSON)”图标
- 添加 yaml.schemas 配置项
"file:///path/to/config-schema.json": ["/config.yaml", "/project/*.yaml"]
}
注意路径使用 file:// 协议，匹配模式支持 glob 表达式。
方式二：在 YAML 文件中内联注释
直接在 YAML 文件顶部添加注释指定 schema：
# yaml-language-server: $schema=file:///path/to/config-schema.jsonname: myapp
version: "1.0"
这种方式更灵活，适合团队共享且无需修改全局设置。
4. 验证效果
完成配置后，打开匹配的 YAML 文件：
- 输入错误字段名时会显示红色波浪线
- 输入正确字段前缀时出现自动补全建议
- 缺少必填字段会被标记警告
- 类型错误（如 port 写成字符串）也会被检测
如果未生效，检查：
- 插件是否启用
- schema 路径是否正确（建议用绝对路径测试）
- YAML 文件是否符合 schema 定义结构
基本上就这些。配置一次后，多人协作时可将 schema 和 settings.json 纳入项目仓库，统一开发体验。
