x-fidelity 3.22.0 → 3.23.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [3.23.0](https://github.com/zotoio/x-fidelity/compare/v3.22.0...v3.23.0) (2025-04-02)
+
+
+### Bug Fixes
+
+* add null check for issue level in report generator ([6e2db2a](https://github.com/zotoio/x-fidelity/commit/6e2db2ad234c041b8b8fdfc2902a55ee3bdf1b2a))
+
+
+### Features
+
+* enhance global issues report with detailed formatting and sections ([42e3033](https://github.com/zotoio/x-fidelity/commit/42e3033b9e8cd86c08ef46c3f2470315a336741d))
+
 # [3.22.0](https://github.com/zotoio/x-fidelity/compare/v3.21.1...v3.22.0) (2025-04-02)
 
 

package/dist/notifications/reportGenerator.js

@@ -365,16 +365,79 @@ Several files contain potentially sensitive data patterns that shouldn't be logg
         }
         let section = `## Other Global Issues
 
+The following repository-wide issues were detected:
+
 `;
+        // Group issues by level for better organization
+        const issuesByLevel = {
+            'FATALITY': [],
+            'ERROR': [],
+            'WARNING': [],
+            'EXEMPT': [],
+            'UNKNOWN': []
+        };
         globalIssues.forEach(issue => {
-            section += `- **${issue.ruleFailure}** (${issue.level}): ${issue.details && issue.details.message ? issue.details.message : 'No details available'}\n`;
-            // Add condition details if available
-            if (issue.details && issue.details.conditionDetails) {
-                const { fact, operator, params } = issue.details.conditionDetails;
-                section += `  - Condition: Fact \`${fact}\` with operator \`${operator}\`\n`;
-                if (params) {
-                    section += `  - Parameters: \`${JSON.stringify(params)}\`\n`;
-                }
+            var _a;
+            const level = ((_a = issue.level) === null || _a === void 0 ? void 0 : _a.toUpperCase()) || 'UNKNOWN';
+            if (issuesByLevel[level]) {
+                issuesByLevel[level].push(issue);
+            }
+            else {
+                issuesByLevel['UNKNOWN'].push(issue);
+            }
+        });
+        // Process issues by severity level (highest first)
+        ['FATALITY', 'ERROR', 'WARNING', 'EXEMPT', 'UNKNOWN'].forEach(level => {
+            const levelIssues = issuesByLevel[level];
+            if (levelIssues.length > 0) {
+                section += `### ${level} Level Issues\n\n`;
+                levelIssues.forEach(issue => {
+                    // Extract rule name without the -global suffix for cleaner display
+                    const ruleName = issue.ruleFailure.replace(/-global$/, '');
+                    section += `#### ${ruleName}\n\n`;
+                    section += `**Issue**: ${issue.details && issue.details.message ? issue.details.message : 'No details available'}\n\n`;
+                    // Add rule description if available
+                    if (issue.details && issue.details.ruleDescription) {
+                        section += `**Description**: ${issue.details.ruleDescription}\n\n`;
+                    }
+                    // Add recommendations if available
+                    if (issue.details && issue.details.recommendations) {
+                        section += `**Recommendations**:\n`;
+                        if (Array.isArray(issue.details.recommendations)) {
+                            issue.details.recommendations.forEach((rec) => {
+                                section += `- ${rec}\n`;
+                            });
+                        }
+                        else {
+                            section += `- ${issue.details.recommendations}\n`;
+                        }
+                        section += `\n`;
+                    }
+                    // Add condition details in a more readable format
+                    if (issue.details && issue.details.conditionDetails) {
+                        const { fact, operator, value, params } = issue.details.conditionDetails;
+                        section += `**Rule Condition**: \`${fact}\` ${operator} \`${JSON.stringify(value)}\`\n\n`;
+                        if (params) {
+                            section += `**Parameters**: \`${JSON.stringify(params, null, 2)}\`\n\n`;
+                        }
+                    }
+                    // Add all conditions if available
+                    if (issue.details && issue.details.allConditions && issue.details.allConditions.length > 0) {
+                        section += `**All Conditions** (${issue.details.conditionType || 'unknown'}):\n\n`;
+                        issue.details.allConditions.forEach((condition, index) => {
+                            section += `${index + 1}. \`${condition.fact}\` ${condition.operator} \`${JSON.stringify(condition.value)}\`\n`;
+                            if (condition.params) {
+                                section += `   Parameters: \`${JSON.stringify(condition.params, null, 2)}\`\n`;
+                            }
+                        });
+                        section += `\n`;
+                    }
+                    // Add any additional details
+                    if (issue.details && issue.details.details) {
+                        section += `**Additional Details**:\n\`\`\`\n${JSON.stringify(issue.details.details, null, 2)}\n\`\`\`\n\n`;
+                    }
+                    section += `---\n\n`;
+                });
             }
         });
         return section;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "x-fidelity",
-  "version": "3.22.0",
+  "version": "3.23.0",
   "description": "cli for opinionated framework adherence checks",
   "main": "dist/index",
   "types": "dist/index.d.ts",

package/src/notifications/reportGenerator.ts

@@ -435,19 +435,88 @@ Several files contain potentially sensitive data patterns that shouldn't be logg
     
     let section = `## Other Global Issues
 
+The following repository-wide issues were detected:
+
 `;
     
+    // Group issues by level for better organization
+    const issuesByLevel: Record<string, typeof globalIssues> = {
+      'FATALITY': [],
+      'ERROR': [],
+      'WARNING': [],
+      'EXEMPT': [],
+      'UNKNOWN': []
+    };
+    
     globalIssues.forEach(issue => {
-      section += `- **${issue.ruleFailure}** (${issue.level}): ${issue.details && issue.details.message ? issue.details.message : 'No details available'}\n`;
-      
-      
-      // Add condition details if available
-      if (issue.details && issue.details.conditionDetails) {
-        const { fact, operator, params } = issue.details.conditionDetails;
-        section += `  - Condition: Fact \`${fact}\` with operator \`${operator}\`\n`;
-        if (params) {
-          section += `  - Parameters: \`${JSON.stringify(params)}\`\n`;
-        }
+      const level = issue.level?.toUpperCase() || 'UNKNOWN';
+      if (issuesByLevel[level]) {
+        issuesByLevel[level].push(issue);
+      } else {
+        issuesByLevel['UNKNOWN'].push(issue);
+      }
+    });
+    
+    // Process issues by severity level (highest first)
+    ['FATALITY', 'ERROR', 'WARNING', 'EXEMPT', 'UNKNOWN'].forEach(level => {
+      const levelIssues = issuesByLevel[level];
+      if (levelIssues.length > 0) {
+        section += `### ${level} Level Issues\n\n`;
+        
+        levelIssues.forEach(issue => {
+          // Extract rule name without the -global suffix for cleaner display
+          const ruleName = issue.ruleFailure.replace(/-global$/, '');
+          
+          section += `#### ${ruleName}\n\n`;
+          section += `**Issue**: ${issue.details && issue.details.message ? issue.details.message : 'No details available'}\n\n`;
+          
+          // Add rule description if available
+          if (issue.details && issue.details.ruleDescription) {
+            section += `**Description**: ${issue.details.ruleDescription}\n\n`;
+          }
+          
+          // Add recommendations if available
+          if (issue.details && issue.details.recommendations) {
+            section += `**Recommendations**:\n`;
+            if (Array.isArray(issue.details.recommendations)) {
+              issue.details.recommendations.forEach((rec: string) => {
+                section += `- ${rec}\n`;
+              });
+            } else {
+              section += `- ${issue.details.recommendations}\n`;
+            }
+            section += `\n`;
+          }
+          
+          // Add condition details in a more readable format
+          if (issue.details && issue.details.conditionDetails) {
+            const { fact, operator, value, params } = issue.details.conditionDetails;
+            section += `**Rule Condition**: \`${fact}\` ${operator} \`${JSON.stringify(value)}\`\n\n`;
+            
+            if (params) {
+              section += `**Parameters**: \`${JSON.stringify(params, null, 2)}\`\n\n`;
+            }
+          }
+          
+          // Add all conditions if available
+          if (issue.details && issue.details.allConditions && issue.details.allConditions.length > 0) {
+            section += `**All Conditions** (${issue.details.conditionType || 'unknown'}):\n\n`;
+            issue.details.allConditions.forEach((condition: any, index: number) => {
+              section += `${index + 1}. \`${condition.fact}\` ${condition.operator} \`${JSON.stringify(condition.value)}\`\n`;
+              if (condition.params) {
+                section += `   Parameters: \`${JSON.stringify(condition.params, null, 2)}\`\n`;
+              }
+            });
+            section += `\n`;
+          }
+          
+          // Add any additional details
+          if (issue.details && issue.details.details) {
+            section += `**Additional Details**:\n\`\`\`\n${JSON.stringify(issue.details.details, null, 2)}\n\`\`\`\n\n`;
+          }
+          
+          section += `---\n\n`;
+        });
       }
     });
     

package/xfi-report-2025-04-02.json

@@ -11,21 +11,21 @@
         "arch": "x64",
         "cpus": 4,
         "totalMemory": 16766767104,
-        "freeMemory": 13935554560
+        "freeMemory": 14074646528
       },
       "userInfo": {
         "username": "runner",
         "homedir": "/home/runner",
         "shell": "/bin/bash"
       },
-      "startTime": 1743588245905
+      "startTime": 1743589480504
     },
     "memoryUsage": {
-      "rss": 620613632,
-      "heapTotal": 387260416,
-      "heapUsed": 354535912,
-      "external": 6561592,
-      "arrayBuffers": 45016352
+      "rss": 617349120,
+      "heapTotal": 386461696,
+      "heapUsed": 354177312,
+      "external": 6561591,
+      "arrayBuffers": 45016351
     },
     "repoXFIConfig": {
       "sensitiveFileFalsePositives": [],
@@ -85,9 +85,9 @@
         ]
       }
     ],
-    "startTime": 1743588245905,
-    "finishTime": 1743588245979,
-    "durationSeconds": 0.074,
+    "startTime": 1743589480504,
+    "finishTime": 1743589480512,
+    "durationSeconds": 0.008,
     "fileCount": 2,
     "totalIssues": 3,
     "warningCount": 0,
@@ -106,6 +106,6 @@
     },
     "repoPath": "mockRepoPath",
     "repoUrl": "",
-    "xfiVersion": "3.21.1"
+    "xfiVersion": "3.22.0"
   }
 }

