schemastore 0.0.2

Fetch and match files against the SchemaStore catalog
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

# schemastore

Parse and match files against the [SchemaStore](https://www.schemastore.org/) catalog.

SchemaStore is a community-maintained collection of JSON Schema definitions for common configuration files. This crate deserializes the catalog and matches file paths to their corresponding schemas using the `fileMatch` glob patterns.

## Usage

```rust
use schemastore::{parse_catalog, CompiledCatalog, CATALOG_URL};

// Fetch the catalog JSON yourself (using ureq, reqwest, etc.)
let json: String = ureq::get(CATALOG_URL).call()?.body_mut().read_to_string()?;
let value: serde_json::Value = serde_json::from_str(&json)?;

let catalog = parse_catalog(value)?;
let compiled = CompiledCatalog::compile(&catalog);

compiled.find_schema("tsconfig.json", "tsconfig.json");
// => Some("https://json.schemastore.org/tsconfig.json")

compiled.find_schema(".github/workflows/ci.yml", "ci.yml");
// => Some("https://www.schemastore.org/github-workflow.json")
```

## API

- `CATALOG_URL` — the well-known URL for the SchemaStore catalog JSON
- `Catalog` / `SchemaEntry` — serde types for the catalog
- `parse_catalog(Value)` — deserialize the catalog from a `serde_json::Value`
- `CompiledCatalog::compile(&Catalog)` — pre-compile all `fileMatch` globs
- `CompiledCatalog::find_schema(path, file_name)` — look up the schema URL for a file path

Bare filename patterns (e.g. `tsconfig.json`) are automatically expanded to also match nested paths (`**/tsconfig.json`). Negation patterns (starting with `!`) are skipped.

## Design

This crate is `#![no_std]` — it only depends on `alloc`, `serde`, `serde_json`, and `glob-match`. No HTTP client is included; callers fetch the catalog JSON themselves.