vscode使用JSON schema的三种方式

文章介绍了如何在VSCode中利用JSONschema进行配置,以帮助在编写JSON文件时进行结构提示和验证。可以通过设置`json.schemas`来配置映射关系,或者在JSON数据中直接引用$schema字段,还可以通过插件的`jsonValidation`扩展点进行配置。这些方法能有效提高编码效率并确保JSON文件的准确性。
摘要由CSDN通过智能技术生成

前言:JSON schema的作用,主要是针对json的书写的时候,我们能够根据提供的schma的提示(包括key和value),快速的书写出一个符合要求的json

一、通过用户设置(Settings)中的json.schemas选项来配置映射关系

json.schemas的书写其中也包括两种方式

1.通过设置url的方式,把映射关系放在文件中

"json.schemas": [
  {
    "fileMatch": [
      "/.babelrc"
    ],
    "url": "http://json.schemastore.org/babelrc"
  }
]

其中fileMatch是匹配的文件格式,./a.json表示当前目录下的a.json文件,/.a.json表示所有符合要求的a.json文件

2.直接把映射关系,写到settings.json中

"json.schemas": [
    {
        "fileMatch": [
            "/.myconfig"
        ],
        "schema": {
            "type": "object",
            "properties": {
                "name" : {
                    "type": "string",
                    "description": "The name of the entry"
                }
            }
        }
    }
]

关于schema的书写,可以参考下面的地址:

JSON Schema Reference — Understanding JSON Schema 2020-12 documentation

二、在 JSON 数据中增加一个$schema字段,指向 JSON Schema

{
  "$schema": "https://json.schemastore.org/coffeelint",
  "line_endings": "unix"
}

在当前正在书写的a.json中,引入我们包含映射关系的文件(这个路径,是相对于a.json的路径)

三、通过jsonValidation扩展点配置映射关系

{
  "contributes": {
    "jsonValidation": [
      {
        "fileMatch": ".jshintrc",
        "url": "https://json.schemastore.org/jshintrc"
      }
    ]
  }
}

把上面的内容,配置在 vscode插件(任何vscode的插件,自己开发并且安装的也可以)的package.json中,url的路径设置,是相对于当前package.json的路径

  • 6
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值