feat: default severities

RubenHalman · RubenHalman · commit 963b2f570f4b · 2025-12-08T07:35:05.000+01:00
diff --git a/README.md b/README.md
diff --git a/packages/action/README.md b/packages/action/README.md
diff --git a/packages/cli/README.md b/packages/cli/README.md
diff --git a/packages/core/src/main/libs/exportAsDetails.ts b/packages/core/src/main/libs/exportAsDetails.ts
@@ -18,7 +18,7 @@ export function exportDetails(results: ScanResult[], includeDetails = false): Fl
           flowFile,
           flowName,
           ruleName: rule.ruleDefinition.label || rule.ruleName,  // TODO: replace with id
-          severity: rule.severity ?? "error",
+          severity: rule.severity ?? "warning",
         };
         return exported;
       }));
diff --git a/packages/core/src/main/libs/exportAsSarif.ts b/packages/core/src/main/libs/exportAsSarif.ts
@@ -83,6 +83,6 @@ function mapSeverity(sev: string): "error" | "note" | "warning" {
     case "info":
     case "note": return "note";
     case "warning": return "warning";
-    default: return "error";
+    default: return "warning";
   }
 }
diff --git a/packages/core/src/main/models/FlatViolation.ts b/packages/core/src/main/models/FlatViolation.ts
@@ -5,4 +5,9 @@ export interface FlatViolation extends Omit<Violation, 'details'> {
   flowName: string;
   ruleName: string;
   severity: string;
+  dataType?: string;
+  locationX?: string;
+  locationY?: string;
+  connectsTo?: string;
+  expression?: string;
 }
diff --git a/packages/core/src/main/models/LoopRuleCommon.ts b/packages/core/src/main/models/LoopRuleCommon.ts
@@ -4,8 +4,8 @@ import { RuleCommon } from "./RuleCommon";
 import { RuleInfo } from "./RuleInfo";
 
 export abstract class LoopRuleCommon extends RuleCommon implements IRuleDefinition {
-  constructor(info: RuleInfo) {
-    super(info);
+  constructor(info: RuleInfo, optional?: { severity?: string }) {
+    super(info, optional);
   }
 
   protected check(
@@ -17,12 +17,10 @@ export abstract class LoopRuleCommon extends RuleCommon implements IRuleDefiniti
     if (!loopElements.length) {
       return [];
     }
-
     const statementsInLoops = this.findStatementsInLoops(flow, loopElements);
     const results = statementsInLoops
       .filter(det => !suppressions.has(det.name))
       .map(det => new Violation(det));
-
     return results;
   }
 
@@ -44,12 +42,10 @@ export abstract class LoopRuleCommon extends RuleCommon implements IRuleDefiniti
         statementsInLoops.push(element);
       }
     };
-
     for (const element of loopElements) {
       const loopEnd = this.findLoopEnd(element);
       new Compiler().traverseFlow(flow, element.name, findStatement, loopEnd);
     }
-
     return statementsInLoops;
   }
 }
diff --git a/packages/core/src/main/rules/ActionCallsInLoop.ts b/packages/core/src/main/rules/ActionCallsInLoop.ts
@@ -15,8 +15,7 @@ export class ActionCallsInLoop extends LoopRuleCommon implements IRuleDefinition
         label: "Action Call In Loop",
         name: "ActionCallsInLoop",
         supportedTypes: FlowType.backEndTypes,
