Add a markdown format (#26)

psycofdj · Jun 18, 2023 · 5bd9ede · 5bd9ede
1 parent 9c25bb1
commit 5bd9ede
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 11 deletions.
diff --git a/coverxygen/__init__.py b/coverxygen/__init__.py
@@ -267,6 +267,8 @@ def output_results(self, p_symbols):
       self.output_print_summary(l_outStream, p_symbols)
     elif self.m_format == "json-summary":
       self.output_print_json_summary(l_outStream, p_symbols)
+    elif self.m_format == "markdown-summary":
+      self.output_print_markdown_summary(l_outStream, p_symbols)
     else:
       l_symbolsByFile = Coverxygen.group_symbols_by_file(p_symbols)
       if self.m_format == "json-v3":
@@ -416,11 +418,16 @@ def determine_first_column_width(p_symbolsKindCountsList):
     l_longestKindStringLength = max(l_kindStringLengths, default=0)
     return l_longestKindStringLength
 
+  @staticmethod
+  def get_value_summary_value(count, total):
+    percentage = 0 if total == 0 else (count / total) * 100.0
+    # Format: 100.0% (999/999)
+    return f'{percentage:5.1f}% ({count}/{total})'
+
   @staticmethod
   def print_summary_line(p_stream, p_header, p_headerWidth, p_count, p_total):
-    l_percentage = 0 if p_total == 0 else (p_count / p_total) * 100.0
-    p_stream.write("%s: %5.1f%% (%d/%d)\n" % (("%%-%ds" % (p_headerWidth)) % p_header,
-                                                l_percentage, p_count, p_total))
+    value_string = Coverxygen.get_value_summary_value(p_count, p_total)
+    p_stream.write("%s: %s\n" % (("%%-%ds" % (p_headerWidth)) % p_header, value_string))
 
   @staticmethod
   def output_print_summary(p_stream, p_symbols):
@@ -433,6 +440,27 @@ def output_print_summary(p_stream, p_symbols):
     p_stream.write("%s\n" % ("-" * 35))
     Coverxygen.print_summary_line(p_stream, "Total", l_firstColumnWidth, l_totalCounts["documented_symbol_count"], l_totalCounts["symbol_count"])
 
+  @staticmethod
+  def output_print_markdown_summary(stream, symbols):
+    summary = Coverxygen.create_summary(symbols)
+    symbol_kind_counts_list = Coverxygen.symbol_kind_counts_dict_to_list(summary["kinds"])
+    symbol_kind_counts_list.append({
+        "kind": "Total",
+        "documented_symbol_count": summary["total"]["documented_symbol_count"],
+        "symbol_count": summary["total"]["symbol_count"]
+      })
+    # Append a value column in string format
+    second_column_width = 0
+    for symbol_kind_count in symbol_kind_counts_list:
+      symbol_kind_count['value_string'] = Coverxygen.get_value_summary_value(symbol_kind_count["documented_symbol_count"], symbol_kind_count["symbol_count"])
+      second_column_width = max(second_column_width, len(symbol_kind_count['value_string']))
+    # Render the table
+    first_column_width = max(Coverxygen.determine_first_column_width(symbol_kind_counts_list), 8)
+    stream.write(f'| {"Element".ljust(first_column_width)} | {"Value".ljust(second_column_width)} |\n')
+    stream.write(f'|{"-".ljust(first_column_width+2)}|{" ".ljust(second_column_width+2)}|\n')
+    for symbol_kind_count in symbol_kind_counts_list:
+      stream.write(f'| {symbol_kind_count["kind"].ljust(first_column_width)} | {symbol_kind_count["value_string"].ljust(second_column_width)} |\n')
+
 # Local Variables:
 # ispell-local-dictionary: "en"
 # End:
diff --git a/coverxygen/__main__.py b/coverxygen/__main__.py
@@ -34,14 +34,15 @@ def main():
   l_optionalArgs.add_argument("--format",
                               action="store",
                               help="output file format :\n"
-                              "lcov         : lcov compatible format (default)\n"
-                              "json-v3      : json format which includes summary information\n"
-                              "json-v2      : simpler json format\n"
-                              "json-v1      : legacy json format\n"
-                              "json         : (deprecated) same as json-v2\n"
-                              "json-legacy  : (deprecated) same as json-v1\n"
-                              "json-summary : summary in json format\n"
-                              "summary      : textual summary table format\n",
+                              "lcov             : lcov compatible format (default)\n"
+                              "json-v3          : json format which includes summary information\n"
+                              "json-v2          : simpler json format\n"
+                              "json-v1          : legacy json format\n"
+                              "json             : (deprecated) same as json-v2\n"
+                              "json-legacy      : (deprecated) same as json-v1\n"
+                              "json-summary     : summary in json format\n"
+                              "markdown-summary : summary in markdown table format\n"
+                              "summary          : textual summary table format\n",
                               default="lcov")
   l_optionalArgs.add_argument("--prefix",
                               action="store",