Provide JSON Schema for a JSON file like settings JSON in Visual Studio Code

Question

When editing settings JSON file, Visual Studio Code suggests property names. I am assuming it's using a JSON Schema internally.

It's a very nice feature and can be useful for editing other JSON files that have a JSON Schema. I can't find an option for adding schema to a JSON file. If it's an internal feature, where it is located in the source code and can we build an extension that surfaces the feature so we can provide JSON Schema for editing a JSON? Using $schema property doesn't seem to be working.

Mohsen · Accepted Answer · 2015-12-10 21:05:19Z

3

I found out it's possible to provide those JSON Schemas. In settings.json there are a couple of examples for Bower and package.json

They are under "json.schemas".

answered Dec 10, 2015 at 21:05

Mohsen

66.1k37 gold badges164 silver badges187 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

DudeOfAwesome · Accepted Answer · 2023-09-27 23:30:32Z

3

If you're trying to set the schema for a JSON file that should be using VSCode's settings schema, you can find your editor's current schema at vscode://schemas/settings/user.

To set that as the active schema for a JSON file, you could add this to the file:

"$schema": "vscode://schemas/settings/user",

answered Sep 27, 2023 at 23:30

DudeOfAwesome

1288 bronze badges

Comments

Denis Molodtsov · Accepted Answer · 2017-10-09 14:40:50Z

1

We can also do it this way:

In your .json file, just after the first opening curly bracket, add $schema property that is the path to the schema file:

{
    "$schema": "../node_modules/sp-build-tasks/schema/v1/sppp.json",
     startTypinghere...
}

More info

answered Oct 9, 2017 at 14:40

Denis Molodtsov

82413 silver badges29 bronze badges

Comments

Philzen · Accepted Answer · 2023-10-08 17:22:06Z

There are three ways to enable IntelliSense (and effectively, proper validation) for your JSON files:

$schema property in the file itself.

Using $schema property in your JSON does work in recent VS Code, however the culprit here is that you'll need to have $schema as an allowed property in the very same schema you're referencing, otherwise it won't be valid.

Although this might feel like a little self-recursive bloat, it has the advantage that any users of that JSON will get a reference to the schema no matter what editor they are using.

Reference: https://code.visualstudio.com/Docs/languages/json#_mapping-in-the-json
Referencing schema in settings.json:
```
"json.schemas": [
  {
    "fileMatch": [
      "/*.foo.json"
    ],
    "url": "./myschema.json"
  }
]
```
Reference: https://code.visualstudio.com/Docs/languages/json#_mapping-to-a-schema-in-the-workspace

Putting the schema directly into `settings.json`:

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

https://code.visualstudio.com/Docs/languages/json#_mapping-to-a-schema-in-the-workspace

Collectives™ on Stack Overflow

Provide JSON Schema for a JSON file like settings JSON in Visual Studio Code

4 Answers 4

Comments

Comments

Comments

`$schema` property in the file itself.

Referencing schema in `settings.json`:

Putting the schema directly into `settings.json`:

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

Comments

Comments

Comments

$schema property in the file itself.

Referencing schema in settings.json:

Putting the schema directly into settings.json:

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related

`$schema` property in the file itself.

Referencing schema in `settings.json`:

Putting the schema directly into `settings.json`: