LSP-json
Schema validation/completions for your JSON and Sublime files
Details
Installs
- Total 22K
- Win 7K
- Mac 8K
- Linux 7K
Jul 27 | Jul 26 | Jul 25 | Jul 24 | Jul 23 | Jul 22 | Jul 21 | Jul 20 | Jul 19 | Jul 18 | Jul 17 | Jul 16 | Jul 15 | Jul 14 | Jul 13 | Jul 12 | Jul 11 | Jul 10 | Jul 9 | Jul 8 | Jul 7 | Jul 6 | Jul 5 | Jul 4 | Jul 3 | Jul 2 | Jul 1 | Jun 30 | Jun 29 | Jun 28 | Jun 27 | Jun 26 | Jun 25 | Jun 24 | Jun 23 | Jun 22 | Jun 21 | Jun 20 | Jun 19 | Jun 18 | Jun 17 | Jun 16 | Jun 15 | Jun 14 | Jun 13 | Jun 12 | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Windows | 0 | 6 | 5 | 5 | 12 | 13 | 10 | 4 | 4 | 9 | 8 | 8 | 5 | 6 | 7 | 9 | 6 | 14 | 10 | 18 | 5 | 12 | 6 | 3 | 10 | 5 | 11 | 6 | 9 | 6 | 10 | 7 | 6 | 6 | 7 | 1 | 8 | 3 | 7 | 8 | 7 | 5 | 3 | 6 | 7 | 10 |
Mac | 0 | 6 | 5 | 3 | 13 | 9 | 5 | 2 | 8 | 6 | 7 | 7 | 4 | 2 | 3 | 13 | 9 | 6 | 7 | 5 | 4 | 4 | 11 | 4 | 7 | 8 | 5 | 4 | 2 | 5 | 8 | 8 | 13 | 9 | 5 | 12 | 8 | 5 | 7 | 3 | 5 | 5 | 6 | 7 | 10 | 5 |
Linux | 0 | 10 | 9 | 6 | 14 | 7 | 5 | 6 | 9 | 8 | 4 | 11 | 13 | 5 | 4 | 14 | 8 | 12 | 8 | 9 | 7 | 8 | 6 | 6 | 5 | 11 | 11 | 10 | 11 | 8 | 6 | 10 | 5 | 10 | 6 | 6 | 9 | 9 | 9 | 14 | 13 | 13 | 6 | 8 | 7 | 6 |
Readme
- Source
- raw.githubusercontent.com
LSP-json
JSON support for Sublime's LSP plugin.
Uses VSCode JSON Language Server to provide validation, formatting and other features for JSON files. See linked repository for more information.
Installation
- Install LSP and
LSP-json
from Package Control. - Restart Sublime.
Configuration
Open configuration file using command palette with Preferences: LSP-json Settings
command or opening it from the Sublime menu (Preferences > Package Settings > LSP > Servers > LSP-json
).
For users of PackageDev
The PackageDev package implements features that provide completions and tooltips when editing the Sublime settings files, which overlaps and conflicts with functionality provided by this package. To take advantage of the strict schemas that this package provides, disable corresponding functionality in PackageDev
by opening Preferences: PackageDev Settings
from the Command Palette and set the following settings on the right side:
{
"settings.auto_complete": false,
"settings.tooltip": false
}
Color Provider
The JSON-Language-Server implements a color provider that adds color decorators next to values representing colors in JSON files. If you are using a color plugin like ColorHelper or Color Highlight you may wish to disable this feature. To disable it open the LSP-json Settings as described above and add the following settings on the right side:
{
"disabled_capabilities": {
"colorProvider": true
}
}
Custom schemas
To load manually created schemas, add those to userSchemas
configuration in the settings file. See more information in the comments there.
The custom schema entry needs to look like:
{
"fileMatch": [
"/my-file.json"
],
"uri": "./my-file-schema.json",
}
The fileMatch
is an array of file patterns to match against when resolving JSON files to schemas. *
and **
can be used as a wildcard. Exclusion patterns can also be defined and start with !
. A file matches when there is at least one matching pattern and the last matching pattern is not an exclusion pattern.
The uri
is a URI or a file path to a schema. Can be a relative path (starting with ./
) when defined in a project settings and in that case will be resolved relative to the first project folder.
Schemas contributed by Packages
Sublime Text packages can provide schemas for its own settings, or contribute to global ST settings or other configuration files (for example *.sublime-project
files).
This is accomplished by including a sublime-package.json
file in the package (location doesn't matter) and defining schemas within it. Any changes made to the schemas are automatically applied to matching files so there is no need to restart the server or ST.
Here is a an example of three different schemas defined in one sublime-package.json
file:
{
"contributions": {
"settings": [
{
// Schema for MyPackage configuration.
"file_patterns": ["/MyPackage.sublime-settings"],
"schema": {
"properties": {
"my_cool_setting": {
"type": "string",
"default": "yes",
"enum": ["yes", "no"],
"markdownDescription": "Decides whether something is `on` or `off`."
}
},
"additionalProperties": false,
}
},
{
// Schema to extend global ST Preferences.
"file_patterns": ["/Preferences.sublime-settings"],
"schema": {
"properties": {
"my_cool_setting": {
// Reuses definition from the pattern-less schema defined below.
"$ref": "sublime://settings/foo/base#/definitions/ReuseMe"
}
},
}
},
{
// Pattern-less schema (note that "file_patterns" is missing).
// Can be added for the purpose of referencing it (or its definitions) from another schema.
// Pattern-less schema must define an "$id" to be able to refer to it from other schemas.
// It's recommended to assign URIs like "sublime://settings/foo/base" for "$id".
"schema": {
"$id": "sublime://settings/foo/base"
"definitions": {
"ReuseMe": {
"type": "string",
"default": "no",
"enum": ["yes", "no"],
"markdownDescription": "Decides whether something is `on` or `off`."
}
},
}
}
]
}
}