package/xfi-report-2025-04-02.md

@@ -3,13 +3,13 @@ Generated for:  on 2025-04-02
 
 ## Executive Summary
 
-This report presents the results of an X-Fidelity analysis conducted on the repository ``. The analysis identified **3 total issues**, including:
+This report presents the results of an X-Fidelity analysis conducted on the repository ``. The analysis identified **0 total issues**, including:
 - 0 warnings
-- 3 fatalities
+- 0 fatalities
 - 0 errors
 - 0 exempt issues
 
-Out of 2 total files, 1 (50.0%) have no issues. The analysis was conducted using X-Fidelity version 3.21.1 and took approximately 0.07 seconds to complete.
+Out of 2 total files, 2 (100.0%) have no issues. The analysis was conducted using X-Fidelity version 3.22.0 and took approximately 0.01 seconds to complete.
 
 ## Repository Overview
 
@@ -18,8 +18,8 @@ Out of 2 total files, 1 (50.0%) have no issues. The analysis was conducted using
 ```mermaid
 pie
     title File Status
-    "Files with Issues" : 1
-    "Successful Files" : 1
+    "Files with Issues" : 0
+    "Successful Files" : 2
 ```
 
 ### Issue Distribution
@@ -28,7 +28,7 @@ pie
 pie
     title Issue Distribution
     "Warnings" : 0
-    "Fatalities" : 3
+    "Fatalities" : 0
     "Errors" : 0
     "Exempt" : 0
 ```
@@ -43,7 +43,6 @@ gantt
     dateFormat X
     axisFormat %s
     section Rule Failures
-    undefined :0, 3
 ```
 
 
@@ -57,7 +56,6 @@ gantt
     dateFormat X
     axisFormat %s
     section Files
-    index.ts :0, 1
 ```
 
 
@@ -85,6 +83,3 @@ pie
 
 
 
-## Other Global Issues
-
-- **undefined** (fatality): Rule failure detected