🔧 Add "store_labels" to OptionsType (#343)

Co-authored-by: hukkin <https://github.com/hukkin>

Author: chrisjsewell

.gitignore

@@ -141,3 +141,5 @@ __pycache__/
 .DS_Store
 
 docs/api/
+
+uv.lock

.pre-commit-config.yaml

@@ -34,7 +34,7 @@ repos:
     rev: v1.13.0
     hooks:
     - id: mypy
-      additional_dependencies: [mdurl]
+      additional_dependencies: [mdurl, typing-extensions]
       exclude: >
         (?x)^(
           benchmarking/.*\.py|

docs/conf.py

@@ -55,6 +55,7 @@
         "EnvType",
         "Path",
         "Ellipsis",
+        "NotRequired",
     )
 ]
 

docs/contributing.md

@@ -32,7 +32,7 @@ All functions and class methods should be annotated with types and include a doc
 
 ## Testing
 
-For code tests, markdown-it-py uses [pytest](https://docs.pytest.org)):
+For code tests, markdown-it-py uses [pytest](https://docs.pytest.org):
 
 ```shell
 >> cd markdown-it-py

markdown_it/utils.py

@@ -3,7 +3,11 @@
 from collections.abc import Iterable, MutableMapping
 from collections.abc import MutableMapping as MutableMappingABC
 from pathlib import Path
-from typing import Any, Callable, TypedDict, cast
+from typing import TYPE_CHECKING, Any, Callable, TypedDict, cast
+
+if TYPE_CHECKING:
+    from typing_extensions import NotRequired
+
 
 EnvType = MutableMapping[str, Any]  # note: could use TypeAlias in python 3.10
 """Type for the environment sandbox used in parsing and rendering,
@@ -32,6 +36,11 @@ class OptionsType(TypedDict):
     """CSS language prefix for fenced blocks."""
     highlight: Callable[[str, str, str], str] | None
     """Highlighter function: (content, lang, attrs) -> str."""
+    store_labels: NotRequired[bool]
+    """Store link label in link/image token's metadata (under Token.meta['label']).
+
+    This is a Python only option, and is intended for the use of round-trip parsing.
+    """
 
 
 class PresetType(TypedDict):

pyproject.toml

@@ -70,6 +70,9 @@ benchmarking = [
 ]
 profiling = ["gprof2dot"]
 
+[dependency-groups]
+mypy = ["mypy", "mdurl", "typing-extensions"]
+
 [project.scripts]
 markdown-it = "markdown_it.cli.parse:main"
 
@@ -106,7 +109,7 @@ module = ["tests.test_plugins.*", "markdown.*"]
 ignore_errors = true
 
 [[tool.mypy.overrides]]
-module = ["markdown.*"]
+module = ["markdown.*", "linkify_it.*"]
 ignore_missing_imports = true
 
 [tool.pytest.ini_options]