JSON格式通常用于存储数据和配置文件。PyCharm 帮助您处理 JSON 文件——它检查它们的语法和格式。在流行的配置文件类型中,PyCharm 提供了代码完成,这要归功于JSON Schema,这是一种用于描述此类文件的结构和内容的特殊格式。您还可以使用自定义 JSON 模式在 JSON 文件中启用代码完成并对其进行验证。
PyCharm 识别包括JSON5在内的许多最流行的 JSON 标准。PyCharm 默认将带有json5扩展名的文件视为 JSON5 文件,并在其中支持这种新语法。
在Settings/Preferences对话框 ( Ctrl+Alt+S) 中,转到 。
在已识别的文件类型列表中,选择JSON5。
在“文件名模式”区域中,单击并
*.json
在打开的“添加通配符”对话框中键入。
PyCharm 可以自动从JSON Schema Store下载和使用模式,该存储为许多流行的配置文件托管模式文件。一旦您打开一个名称与可用模式之一相关联的文件(例如,tslint.json),PyCharm 就会下载并使用该模式。应用模式的名称显示在状态栏上。
如果您的配置文件具有自定义名称或您正在使用临时文件,请单击状态栏上的无 JSON 模式并从列表中选择所需的模式,或单击新模式映射以打开JSON 模式映射页面并配置新的自定义架构。
默认情况下,从 JSON Schema Store 自动下载 Schema 是启用的。如果它被关闭,您可以随时重新启用它。
在Settings/Preferences对话框 ( Ctrl+Alt+S) 中,转到 。
选中允许从远程源下载 JSON 模式和使用 schemastore.org JSON 模式目录复选框。
PyCharm 捆绑了许多流行的模式。尽管这些模式会定期自动更新,但它们仍然可能碰巧过时。
在Settings/Preferences对话框 ( Ctrl+Alt+S) 中,转到 。
选中始终下载最新版本的架构复选框。
除了来自 JSON Schema Store 的模式之外,PyCharm 还允许您配置和使用来自其他存储的自定义模式。您可以下载所需的架构并将其存储在项目根目录下,或者指定资源的 URL,以便 PyCharm 可以自动下载架构。
在Settings/Preferences对话框 ( Ctrl+Alt+S) 中,转到 。
在显示您之前配置的所有自定义模式的中央窗格中,单击工具栏上的 。
指定 Schema 的名称和Schema 符合的Schema Specification 版本。在架构文件或 URL字段中,指定先前下载的架构文件的位置或键入所需架构可用的 URL。
创建要针对此架构进行验证的文件或文件夹的列表。该列表可能包含特定文件的名称、整个目录的名称和文件名模式。根据该列表,PyCharm 在内部检测要验证的文件。
要将项目添加到列表中,请单击并指定文件或文件夹的路径或键入文件模式。
在Settings/Preferences对话框 ( Ctrl+Alt+S) 中,转到 。
选择允许从远程源下载 JSON 模式。
清除该复选框后,将禁用 JSON 模式周围的任何网络活动,包括来自 JSON 模式存储的模式。
当文件、文件夹或模式属于两个或多个模式的范围时,就会出现冲突。PyCharm 以两种模式分析作用域:
静态分析检测自定义模式范围内的冲突。如果检测到冲突,PyCharm 会在Schema Details窗格中显示警告。要查看重叠范围,请单击显示详细信息链接。PyCharm 显示一个弹出消息,其中列出了冲突的范围和模式:
动态分析检测系统和自定义模式范围内的冲突。当您打开属于某个范围的文件时,就会开始这种类型的分析。如果检测到冲突,PyCharm 会在编辑器选项卡顶部显示警告:
默认情况下,PyCharm 在文档弹出窗口中显示 JSON 模式定义的文档时会转义 HTML 字符。要获得具有丰富 HTML 标记的漂亮文档,请将 HTML 描述存储在x-intellij-html-description
扩展属性中,而不是description
.
您可以根据自己的喜好和习惯配置 JSON 感知语法突出显示。
在Settings/Preferences对话框 ( Ctrl+Alt+S) 中,转到 。
选择配色方案,接受从默认值继承的突出显示设置,或按照颜色和字体中的说明自定义它们。