Schema Catalog

Schema catalog index mapping file patterns to JSON Schema URLs.

Type object
File match catalog.json **/catalog.json
Schema URL https://catalog.lintel.tools/schemas/lintel/catalog/latest.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Schema catalog index that maps file patterns to JSON Schema URLs.

A catalog is a collection of schema entries used by editors and tools to automatically associate files with the correct schema for validation and completion. Follows the SchemaStore catalog format.

See: https://json.schemastore.org/schema-catalog.json

Properties

schemas SchemaEntry[] required

The list of schema entries in this catalog.

$schema string | null

The $schema URL for this catalog. Defaults to the Lintel catalog schema.

Default: null
version integer

The catalog format version.

Default: 1
format=uint32min=0
title string | null

An optional human-readable title for the catalog.

Default: null
groups CatalogGroup[]

Optional grouping of related schemas for catalog consumers that support richer organization. Consumers that don't understand groups simply ignore this field.

Default:
[]

Definitions

SchemaEntry object

A single schema entry in the catalog.

Each entry maps a schema to its URL and the file patterns it applies to.

name string required

The display name of the schema.

Examples: "My Config"
url string required

The URL where the schema can be fetched.

Examples: "https://example.com/schemas/my-config.json"
description string

A short description of what the schema validates.

Default: ""
sourceUrl string | null

An optional URL pointing to the upstream or canonical source of the schema (e.g. a GitHub raw URL).

fileMatch string[]

Glob patterns for files this schema should be applied to.

Editors and tools use these patterns to automatically associate matching files with this schema.

Examples: ["*.config.json","**/.config.json"]
versions Record<string, string>

Alternate versions of this schema, keyed by version identifier. Values are URLs to the versioned schema.

CatalogGroup object

A group of related schemas in the catalog.

Groups provide richer metadata for catalog consumers that support them. Consumers that don't understand groups simply ignore the field.

name string required

The display name for this group.

description string required

A short description of the schemas in this group.

schemas string[] required

Schema names that belong to this group.