plugins.schemastore.json.settings

Options supplied to the require('schemastore').json.schemas function.

Type: attribute set of anything

Default: { }

Example:

{
  extra = [
    {
      description = "My custom JSON schema";
      fileMatch = "foo.json";
      name = "foo.json";
      url = "https://example.com/schema/foo.json";
    }
    {
      description = "My other custom JSON schema";
      fileMatch = [
        "bar.json"
        ".baar.json"
      ];
      name = "bar.json";
      url = "https://example.com/schema/bar.json";
    }
  ];
  replace = {
    "package.json" = {
      description = "package.json overridden";
      fileMatch = [
        "package.json"
      ];
      name = "package.json";
      url = "https://example.com/package.json";
    };
  };
}

Declared by:

plugins.schemastore.json.settings.extra

Additional schemas to include.

Plugin default: [ ]

Type: null or (list of ((attribute set of anything) or raw lua code))

Default: null

Declared by:

plugins.schemastore.json.settings.ignore

A list of strings representing the names of schemas to ignore. select and ignore are mutually exclusive.

See the schema catalog.

Plugin default: [ ]

Type: null or (list of (string or raw lua code))

Default: null

Declared by:

plugins.schemastore.json.settings.replace

An attrs of elements representing schemas to replace with a custom schema.

The string key is the name of the schema to replace, the table value is the schema definition. If a schema with the given name isn’t found, the custom schema will not be returned.

Plugin default: { }

Type: null or (attribute set of ((attribute set of anything) or raw lua code))

Default: null

Declared by:

plugins.schemastore.json.settings.select

A list of strings representing the names of schemas to select. If this option is not present, all schemas are returned. If it is present, only the selected schemas are returned. select and ignore are mutually exclusive.

See the schema catalog.

Plugin default: [ ]

Type: null or (list of (string or raw lua code))

Default: null

Declared by: