Aligned generator with simplyblock-io/sbcli#246

Author: noctarius

scripts/cli-reference-gen.py

@@ -32,31 +32,36 @@ def trim(text):
 
 
 def required(item):
-    if "action" in item:
-        return False
-    elif "default" in item:
-        return False
-    elif "private" in item and item["private"]:
-        return False
-    elif "required" in item and item["required"]:
-        return True
-    elif not item["name"].startswith("--"):
-        return True
-    return False
-
-
-def data_type_name(item):
+    return item.get('required', False)
+
+
+def argument_type(item):
     if "action" in item:
         return "marker"
-    text = item["type"]
-    if text == "str":
+
+    spec = item["type"]
+    if isinstance(spec, dict) and ((regex := spec.get('regex')) is not None):
+        return f"regex({regex})"
+
+    if isinstance(spec, dict) and ((size := spec.get('size')) is not None):
+        min = "utils.parse_size('{}')".format(size['min']) if 'min' in size else ''
+        max = "utils.parse_size('{}')".format(size['max']) if 'max' in size else ''
+        return f"size({min}..{max})"
+
+    if isinstance(spec, dict) and ((range := spec.get('range')) is not None):
+        return f"range({range['min']}..{range['max']})"
+
+    if spec == 'size':
+        return "size"
+    elif spec == "str":
         return "string"
-    elif text == "int":
-        return "integer"
-    elif text == "bool":
+    elif spec == "bool":
         return "boolean"
-    else:
-        return "unknown"
+    elif spec == "int":
+        return "integer"
+
+    return "unknown"
+
 
 
 def arg_value(item):
@@ -108,7 +113,7 @@ def get_description(item):
             environment = jinja2.Environment(loader=templateLoader)
 
             environment.filters["trim"] = trim
-            environment.filters["data_type_name"] = data_type_name
+            environment.filters["argument_type"] = argument_type
             environment.filters["arg_value"] = arg_value
             environment.filters["param_value"] = param_value
             environment.filters["required"] = required

scripts/templates/cli-reference-group.jinja2

@@ -38,7 +38,7 @@ sbcli {{ command.name }} {{ subcommand.name }}
 | -------- | ----------- | --------- | -------- |
 {% for argument in subcommand.arguments -%}
 {% if not argument.private -%}
-| {{ argument.name | upper }} | {{ argument | get_description | trim }} | {{ argument | data_type_name }} | {{ argument | required }} |
+| {{ argument.name | upper }} | {{ argument | get_description | trim }} | {{ argument | argument_type }} | {{ argument | required }} |
 {% endif -%}
 {% endfor -%}
 {% endif -%}
@@ -56,7 +56,7 @@ sbcli {{ command.name }} {{ subcommand.name }}
 {%- endif -%}
 | {{ parameter | get_description | trim }}
 {%- if parameter.choices %}<br/><br/>Available Options:{% for choice in parameter.choices %}<br/>- {{ choice }}{% endfor %}{% endif %}
-{%- if parameter.value_range %}<br/><br/>Available Value Range: {{ parameter.value_range }}{% endif %} | {{ parameter | data_type_name }} | {{  parameter | required }} | {{ parameter.default | default("-") }} |
+{%- if parameter.value_range %}<br/><br/>Available Value Range: {{ parameter.value_range }}{% endif %} | {{ parameter | argument_type }} | {{  parameter | required }} | {{ parameter.default | default("-") }} |
 {% endif -%}
 {% endfor -%}
 {% endif -%}