JSON

Enabling JSON5

PhpStorm recognizes a number of most popular JSON standards including JSON5. PhpStorm by default treats files with the json5 extension as JSON5 files and supports this new syntax in them.

Using schemas from JSON Schema Store

PhpStorm can automatically download and use schemas from the JSON Schema Store that hosts schema files for many popular configuration files. As soon as you open a file whose name is associated with one of the available schemas (for example, tslint.json), PhpStorm downloads and uses this schema for it. The name of the applied schema is shown on the Status bar.

If your configuration file has a custom name or you are working with a scratch file, click No JSON schema on the Status bar and select the required schema from the list or click New Schema Mapping to open the JSON Schema Mappings page and configure a new custom schema.

tip

Schemas from the JSON Schema Store can be applied to YAML files as well.

By default, automatic download of Schemas from the JSON Schema Store is enabled. If it was turned off, you can enable it again at any time.

PhpStorm comes bundled with a number of popular schemas. Although these schemas are automatically updated on a regular basis they still may happen to be outdated.

Using custom JSON schemas

Besides schemas from JSON Schema Store, PhpStorm lets you configure and use custom schemas from other storages. You can download the required schema and store it under the project root or specify the URL of the resource so PhpStorm can download the schema automatically.

tip

Custom schemas must meet the JSON schema standards.

Handling conflicts among scopes of schemas

A conflict arises when a file, or a folder, or a pattern belongs to the scopes of two or more schemas. PhpStorm analyzes scopes in two modes:

• Static Analysis detects conflicts in scopes of custom schemas. If a conflict is detected, PhpStorm displays a warning in the Schema Details pane. To view the overlapping scopes, click the Show details link. PhpStorm shows a popup with a message where the conflicting scopes and schemas are listed:

  

• Dynamic Analysis detects conflicts in scopes of both system and custom schemas. This type of analysis is started when you open a file that belongs to a certain scope. If a conflict is detected, PhpStorm displays a warning at the top of the editor tab:

  

  Click the link to open the JSON Schema Mappings page and edit the scope of the conflicting custom schema. Note that you cannot edit the scope of system schemas.

Using HTML descriptions in JSON schema

By default, PhpStorm escapes HTML characters when displaying documentation for JSON schema definitions in documentation popups. To get nice looking documentation with rich HTML markup, store the HTML description in the x-intellij-html-description extension property instead of description.

description

x-intellij-html-description

{
  "id":  "http://some.site.somewhere/entry-schema#",
  "$schema":  "http://json-schema-org/draft-06/schema#",
  "type":  "object",
  "required":  [ "options" ],
  "properties":  {
    "options":  {
      "type":  "array",
      "description": "Interesting details: Fresh New Awesome",
      "minItems":  1,
      "items":  { "type":  "string" },
      "uniqueItems":  true,
    },
    "readonly":  { "type":  "boolean" }
  }
}

{
  "id":  "http://some.site.somewhere/entry-schema#",
  "$schema":  "http://json-schema-org/draft-06/schema#",
  "type":  "object",
  "required":  [ "options" ],
  "properties":  {
    "options":  {
      "type":  "array",
      "x-intellij-html-description": "<p><b>Interesting</b> <i>details:</i></p>\n
                    <ul><li>Fresh</li><li>New</li><li>Awesome</li></ul>\n
                    <div style='background-color: #fff77c'>Choose schema with HTML description =)</div>",
      "minItems":  1,
      "items":  { "type":  "string" },
      "uniqueItems":  true,
    },
    "readonly":  { "type":  "boolean" }
  }
}

Configuring syntax highlighting

You can configure JSON-aware syntax highlighting according to your preferences and habits.