Add --checklist-limit flag (fix #835)

Author: montyly

slither/__main__.py

@@ -472,6 +472,8 @@ def parse_args(detector_classes, printer_classes):  # pylint: disable=too-many-s
         "--checklist", help=argparse.SUPPRESS, action="store_true", default=False
     )
 
+    group_misc.add_argument("--checklist-limit", help=argparse.SUPPRESS, action="store", default="")
+
     parser.add_argument(
         "--wiki-detectors", help=argparse.SUPPRESS, action=OutputWiki, default=False
     )
@@ -751,7 +753,7 @@ def main_impl(all_detector_classes, all_printer_classes):
 
         # Output our results to markdown if we wish to compile a checklist.
         if args.checklist:
-            output_results_to_markdown(results_detectors)
+            output_results_to_markdown(results_detectors, args.checklist_limit)
 
         # Dont print the number of result for printers
         if number_contracts == 0:

slither/utils/command_line.py

@@ -145,7 +145,7 @@ def convert_result_to_markdown(txt):
     return "".join(ret)
 
 
-def output_results_to_markdown(all_results):
+def output_results_to_markdown(all_results, checklistlimit: str):
     checks = defaultdict(list)
     info = defaultdict(dict)
     for results in all_results:
@@ -154,20 +154,26 @@ def output_results_to_markdown(all_results):
 
     print("Summary")
     for check in checks:
-        print(f" - [{check}](#{check}) ({len(checks[check])} results)")
+        print(f" - [{check}](#{check}) ({len(checks[check])} results) ({info[check]['impact']})")
 
     counter = 0
     for (check, results) in checks.items():
         print(f"## {check}")
         print(f'Impact: {info[check]["impact"]}')
         print(f'Confidence: {info[check]["confidence"]}')
+        additional = False
+        if checklistlimit and len(results) > 5:
+            results = results[0:5]
+            additional = True
         for result in results:
             print(" - [ ] ID-" + f"{counter}")
             counter = counter + 1
             print(result["markdown"])
             if result["first_markdown_element"]:
                 print(result["first_markdown_element"])
                 print("\n")
+        if additional:
+            print(f"**More results were found, check [{checklistlimit}]({checklistlimit})**")
 
 
 def output_wiki(detector_classes, filter_wiki):