✨ add tags option for list2need directive (#1296)

The `tags` option sets these tags on all generated needs

Co-authored-by: OFFICE\cs <[email protected]>

docs/directives/list2need.rst

@@ -149,6 +149,26 @@ The amount of given link-types must be the amount of used levels minus 1.
        * (NEED-D)Recalculate hash and compare
 
 
+tags
+~~~~
+
+``tags`` sets tags globally to all items in the list.
+
+.. code-block:: rst
+
+   .. list2need::
+      :types: req, spec
+      :tags: A, B
+
+      * (NEED-A)Login user
+        * (NEED-B)Provide login screen
+        * (NEED-C)Create password hash
+          * (NEED-D)Recalculate hash and compare
+
+
+The tags ``A`` and ``B`` are attached to all ``NEED-A``, ``NEED-B``, ``NEED-C`` and ``NEED-D``.
+
+
 List examples
 -------------
 

sphinx_needs/directives/list2need.py

@@ -57,6 +57,7 @@ def presentation(argument: str) -> Any:
         "delimiter": directives.unchanged,
         "presentation": directives.unchanged,
         "links-down": directives.unchanged,
+        "tags": directives.unchanged,
     }
 
     def run(self) -> Sequence[nodes.Node]:
@@ -106,6 +107,10 @@ def run(self) -> Sequence[nodes.Node]:
                     f"Unknown link configured: {down_link_raw}. "
                     f"Allowed are {', '.join(link_types)}"
                 )
+
+        # Retrieve tags defined at list level
+        tags = self.options.get("tags", "")
+
         list_needs = []
         # Storing the data in a sorted list
         for content_line in content_raw.split("\n"):
@@ -190,6 +195,16 @@ def run(self) -> Sequence[nodes.Node]:
                 list_need["title"] = OPTION_AREA_REGEX.sub("", list_need["title"])
                 list_need["content"] = OPTION_AREA_REGEX.sub("", list_need["content"])
 
+            # Add tags defined at list level (if exists) to the ones potentially defined in the content
+            if tags:
+                if "options" not in list_need:
+                    list_need["options"] = {}
+                current_tags = list_need["options"].get("tags", "")
+                if current_tags:
+                    list_need["options"]["tags"] = current_tags + "," + tags
+                else:
+                    list_need["options"]["tags"] = tags
+
             template = Template(NEED_TEMPLATE, autoescape=True)
 
             data = list_need