-      }
-    );
+      }, { severity: "error" });
   }
   protected getStatementTypes(): string[] {
     return ["actionCalls", "apexPluginCalls"];
diff --git a/packages/core/src/main/rules/AutoLayout.ts b/packages/core/src/main/rules/AutoLayout.ts
@@ -10,7 +10,7 @@ export class AutoLayout extends RuleCommon implements IRuleDefinition {
         "With Canvas Mode set to Auto-Layout, Elements are spaced, connected, and aligned automatically, keeping your Flow neatly organized thus saving you time.",
       supportedTypes: core.FlowType.allTypes(),
       docRefs: [],
-    });
+    }, { severity: "note" });
   }
   
   protected check(
diff --git a/packages/core/src/main/rules/DMLStatementInLoop.ts b/packages/core/src/main/rules/DMLStatementInLoop.ts
@@ -15,7 +15,7 @@ export class DMLStatementInLoop extends LoopRuleCommon implements IRuleDefinitio
       label: "DML Statement In A Loop",
       name: "DMLStatementInLoop",
       supportedTypes: FlowType.backEndTypes,
-    });
+    }, { severity: "error" });
   }
 
   protected getStatementTypes(): string[] {
diff --git a/packages/core/src/main/rules/FlowDescription.ts b/packages/core/src/main/rules/FlowDescription.ts
@@ -11,7 +11,7 @@ export class FlowDescription extends RuleCommon implements IRuleDefinition {
       label: "Missing Flow Description",
       name: "FlowDescription",
       supportedTypes: [...core.FlowType.backEndTypes, ...core.FlowType.visualTypes],
-    });
+    }, { severity: "error" });
   }
 
   protected check(
diff --git a/packages/core/src/main/rules/FlowName.ts b/packages/core/src/main/rules/FlowName.ts
@@ -16,7 +16,7 @@ export class FlowName extends RuleCommon implements IRuleDefinition {
       label: "Flow Naming Convention",
       name: "FlowName",
       supportedTypes: core.FlowType.allTypes(),
-    });
+    }, { severity: "error" });
   }
 
   protected check(
diff --git a/packages/core/src/main/rules/HardcodedId.ts b/packages/core/src/main/rules/HardcodedId.ts
@@ -20,7 +20,7 @@ export class HardcodedId extends RuleCommon implements IRuleDefinition {
           path: "https://www.linkedin.com/feed/update/urn:li:activity:6947530300012826624/",
         },
       ],
-    });
+    }, { severity: "error" });
   }
 
   protected check(
diff --git a/packages/core/src/main/rules/HardcodedUrl.ts b/packages/core/src/main/rules/HardcodedUrl.ts
@@ -22,7 +22,7 @@ export class HardcodedUrl extends RuleCommon implements IRuleDefinition {
         name: "HardcodedUrl",
         supportedTypes: FlowType.allTypes(),
       },
-      { severity: "warning" }
+      { severity: "error" }
     );
   }
 
diff --git a/packages/core/src/main/rules/MissingMetadataDescription.ts b/packages/core/src/main/rules/MissingMetadataDescription.ts
@@ -10,7 +10,7 @@ export class MissingMetadataDescription extends RuleCommon implements IRuleDefin
       label: "Missing Metadata Description",
       name: "MissingMetadataDescription",
       supportedTypes: core.FlowType.allTypes(),
-    });
+    }, { severity: "error" });
   }
 
   protected check(
diff --git a/packages/core/src/main/rules/SOQLQueryInLoop.ts b/packages/core/src/main/rules/SOQLQueryInLoop.ts
@@ -15,10 +15,10 @@ export class SOQLQueryInLoop extends LoopRuleCommon implements IRuleDefinition {
       label: "SOQL Query In A Loop",
       name: "SOQLQueryInLoop",
       supportedTypes: FlowType.backEndTypes,
-    });
+    }, { severity: "error" });
   }
 
   protected getStatementTypes(): string[] {
     return ["recordLookups"];
   }
-}
+}
diff --git a/packages/core/src/main/rules/UnsafeRunningContext.ts b/packages/core/src/main/rules/UnsafeRunningContext.ts
@@ -16,7 +16,7 @@ export class UnsafeRunningContext extends RuleCommon implements IRuleDefinition
           path: "https://help.salesforce.com/s/articleView?id=sf.flow_distribute_context_data_safety_system_context.htm&type=5",
         },
       ],
