jsonschema-lexer 0.1.0

A Pygments lexer for JSON Schema

Introduction

jsonschema-lexer is a Python package that provides a JSON Schema lexer for syntax highlighting JSON Schema documents based on the 2020-12 dialect. It utilizes Pygments, a syntax highlighting library, to tokenize JSON Schema documents according to the JSON Schema specification.

Usage

Once installed, you can use it in your Python code to highlight JSON Schema documents.

Here’s a simple example:

# Import the JSONSchemaLexer class from the package
from jsonschema_lexer.lexer import JSONSchemaLexer

from rich.console import Console
from rich.syntax import Syntax

console = Console()

code = """
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://example.com/product.schema.json",
  "title": "Product",
  "description": "A product from Acme's catalog",
  "type": "object",
  "properties": {
    "productId": {
      "description": "The unique identifier for a product",
      "type": "integer"
    },
    "productName": {
      "description": "Name of the product",
      "type": "string"
    }
  }
}
"""

syntax = Syntax(code, lexer=JSONSchemaLexer(), background_color="default", word_wrap=True)
console.print(syntax)