Better short and long rule descriptions

The short description should be limited to just one sentence. While the long description should have both text and markdown formats for the SARIF output. Signed-off-by: Eric Brown <[email protected]>
securesauce · Mar 7, 2024 · 3223c6b · 3223c6b
1 parent 4a385f4
commit 3223c6b
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/precli/renderers/json.py b/precli/renderers/json.py
@@ -67,7 +67,8 @@ def create_rule_array(self, run: Run):
                     text=rule.short_description
                 ),
                 full_description=sarif_om.MultiformatMessageString(
-                    text=rule.full_description
+                    text=rule.full_description,
+                    markdown=rule.full_description
                 ),
                 message_strings={
                     "default": sarif_om.MultiformatMessageString(

diff --git a/precli/rules/__init__.py b/precli/rules/__init__.py
@@ -84,11 +84,11 @@ def short_description(self) -> str:
         :rtype: str
         """
         try:
-            start = self._full_descr.index("\n\n") + 2
+            start = self._full_descr.index("\n# ") + 3
         except ValueError:
             start = 0
         try:
-            end = self._full_descr.index("\n##")
+            end = self._full_descr.index("\n\n")
         except ValueError:
             end = len(self._full_descr)
         return self._full_descr[start:end]