removed option types

Author: juiwenchen

src/sphinx_codelinks/cmd.py

@@ -1,13 +1,11 @@
 from collections import deque
-from enum import Enum
 from os import linesep
 from pathlib import Path
 import tomllib
 from typing import Annotated, TypeAlias, cast
 
 import typer
 
-from sphinx_codelinks.analyse.models import MarkedContentType
 from sphinx_codelinks.analyse.projects import AnalyseProjects
 from sphinx_codelinks.config import (
     CodeLinksConfig,
@@ -221,11 +219,6 @@ def discover(
         typer.echo(file_path)
 
 
-class SupportedMarkerTypes(str, Enum):
-    need = "need"
-    need_id_refs = "need-id-refs"
-
-
 @write_app.command("rst", no_args_is_help=True)
 def write_rst(  # noqa: PLR0913  # for CLI, so it takes as many as it requires
     jsonpath: Annotated[
@@ -240,21 +233,12 @@ def write_rst(  # noqa: PLR0913  # for CLI, so it takes as many as it requires
             resolve_path=True,
         ),
     ],
-    types: Annotated[
-        list[SupportedMarkerTypes],
-        typer.Option(
-            "--types",
-            "-t",
-            help="The types of marked content to be exported",
-            show_default=True,
-        ),
-    ] = [SupportedMarkerTypes.need_id_refs],  # noqa: B006  # to show the default value on CLI
     outpath: Annotated[
         Path,
         typer.Option(
-            "--outdir",
+            "--outpath",
             "-o",
-            help="The output path for needextend.rst",
+            help="The output path for generated rst file",
             show_default=True,
             dir_okay=False,
             file_okay=True,
@@ -284,9 +268,7 @@ def write_rst(  # noqa: PLR0913  # for CLI, so it takes as many as it requires
 ) -> None:
     """Generate needextend.rst from the extracted obj in JSON."""
     logger.configure(verbose, quiet)
-    convert_marked_content(
-        jsonpath, outpath, remote_url_field, cast(list[MarkedContentType], types), title
-    )
+    convert_marked_content(jsonpath, outpath, remote_url_field, title)
 
 
 def load_config_from_toml(toml_file: Path) -> CodeLinksConfigType:

src/sphinx_codelinks/needextend_write.py

@@ -167,12 +167,9 @@ def convert_marked_content(
     jsonpath: Path,
     outpath: Path,
     remote_url_field: str = "remote-url",
-    types: list[MarkedContentType] | None = None,
     title: str | None = None,
 ) -> None:
     """Convert marked objects extracted by anaylse CLI to needextend in RST"""
-    if not types:
-        types = [MarkedContentType.need_id_refs]
     with jsonpath.open("r") as f:
         marked_content = json.load(f)
 
@@ -183,7 +180,11 @@ def convert_marked_content(
         obj for objs in marked_content.values() for obj in objs
     ]
 
-    intersted_objs = [obj for obj in marked_objs if obj["type"] in types]
+    intersted_objs = [
+        obj
+        for obj in marked_objs
+        if obj["type"] == MarkedContentType.need_id_refs.value
+    ]
 
     for obj in intersted_objs:
         schema = MarkedContentSchema(**obj)
@@ -212,21 +213,8 @@ def convert_marked_content(
                     remote_url=obj["remote_url"],
                 )
                 needextend_texts.append(needextend_text)
-        elif obj["type"] == MarkedContentType.need.value and obj["need"]:
-            oneline_need_id = obj["need"].get("id")
-            if not oneline_need_id:
-                warnings.append(
-                    f"Oneline-need definition {obj} does not have 'id' field in 'need', skipping."
-                )
-                continue
-            needextend_text = NEEDEXTEND_TEMPLATE.safe_substitute(
-                need_id=oneline_need_id,
-                remote_url_field=remote_url_field,
-                remote_url=obj["remote_url"],
-            )
-            needextend_texts.append(needextend_text)
 
     with outpath.open("w") as f:
         f.writelines(needextend_texts)
 
-    logger.info(f"Generated needextend.rst in {outpath}")
+    logger.info(f"Generated {outpath}")

tests/test_needextend_write.py

@@ -1,24 +1,16 @@
 from pathlib import Path
 
-import pytest
-
-from sphinx_codelinks.analyse.models import MarkedContentType
 from sphinx_codelinks.needextend_write import convert_marked_content
 
 
-@pytest.mark.parametrize(
-    "types",
-    [
-        None,  # Default case
-        [MarkedContentType.need_id_refs],
-        [MarkedContentType.need],
-        [MarkedContentType.rst],
-        [MarkedContentType.need, MarkedContentType.need_id_refs],
-    ],
-)
-def test_convert_marked_content(types, tmp_path):
+def test_convert_marked_content(tmp_path):
     jsonpath = Path(__file__).parent / "data" / "analyse" / "marked_content.json"
     outpath = tmp_path / "needextend.rst"
-    convert_marked_content(jsonpath, outpath, types=types)
+    convert_marked_content(jsonpath, outpath)
 
     assert outpath.exists()
+
+    with outpath.open("r") as f:
+        content = f.readlines()
+
+    assert content