feat: Support link inline tags and cross-references

Issue-mkdocstrings/typescript#5: mkdocstrings/typescript#5

Author: pawamoy

src/griffe_typedoc/dataclasses.py

@@ -61,7 +61,7 @@ def from_int(cls, value: int):
             0x100000: cls.SET_SIGNATURE,
             0x200000: cls.TYPE_ALIAS,
             0x400000: cls.REFERENCE,
-        }.get(value)
+        }[value]
 
     def to_int(self):
         return {
@@ -88,11 +88,10 @@ def to_int(self):
             self.SET_SIGNATURE: 0x100000,
             self.TYPE_ALIAS: 0x200000,
             self.REFERENCE: 0x400000,
-        }.get(self)
+        }[self]
 
 
 # https://typedoc.org/guides/tags/
-# We might need to extract {@tags} as "inline tags".
 class BlockTagKind(Enum):
     ALPHA: str = "@alpha"
     BETA: str = "@beta"
@@ -107,11 +106,8 @@ class BlockTagKind(Enum):
     GROUP: str = "@group"
     HIDDEN: str = "@hidden"
     IGNORE: str = "@ignore"
-    INHERIT_DOC: str = "{@inheritDoc}"
     INTERFACE: str = "@interface"
     INTERNAL: str = "@internal"
-    LABEL: str = "{@label}"
-    LINK: str = "{@link}"
     MODULE: str = "@module"
     NAMESPACE: str = "@namespace"
     OVERLOAD: str = "@overload"
@@ -138,6 +134,8 @@ class BlockTagKind(Enum):
 class BlockTagContentKind(Enum):
     TEXT: str = "text"
     CODE: str = "code"
+    INLINE_TAG = "inline-tag"
+
 
 
 @dataclass(kw_only=True)
@@ -150,13 +148,18 @@ class FileRegistry:
 class BlockTagContent:
     kind: BlockTagContentKind
     text: str
+    target: int | str | None = None
+    ts_link_text: str | None = None
 
     def __str__(self) -> str:
-        return self.text
+        return self.markdown()
 
-    @property
-    def markdown(self) -> str:
-        return str(self)
+    def markdown(self, symbol_map: dict[int, Reflection] | None = None) -> str:
+        if self.target:
+            if isinstance(self.target, int) and symbol_map:
+                return f'<autoref identifier="{symbol_map[self.target].path}">{self.text}</autoref>'
+            return f"[{self.text}]({self.target})"
+        return self.text
 
 
 @dataclass(kw_only=True)
@@ -167,9 +170,8 @@ class BlockTag:
     def __str__(self) -> str:
         return "".join(str(block) for block in self.content)
 
-    @property
-    def markdown(self) -> str:
-        return str(self)
+    def markdown(self, **kwargs) -> str:
+        return "".join(block.markdown(**kwargs) for block in self.summary)
 
 
 @dataclass(kw_only=True)
@@ -181,9 +183,8 @@ class Comment:
     def __str__(self) -> str:
         return "".join(str(block) for block in self.summary)
 
-    @property
-    def markdown(self) -> str:
-        return str(self)
+    def markdown(self, **kwargs) -> str:
+        return "".join(block.markdown(**kwargs) for block in self.summary)
 
 
 @dataclass(kw_only=True)

src/griffe_typedoc/decoder.py

@@ -404,6 +404,12 @@ def _load_block_tag_content_code(obj_dict: dict) -> BlockTagContent:
     return BlockTagContent(kind=BlockTagContentKind.CODE, text=obj_dict["text"])
 
 
+@_loader
+def _load_block_tag_content_inline_tag(obj_dict: dict) -> BlockTagContent:
+    obj_dict.pop("tag")
+    return BlockTagContent(kind=BlockTagContentKind.INLINE_TAG, **obj_dict)
+
+
 @_loader
 def _load_comment(obj_dict: dict) -> Comment:
     return Comment(**obj_dict)
@@ -472,11 +478,8 @@ def _load_group(obj_dict: dict) -> Group:
     BlockTagKind.GROUP: _load_block_tag_group,
     BlockTagKind.HIDDEN: _load_block_tag_hidden,
     BlockTagKind.IGNORE: _load_block_tag_ignore,
-    BlockTagKind.INHERIT_DOC: _load_block_tag_inherit_doc,
     BlockTagKind.INTERFACE: _load_block_tag_interface,
     BlockTagKind.INTERNAL: _load_block_tag_internal,
-    BlockTagKind.LABEL: _load_block_tag_label,
-    BlockTagKind.LINK: _load_block_tag_link,
     BlockTagKind.MODULE: _load_block_tag_module,
     BlockTagKind.NAMESPACE: _load_block_tag_namespace,
     BlockTagKind.OVERLOAD: _load_block_tag_overload,
@@ -500,6 +503,7 @@ def _load_group(obj_dict: dict) -> Group:
     BlockTagKind.VIRTUAL: _load_block_tag_virtual,
     BlockTagContentKind.TEXT: _load_block_tag_content_text,
     BlockTagContentKind.CODE: _load_block_tag_content_code,
+    BlockTagContentKind.INLINE_TAG: _load_block_tag_content_inline_tag,
 }