-    }, { severity: "warning" });
+    }, { severity: "error" });
   }
 
   protected check(
diff --git a/packages/core/tests/ExportSarif.test.ts b/packages/core/tests/ExportSarif.test.ts
@@ -27,7 +27,7 @@ describe("exportSarif()", () => {
     const resultsArray = json.runs[0].results;
     expect(resultsArray).toHaveLength(1);
     expect(resultsArray[0].ruleId).toBe("DMLStatementInLoop");
-    expect(resultsArray[0].level).toBe("error");
+    expect(resultsArray[0].level).toBe("warning");
     // Location: has region
     const region = resultsArray[0].locations[0].physicalLocation.region;
     expect(region).toBeDefined();
diff --git a/packages/core/tests/UnsafeRunningContext.test.ts b/packages/core/tests/UnsafeRunningContext.test.ts
@@ -19,7 +19,7 @@ describe("UnsafeRunningContext", () => {
     const ruleResult: core.RuleResult = unsafeRunningContext.execute(parsed.flow as core.Flow);
     expect(ruleResult.occurs).toBe(true);
     expect(ruleResult.details).not.toHaveLength(0);
-    expect(ruleResult.ruleDefinition.severity).toBe("warning");
+    expect(ruleResult.ruleDefinition.severity).toBe("error");
   });
 
   it("should not have a scan result for with sharing system mode", async () => {
diff --git a/packages/vsx/README.md b/packages/vsx/README.md

Original file line number	Diff line number	Diff line change
`@@ -83,6 +83,6 @@ function mapSeverity(sev: string): "error" \| "note" \| "warning" {`
`83`	`83`	`case "info":`
`84`	`84`	`case "note": return "note";`
`85`	`85`	`case "warning": return "warning";`
`86`		`- default: return "error";`
	`86`	`+ default: return "warning";`
`87`	`87`	`}`
`88`	`88`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,8 +4,8 @@ import { RuleCommon } from "./RuleCommon";`
`4`	`4`	`import { RuleInfo } from "./RuleInfo";`
`5`	`5`
`6`	`6`	`export abstract class LoopRuleCommon extends RuleCommon implements IRuleDefinition {`
`7`		`- constructor(info: RuleInfo) {`
`8`		`- super(info);`
	`7`	`+ constructor(info: RuleInfo, optional?: { severity?: string }) {`
	`8`	`+ super(info, optional);`
`9`	`9`	`}`
`10`	`10`
`11`	`11`	`protected check(`
`@@ -17,12 +17,10 @@ export abstract class LoopRuleCommon extends RuleCommon implements IRuleDefiniti`
`17`	`17`	`if (!loopElements.length) {`
`18`	`18`	`return [];`
`19`	`19`	`}`
`20`		`-`
`21`	`20`	`const statementsInLoops = this.findStatementsInLoops(flow, loopElements);`
`22`	`21`	`const results = statementsInLoops`
`23`	`22`	`.filter(det => !suppressions.has(det.name))`
`24`	`23`	`.map(det => new Violation(det));`
`25`		`-`
`26`	`24`	`return results;`
`27`	`25`	`}`
`28`	`26`
`@@ -44,12 +42,10 @@ export abstract class LoopRuleCommon extends RuleCommon implements IRuleDefiniti`
`44`	`42`	`statementsInLoops.push(element);`
`45`	`43`	`}`
`46`	`44`	`};`
`47`		`-`
`48`	`45`	`for (const element of loopElements) {`
`49`	`46`	`const loopEnd = this.findLoopEnd(element);`
`50`	`47`	`new Compiler().traverseFlow(flow, element.name, findStatement, loopEnd);`
`51`	`48`	`}`
`52`		`-`
`53`	`49`	`return statementsInLoops;`
`54`	`50`	`}`
`55`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ export class AutoLayout extends RuleCommon implements IRuleDefinition {`
`10`	`10`	`"With Canvas Mode set to Auto-Layout, Elements are spaced, connected, and aligned automatically, keeping your Flow neatly organized thus saving you time.",`
`11`	`11`	`supportedTypes: core.FlowType.allTypes(),`
`12`	`12`	`docRefs: [],`
`13`		`- });`
	`13`	`+ }, { severity: "note" });`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`protected check(`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ export class DMLStatementInLoop extends LoopRuleCommon implements IRuleDefinitio`
`15`	`15`	`label: "DML Statement In A Loop",`
`16`	`16`	`name: "DMLStatementInLoop",`
`17`	`17`	`supportedTypes: FlowType.backEndTypes,`
`18`		`- });`
	`18`	`+ }, { severity: "error" });`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`protected getStatementTypes(): string[] {`