使用 Visual Studio Code 编辑 JSON
JSON 是一种数据格式,常用于配置文件,例如 package.json
或 project.json
。我们在 Visual Studio Code 中也广泛使用它来配置我们的配置文件。当打开一个以 .json
结尾的文件时,VS Code 提供了多种功能,可以简化编写或修改文件内容的过程。
IntelliSense 和验证
对于属性和值,无论是带有还是不带有模式的 JSON 数据,我们都会在您键入时通过 IntelliSense 提供建议。您也可以使用触发建议命令手动查看建议 (⌃Space (Windows、Linux Ctrl+Space))。
我们还会基于关联的 JSON 模式执行结构和值验证,并在出现问题时显示红色波浪线。要禁用验证,请使用 json.validate.enable 设置。
包和项目依赖项
我们还为特定值集提供 IntelliSense,例如 package.json
、project.json
和 bower.json
中的包和项目依赖项。
快速导航
JSON 文件可能会变得很大,我们支持使用转到符号命令快速导航到属性 (⇧⌘O (Windows、Linux Ctrl+Shift+O))。
悬停提示
当您悬停在带有或不带有模式的 JSON 数据的属性和值上时,我们将提供额外的上下文信息。
格式化
您可以使用 ⇧⌥F (Windows Shift+Alt+F, Linux Ctrl+Shift+I) 或从上下文菜单中选择格式化文档来格式化您的 JSON 文档。
折叠
您可以使用行号和行首之间装订线上的折叠图标来折叠源代码区域。折叠区域适用于所有对象和数组元素。
带有注释的 JSON
除了遵循 JSON 规范的默认 JSON 模式外,VS Code 还具有带有注释的 JSON (jsonc) 模式。此模式用于 VS Code 配置文件,例如 settings.json
、tasks.json
或 launch.json
。在带有注释的 JSON 模式下,您可以使用单行 (//
) 和块注释 (/* */
),就像在 JavaScript 中使用一样。该模式也接受尾随逗号,但不建议使用,编辑器会显示警告。
当前的编辑器模式在编辑器的状态栏中指示。选择模式指示器可以更改模式,并配置文件扩展名如何与模式关联。您也可以直接修改 files.associations 设置,以将文件名或文件名模式与 jsonc
关联。
JSON 模式和设置
为了理解 JSON 文件的结构,我们使用 JSON 模式。JSON 模式描述了 JSON 文件的形状,以及值集、默认值和描述。VS Code 附带的 JSON 支持支持从草案 4 到草案 7 的所有草案版本,并有限支持草案 2019-09 和 2020-12。
像 JSON Schema Store 这样的服务器为大多数常见的基于 JSON 的配置文件提供了模式。但是,模式也可以在 VS Code 工作区中的文件以及 VS Code 设置文件中定义。
JSON 文件与模式的关联可以在 JSON 文件本身中使用 $schema
属性完成,也可以在用户或工作区 设置 (文件 > 首选项 > 设置) 中的 json.schemas 属性下完成。
VS Code 扩展程序也可以定义模式和模式映射。这就是为什么 VS Code 已经知道一些著名的 JSON 文件(例如 package.json
、bower.json
和 tsconfig.json
)的模式。
在 JSON 中映射
在以下示例中,JSON 文件指定其内容遵循 CoffeeLint 模式。
{
"$schema": "https://json.schemastore.org/coffeelint",
"line_endings": "unix"
}
请注意,此语法是 VS Code 特有的,并非 JSON 模式规范 的一部分。添加 $schema
键会更改 JSON 本身,这可能是使用 JSON 的系统所不期望的,例如,模式验证可能会失败。如果是这种情况,您可以使用其他映射方法之一。
在用户设置中映射
以下用户设置的摘录显示了 .babelrc
文件如何映射到位于 https://json.schemastore.org/babelrc 的 babelrc 模式。
"json.schemas": [
{
"fileMatch": [
"/.babelrc"
],
"url": "https://json.schemastore.org/babelrc"
}
]
提示: 除了为
.babelrc
定义模式外,还要确保将.babelrc
与 JSON 语言模式关联。这也可以在设置中使用files.association
数组设置来完成。
在工作区中映射到模式
要映射位于工作区中的模式,请使用相对路径。在本例中,工作区根目录中名为 myschema.json
的文件将用作所有以 .foo.json
结尾的文件的模式。
"json.schemas": [
{
"fileMatch": [
"**/*.foo.json"
],
"url": "./myschema.json"
}
]
映射到在设置中定义的模式
要映射在用户或工作区设置中定义的模式,请使用 schema
属性。在本例中,定义了一个模式,该模式将用于所有名为 .myconfig
的文件。
"json.schemas": [
{
"fileMatch": [
"/.myconfig"
],
"schema": {
"type": "object",
"properties": {
"name" : {
"type": "string",
"description": "The name of the entry"
}
}
}
}
]
在扩展中映射模式
模式和模式关联也可以由扩展程序定义。查看 jsonValidation 贡献点。
文件匹配语法
文件匹配语法支持 '*' 通配符。此外,您可以定义排除模式,以 '!' 开头。为了使关联匹配,至少需要匹配一个模式,并且最后一个匹配模式不能是排除模式。
"json.schemas": [
{
"fileMatch": [
"/receipts/*.json",
"!/receipts/*.excluded.json"
],
"url": "./receipts.schema.json"
}
]
在 JSON 模式中定义代码片段
JSON 模式描述了 JSON 文件的形状,以及值集和默认值,JSON 语言支持使用这些值集和默认值来提供完成建议。如果您是模式作者并且想要提供更自定义的完成建议,您还可以在模式中指定代码片段。
以下示例显示了键盘快捷方式设置文件的模式,该模式定义了一个代码片段
{
"type": "array",
"title": "Keyboard shortcuts configuration",
"items": {
"type": "object",
"required": ["key"],
"defaultSnippets": [
{
"label": "New keyboard shortcut",
"description": "Binds a key to a command for a given state",
"body": { "key": "$1", "command": "$2", "when": "$3" }
}
],
"properties": {
"key": {
"type": "string"
}
...
}
}
}
这是一个 JSON 模式中的示例
使用 defaultSnippets
属性为给定的 JSON 对象指定任意数量的代码片段。
label
和description
将显示在完成选择对话框中。如果未提供标签,则代码片段的字符串化对象表示形式将改为显示为标签。body
是 JSON 对象,当用户选择完成时,该对象将被字符串化并插入。代码片段语法可以在字符串字面量中使用,以定义制表位、占位符和变量。如果字符串以^
开头,则字符串内容将按原样插入,而不是字符串化。您可以使用它来为数字和布尔值指定代码片段。
请注意,defaultSnippets
不是 JSON 模式规范的一部分,而是 VS Code 特有的模式扩展。
在悬停提示中使用富格式
VS Code 将使用 JSON 模式规范 中的标准 description
字段,以便在悬停和自动完成期间提供有关属性的信息。
如果您希望您的描述支持链接等格式,您可以通过在格式化中使用 Markdown 和 markdownDescription
属性来选择加入。
{
"$schema": "https://json-schema.fullstack.org.cn/draft-07/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the entry",
"markdownDescription": "The name of the entry. [See the documentation](https://example.com)"
}
}
}
请注意,markdownDescription
不是 JSON 模式规范的一部分,而是 VS Code 特有的模式扩展。
离线模式
json.schemaDownload.enable 控制 JSON 扩展是否从 http
和 https
获取 JSON 模式。
当当前编辑器想要使用无法下载的模式时,状态栏中将显示一个警告三角形。