PR - Add 'hide' support and a new meta-data option to List2need directive

docs/directives/list2need.rst

@@ -169,6 +169,62 @@ tags
 The tags ``A`` and ``B`` are attached to all ``NEED-A``, ``NEED-B``, ``NEED-C`` and ``NEED-D``.
 
 
+
+hide
+~~~~
+
+``hide`` sets the hide-option globally to all items in the list.
+
+.. code-block:: rst
+
+   .. list2need::
+      :types: req
+      :tags: A
+      :hide: True
+
+      * (NEED-A) Login user
+      * (NEED-B) Provide login screen
+      * (NEED-C) Create password hash
+      * (NEED-D) Recalculate hash and compare
+
+All ``NEED-A``, ``NEED-B``, ``NEED-C`` and ``NEED-D`` requirements will be marked as hidden. This allows to easily create a list of requirements and presenting them as a table in the final output.
+
+.. code-block:: rst
+
+   .. list2need::
+      :types: req
+      :tags: A
+      :hide: True
+
+      * (NEED-A) Login user
+      * (NEED-B) Provide login screen
+      * (NEED-C) Create password hash
+      * (NEED-D) Recalculate hash and compare
+
+   .. needtable::
+      :types: req
+      :tags: A
+      :style: table
+      :columns: id, title, content, links
+
+
+meta-data
+~~~~~~~~~
+
+Meta-data can be set directly in the related line via, for example: ``((status="open"))``. This meta-data option allows to define meta-data that will be affected to all needs in the list, including extra custom options.
+
+.. code-block:: rst
+
+   .. list2need::
+      :types: req
+      :tags: A
+      :meta-data: validation="Test, Review of Design", status="open"
+
+      * (NEED-A) Login user
+      * (NEED-B) Provide login screen
+      * (NEED-C) Create password hash
+      * (NEED-D) Recalculate hash and compare
+
 List examples
 -------------
 

sphinx_needs/directives/list2need.py

@@ -58,6 +58,8 @@ def presentation(argument: str) -> Any:
         "presentation": directives.unchanged,
         "links-down": directives.unchanged,
         "tags": directives.unchanged,
+        "hide": directives.unchanged,
+        "meta-data": directives.unchanged,
     }
 
     def run(self) -> Sequence[nodes.Node]:
@@ -110,6 +112,8 @@ def run(self) -> Sequence[nodes.Node]:
 
         # Retrieve tags defined at list level
         tags = self.options.get("tags", "")
+        hide = self.options.get("hide", "")
+        metadata = self.options.get("meta-data", "")
 
         list_needs = []
         # Storing the data in a sorted list
@@ -205,6 +209,27 @@ def run(self) -> Sequence[nodes.Node]:
                 else:
                     list_need["options"]["tags"] = tags
 
+            if hide:
+                if "options" not in list_need:
+                    list_need["options"] = {}
+                hide_option = list_need["options"].get("hide", "")
+                list_need["options"]["hide"] = hide_option
+
+            if metadata:
+                if "options" not in list_need:
+                    list_need["options"] = {}
+                metadata_items = re.findall(r'([^=,]+)=["\']([^"\']+)["\']', metadata)
+
+                for key, value in metadata_items:
+                    current_options = list_need["options"].get(key.strip(), "")
+
+                    if current_options:
+                        list_need["options"][key.strip()] = (
+                            current_options + "," + value
+                        )
+                    else:
+                        list_need["options"][key.strip()] = value
+
             template = Template(NEED_TEMPLATE, autoescape=True)
 
             data = list_need