Merge pull request #1 from sudo-jarvis/main

Merge main into create-lexer

Author: sudo-jarvis

.github/workflows/ci.yml

@@ -2,12 +2,17 @@ name: CI
 
 on:
   push:
+    branches-ignore:
+      - "wip*"
+    tags:
+      - "v*"
   pull_request:
   release:
     types: [published]
   schedule:
     # Daily at 7:37
     - cron: "37 7 * * *"
+  workflow_dispatch:
 
 env:
   PIP_DISABLE_PIP_VERSION_CHECK: "1"
@@ -19,7 +24,7 @@ jobs:
     outputs:
       noxenvs: ${{ steps.noxenvs-matrix.outputs.noxenvs }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up nox
         uses: wntrblm/[email protected]
       - id: noxenvs-matrix
@@ -43,7 +48,7 @@ jobs:
             posargs: coverage github
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Install dependencies
         run: sudo apt-get update && sudo apt-get install -y libenchant-2-dev
         if: runner.os == 'Linux' && startsWith(matrix.noxenv, 'docs')
@@ -77,10 +82,11 @@ jobs:
       id-token: write
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
+          cache: pip
           python-version: "3.x"
       - name: Install dependencies
         run: python -m pip install build

README.rst

@@ -19,8 +19,7 @@
 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.
+`jsonschema-lexer` provides a lexer for syntax highlighting JSON Schema documents via `Pygments <https://pygments.org/>`_.
 
 Usage
 -----
@@ -31,8 +30,7 @@ Here's a simple example:
 
 .. code-block:: python
 
-  # Import the JSONSchemaLexer class from the package
-  from jsonschema_lexer.lexer import JSONSchemaLexer
+  from jsonschema_lexer import JSONSchemaLexer
 
   from rich.console import Console
   from rich.syntax import Syntax

jsonschema_lexer/__init__.py

@@ -1,3 +1,7 @@
 """
-Provides the JSONSchema Lexer.
+A JSON Schema lexer for Pygments.
 """
+
+from jsonschema_lexer._lexer import JSONSchemaLexer
+
+__all__ = ["JSONSchemaLexer"]

jsonschema_lexer/lexer.py renamed to jsonschema_lexer/_lexer.py

@@ -12,10 +12,16 @@
 
 class JSONSchemaLexer(JsonLexer):
     """
-    For JSONSchema.
+    A Pygments lexer for dialects of the JSON Schema specification.
     """
 
-    name = "JSON Schema Lexer"
+    name = "JSON Schema"
+    url = "https://json-schema.org"
+    aliases: ClassVar[list[str]] = ["jsonschema", "json-schema"]
+    mimetypes: ClassVar[list[str]] = [
+        "application/schema+json",
+        "application/schema-instance+json",
+    ]
 
     data_types: ClassVar[list[str]] = [
         "object",

jsonschema_lexer/tests/test_integration.py

@@ -1,13 +1,11 @@
 """
-    JSON Schema Lexer tests
+JSON Schema Lexer tests
 """
 
 from pygments.token import Token
 import pytest
 
-from jsonschema_lexer.lexer import JSONSchemaLexer
-
-# Test helpers.
+from jsonschema_lexer import JSONSchemaLexer
 
 
 @pytest.fixture()
@@ -26,27 +24,24 @@ def keywords():
 
 
 def assert_single_token(lexer, s, token):
-    """Show that a given string generates only one token."""
+    """
+    Assert a given string generates only one token.
+    """
     tokens = list(lexer.get_tokens_unprocessed(s))
     assert len(tokens) == 1
     assert s == tokens[0][2]
     assert token == tokens[0][1]
 
 
 def assert_tokens(lexer, string, expected_tokens):
-    """Show that a given string generates the expected tokens."""
+    """
+    Assert a given string generates the expected tokens.
+    """
     tokens = list(lexer.get_tokens_unprocessed(string))
     parsed_tokens = [t[1] for t in tokens]
     assert parsed_tokens == expected_tokens
 
 
-# Tests
-
-
-def test_it_imports():
-    import jsonschema_lexer  # noqa: F401
-
-
 def test_data_type_tokens(lexer, data_types):
     for data_type in data_types:
         assert_single_token(lexer, data_type, Token.Name.Decorator)

noxfile.py

@@ -6,7 +6,6 @@
 
 ROOT = Path(__file__).parent
 PYPROJECT = ROOT / "pyproject.toml"
-DOCS = ROOT / "docs"
 
 PACKAGE = ROOT / "jsonschema_lexer"
 

pyproject.toml

@@ -30,7 +30,7 @@ classifiers = [
 ]
 dynamic = ["version"]
 dependencies = [
-  "Pygments==2.17.2"
+  "Pygments>=2.17.2"
 ]
 
 [project.urls]
@@ -137,5 +137,4 @@ from-first = true
 
 [tool.ruff.lint.per-file-ignores]
 "noxfile.py" = ["ANN", "D100", "S101", "T201"]
-"docs/*" = ["ANN", "D", "INP001"]
 "jsonschema_lexer/tests/*" = ["ANN", "BLE001", "D", "PERF", "S"]