@flow-scanner/lightning-flow-scanner-core 6.15.1 → 6.15.2

package/README.md

@@ -32,9 +32,11 @@
 ## Table of contents
 
 - **[Default Rules](#default-rules)**
+  - [problems](#problems)
+  - [suggestions](#suggestions)
+  - [layout](#layout)
 - **[Configuration](#configuration)**
   - [Configure Rules](#configure-rules)
-  - [Overwrite Expressions](#overwrite-expressions)
   - [Define Exceptions](#define-exceptions)
   - [Exclude Flows](#exclude-flows)
   - [Scan Modes](#scan-modes)
@@ -53,195 +55,205 @@
 
 > Want to code a new rule? → See [How to Write a Rule](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/docs/write-a-rule.md)
 
-<!-- START GENERATED_RULES -->
-### Action Call In A Loop
-Repeatedly invoking Apex actions inside a loop can exhaust governor limits and lead to performance issues. Where possible, bulkify your logic by moving the action call outside the loop and passing a collection variable instead.
-
-**Rule ID:** `action-call-in-loop`
-**Class Name:** _[ActionCallsInLoop](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/ActionCallsInLoop.ts)_
-**Severity:** 🟡 *Warning*
-
-### DML Statement In A Loop
-Executing DML operations (insert, update, delete) inside a loop is a high-risk anti-pattern that frequently causes governor limit exceptions. All database operations should be collected and executed once, outside the loop.
-
-**Rule ID:** `dml-in-loop`
-**Class Name:** _[DMLStatementInLoop](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/DMLStatementInLoop.ts)_
-**Severity:** 🔴 *Error*
-
-### Duplicate DML Operation
-When a Flow performs database operations across multiple screens, users navigating backward can cause the same actions to run multiple times. To prevent unintended changes, either restrict backward navigation or redesign the Flow so database operations execute in a single, forward-moving step.
-
-**Rule ID:** `duplicate-dml`
-**Class Name:** _[DuplicateDMLOperation](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/DuplicateDMLOperation.ts)_
-**Severity:** 🟡 *Warning*
-
-### Excessive Cyclomatic Complexity
-High numbers of loops and decision elements increase a Flow’s cyclomatic complexity. To maintain simplicity and readability, consider using subflows or splitting a Flow into smaller, ordered Flows.
-
-**Rule ID:** `excessive-cyclomatic-complexity`
-**Class Name:** _[CyclomaticComplexity](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/CyclomaticComplexity.ts)_
-**Severity:** 🔵 *Note*
-
-### Flow Naming Convention
-Using clear and consistent Flow names improves readability, discoverability, and maintainability. A good naming convention helps team members quickly understand a Flow’s purpose—for example, including a domain and brief description like Service_OrderFulfillment. Adopt a naming pattern that aligns with your organization’s standards.
-
-**Rule ID:** `invalid-naming-convention`
-**Class Name:** _[FlowName](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/FlowName.ts)_
-**Severity:** 🔴 *Error*
-
-### Get Record All Fields
-Avoid using Get Records to retrieve all fields unless necessary. This improves performance, reduces processing time, and limits exposure of unnecessary data.
-
-**Rule ID:** `get-record-all-fields`
-**Class Name:** _[GetRecordAllFields](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/GetRecordAllFields.ts)_
-**Severity:** 🟡 *Warning*
-
-### Hardcoded Id
-Avoid hard-coding record IDs, as they are unique to a specific org and will not work in other environments. Instead, store IDs in variables—such as merge-field URL parameters or a **Get Records** element—to make the Flow portable, maintainable, and flexible.
-
-**Rule ID:** `hardcoded-id`
-**Class Name:** _[HardcodedId](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/HardcodedId.ts)_
-**Severity:** 🔴 *Error*
-
-### Hardcoded Url
-Avoid hard-coding URLs, as they may change between environments or over time. Instead, store URLs in variables or custom settings to make the Flow adaptable, maintainable, and environment-independent.
-
-**Rule ID:** `hardcoded-url`
-**Class Name:** _[HardcodedUrl](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/HardcodedUrl.ts)_
-**Severity:** 🔴 *Error*
-
-### Inactive Flow
-Inactive Flows should be deleted or archived to reduce risk. Even when inactive, they can cause unintended record changes during testing or be activated as subflows. Keeping only active, relevant Flows improves safety and maintainability.
-
-**Rule ID:** `inactive-flow`
-**Class Name:** _[InactiveFlow](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/InactiveFlow.ts)_
-**Severity:** 🟡 *Warning*
-
-### Invalid API Version
-Flows running on outdated API versions may behave inconsistently when newer platform features or components are used. From API version 50.0 onward, the API Version attribute explicitly controls Flow runtime behavior. Keeping Flows aligned with a supported API version helps prevent compatibility issues and ensures predictable execution.
-
-**Rule ID:** `invalid-api-version`
-**Class Name:** _[APIVersion](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/APIVersion.ts)_
-**Severity:** 🟡 *Warning*
-
-### Missing Auto Layout
-Auto-Layout automatically arranges and aligns Flow elements, keeping the canvas organized and easier to maintain. Enabling it saves time and improves readability.
-
-**Rule ID:** `missing-auto-layout`
-**Class Name:** _[AutoLayout](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/AutoLayout.ts)_
-**Severity:** 🔵 *Note*
-
-### Missing Fault Path
-Elements that can fail should include a Fault Path to handle errors gracefully. Without it, failures show generic errors to users. Fault Paths improve reliability and user experience.
-
-**Rule ID:** `missing-fault-path`
-**Class Name:** _[MissingFaultPath](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/MissingFaultPath.ts)_
-**Severity:** 🟡 *Warning*
-
-### Missing Filter Record Trigger ![Beta](https://img.shields.io/badge/status-beta-yellow)
-Record-triggered Flows without filters on changed fields or entry conditions execute on every record change. Adding filters ensures the Flow runs only when needed, improving performance.
-
-**Rule ID:** `missing-record-trigger-filter`
-**Class Name:** _[MissingFilterRecordTrigger](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/MissingFilterRecordTrigger.ts)_
-**Severity:** 🟡 *Warning*
-
-### Missing Flow Description
-Flow descriptions are essential for documentation and maintainability. Include a description for each Flow, explaining its purpose and where it’s used.
-
-**Rule ID:** `missing-flow-description`
-**Class Name:** _[FlowDescription](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/FlowDescription.ts)_
-**Severity:** 🔴 *Error*
-
-### Missing Metadata Description ![Beta](https://img.shields.io/badge/status-beta-yellow)
-Elements and metadata without a description reduce clarity and maintainability. Adding descriptions improves readability and makes your automation easier to understand.
-
-**Rule ID:** `missing-metadata-description`
-**Class Name:** _[MissingMetadataDescription](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/MissingMetadataDescription.ts)_
-**Severity:** 🟡 *Warning*
-
-### Missing Null Handler
-Get Records operations return null when no data is found. Without handling these null values, Flows can fail or produce unintended results. Adding a null check improves reliability and ensures the Flow behaves as expected.
-
-**Rule ID:** `missing-null-handler`
-**Class Name:** _[MissingNullHandler](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/MissingNullHandler.ts)_
-**Severity:** 🟡 *Warning*
-
-### Missing Trigger Order
-Record-triggered Flows without a specified Trigger Order may execute in an unpredictable sequence. Setting a Trigger Order ensures your Flows run in the intended order.
-
-**Rule ID:** `unspecified-trigger-order`
-**Class Name:** _[TriggerOrder](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/TriggerOrder.ts)_
-**Severity:** 🔵 *Note*
-
-### Process Builder
-Process Builder is retired. Continuing to use it increases maintenance overhead and risks future compatibility issues. Migrating automation to Flow reduces risk and improves maintainability.
-
-**Rule ID:** `process-builder-usage`
-**Class Name:** _[ProcessBuilder](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/ProcessBuilder.ts)_
-**Severity:** 🔴 *Error*
-
-### Record ID as String ![Beta](https://img.shields.io/badge/status-beta-yellow)
-Flows that use a String variable for a record ID instead of receiving the full record introduce unnecessary complexity and additional Get Records queries. Using the complete record simplifies the Flow and improves performance.
-
-**Rule ID:** `record-id-as-string`
-**Class Name:** _[RecordIdAsString](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/RecordIdAsString.ts)_
-**Severity:** 🔵 *Note*
-
-### Recursive After Update
-After-save Flows that update the same record can trigger recursion, causing unintended behavior or performance issues. Avoid updating the triggering record in after-save Flows; use before-save Flows instead to prevent recursion.
-
-**Rule ID:** `recursive-record-update`
-**Class Name:** _[RecursiveAfterUpdate](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/RecursiveAfterUpdate.ts)_
-**Severity:** 🟡 *Warning*
-
-### Same Record Field Updates
-Before-save Flows can safely update the triggering record directly via $Record, applying changes efficiently without extra DML operations. Using before-save updates improves performance
-
-**Rule ID:** `same-record-field-updates`
-**Class Name:** _[SameRecordFieldUpdates](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/SameRecordFieldUpdates.ts)_
-**Severity:** 🟡 *Warning*
-
-### SOQL Query In A Loop
-Running SOQL queries inside a loop can rapidly exceed query limits and severely degrade performance. Queries should be executed once, with results reused throughout the loop.
-
-**Rule ID:** `soql-in-loop`
-**Class Name:** _[SOQLQueryInLoop](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/SOQLQueryInLoop.ts)_
-**Severity:** 🔴 *Error*
-
-### Transform Instead of Loop ![Beta](https://img.shields.io/badge/status-beta-yellow)
-Loop elements that perform direct Assignments on each item can slow down Flows. Using Transform elements allows bulk operations on collections, improving performance and reducing complexity.
-
-**Rule ID:** `transform-instead-of-loop`
-**Class Name:** _[TransformInsteadOfLoop](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/TransformInsteadOfLoop.ts)_
-**Severity:** 🔵 *Note*
-
-### Unclear API Name
-Elements with unclear or duplicated API names, like Copy_X_Of_Element, reduce Flow readability. Make sure to update the API name when copying elements to keep your Flow organized.
-
-**Rule ID:** `unclear-api-naming`
-**Class Name:** _[CopyAPIName](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/CopyAPIName.ts)_
-**Severity:** 🟡 *Warning*
-
-### Unreachable Element
-Unconnected elements never execute and add unnecessary clutter. Remove or connect unused Flow elements to keep Flows clean and efficient.
-
-**Rule ID:** `unreachable-element`
-**Class Name:** _[UnconnectedElement](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/UnconnectedElement.ts)_
-**Severity:** 🟡 *Warning*
-
-### Unsafe Running Context
-Flows configured to run in System Mode without Sharing grant access to all data, bypassing user permissions. Avoid this setting to prevent security risks and protect sensitive data.
-
-**Rule ID:** `unsafe-running-context`
-**Class Name:** _[UnsafeRunningContext](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/UnsafeRunningContext.ts)_
-**Severity:** 🔴 *Error*
-
-### Unused Variable
-Unused variables are never referenced and add unnecessary clutter. Remove them to keep Flows efficient and easy to maintain.
-
-**Rule ID:** `unused-variable`
-**Class Name:** _[UnusedVariable](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/UnusedVariable.ts)_
-**Severity:** 🟡 *Warning*
+<!-- START GENERATED_RULES -->
+### Problems
+
+### DML Statement In A Loop
+Executing DML operations (insert, update, delete) inside a loop is a high-risk anti-pattern that frequently causes governor limit exceptions. All database operations should be collected and executed once, outside the loop.
+
+**Rule ID:** `dml-in-loop`
+**Class Name:** _[DMLStatementInLoop](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/DMLStatementInLoop.ts)_
+**Severity:** 🔴 *Error*
+
+### Hardcoded Id
+Avoid hard-coding record IDs, as they are unique to a specific org and will not work in other environments. Instead, store IDs in variables—such as merge-field URL parameters or a **Get Records** element—to make the Flow portable, maintainable, and flexible.
+
+**Rule ID:** `hardcoded-id`
+**Class Name:** _[HardcodedId](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/HardcodedId.ts)_
+**Severity:** 🔴 *Error*
+
+### Hardcoded Url
+Avoid hard-coding URLs, as they may change between environments or over time. Instead, store URLs in variables or custom settings to make the Flow adaptable, maintainable, and environment-independent.
+
+**Rule ID:** `hardcoded-url`
+**Class Name:** _[HardcodedUrl](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/HardcodedUrl.ts)_
+**Severity:** 🔴 *Error*
+
+### Process Builder
+Process Builder is retired. Continuing to use it increases maintenance overhead and risks future compatibility issues. Migrating automation to Flow reduces risk and improves maintainability.
+
+**Rule ID:** `process-builder-usage`
+**Class Name:** _[ProcessBuilder](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/ProcessBuilder.ts)_
+**Severity:** 🔴 *Error*
+
+### SOQL Query In A Loop
+Running SOQL queries inside a loop can rapidly exceed query limits and severely degrade performance. Queries should be executed once, with results reused throughout the loop.
+
+**Rule ID:** `soql-in-loop`
+**Class Name:** _[SOQLQueryInLoop](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/SOQLQueryInLoop.ts)_
+**Severity:** 🔴 *Error*
+
+### Unsafe Running Context
+Flows configured to run in System Mode without Sharing grant access to all data, bypassing user permissions. Avoid this setting to prevent security risks and protect sensitive data.
+
+**Rule ID:** `unsafe-running-context`
+**Class Name:** _[UnsafeRunningContext](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/UnsafeRunningContext.ts)_
+**Severity:** 🔴 *Error*
+
+### Duplicate DML Operation
+When a Flow performs database operations across multiple screens, users navigating backward can cause the same actions to run multiple times. To prevent unintended changes, either restrict backward navigation or redesign the Flow so database operations execute in a single, forward-moving step.
+
+**Rule ID:** `duplicate-dml`
+**Class Name:** _[DuplicateDMLOperation](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/DuplicateDMLOperation.ts)_
+**Severity:** 🟡 *Warning*
+
+### Missing Fault Path
+Elements that can fail should include a Fault Path to handle errors gracefully. Without it, failures show generic errors to users. Fault Paths improve reliability and user experience.
+
+**Rule ID:** `missing-fault-path`
+**Class Name:** _[MissingFaultPath](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/MissingFaultPath.ts)_
+**Severity:** 🟡 *Warning*
+
+### Missing Null Handler
+Get Records operations return null when no data is found. Without handling these null values, Flows can fail or produce unintended results. Adding a null check improves reliability and ensures the Flow behaves as expected.
+
+**Rule ID:** `missing-null-handler`
+**Class Name:** _[MissingNullHandler](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/MissingNullHandler.ts)_
+**Severity:** 🟡 *Warning*
+
+### Recursive After Update
+After-save Flows that update the same record can trigger recursion, causing unintended behavior or performance issues. Avoid updating the triggering record in after-save Flows; use before-save Flows instead to prevent recursion.
+
+**Rule ID:** `recursive-record-update`
+**Class Name:** _[RecursiveAfterUpdate](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/RecursiveAfterUpdate.ts)_
+**Severity:** 🟡 *Warning*
+
+
+
+### Suggestions
+
+### Action Call In A Loop
+Repeatedly invoking Apex actions inside a loop can exhaust governor limits and lead to performance issues. Where possible, bulkify your logic by moving the action call outside the loop and passing a collection variable instead.
+
+**Rule ID:** `action-call-in-loop`
+**Class Name:** _[ActionCallsInLoop](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/ActionCallsInLoop.ts)_
+**Severity:** 🟡 *Warning*
+
+### Get Record All Fields
+Avoid using Get Records to retrieve all fields unless necessary. This improves performance, reduces processing time, and limits exposure of unnecessary data.
+
+**Rule ID:** `get-record-all-fields`
+**Class Name:** _[GetRecordAllFields](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/GetRecordAllFields.ts)_
+**Severity:** 🟡 *Warning*
+
+### Inactive Flow
+Inactive Flows should be deleted or archived to reduce risk. Even when inactive, they can cause unintended record changes during testing or be activated as subflows. Keeping only active, relevant Flows improves safety and maintainability.
+
+**Rule ID:** `inactive-flow`
+**Class Name:** _[InactiveFlow](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/InactiveFlow.ts)_
+**Severity:** 🟡 *Warning*
+
+### Invalid API Version
+Flows running on outdated API versions may behave inconsistently when newer platform features or components are used. From API version 50.0 onward, the API Version attribute explicitly controls Flow runtime behavior. Keeping Flows aligned with a supported API version helps prevent compatibility issues and ensures predictable execution.
+
+**Rule ID:** `invalid-api-version`
+**Class Name:** _[APIVersion](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/APIVersion.ts)_
+**Severity:** 🟡 *Warning*
+
+### Missing Filter Record Trigger ![Beta](https://img.shields.io/badge/status-beta-yellow)
+Record-triggered Flows without filters on changed fields or entry conditions execute on every record change. Adding filters ensures the Flow runs only when needed, improving performance.
+
+**Rule ID:** `missing-record-trigger-filter`
+**Class Name:** _[MissingFilterRecordTrigger](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/MissingFilterRecordTrigger.ts)_
+**Severity:** 🟡 *Warning*
+
+### Same Record Field Updates
+Before-save Flows can safely update the triggering record directly via $Record, applying changes efficiently without extra DML operations. Using before-save updates improves performance
+
+**Rule ID:** `same-record-field-updates`
+**Class Name:** _[SameRecordFieldUpdates](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/SameRecordFieldUpdates.ts)_
+**Severity:** 🟡 *Warning*
+
+### Excessive Cyclomatic Complexity
+High numbers of loops and decision elements increase a Flow's cyclomatic complexity. To maintain simplicity and readability, consider using subflows or splitting a Flow into smaller, ordered Flows.
+
+**Rule ID:** `excessive-cyclomatic-complexity`
+**Class Name:** _[CyclomaticComplexity](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/CyclomaticComplexity.ts)_
+**Severity:** 🔵 *Note*
+
+### Missing Trigger Order
+Record-triggered Flows without a specified Trigger Order may execute in an unpredictable sequence. Setting a Trigger Order ensures your Flows run in the intended order.
+
+**Rule ID:** `unspecified-trigger-order`
+**Class Name:** _[TriggerOrder](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/TriggerOrder.ts)_
+**Severity:** 🔵 *Note*
+
+### Record ID as String ![Beta](https://img.shields.io/badge/status-beta-yellow)
+Flows that use a String variable for a record ID instead of receiving the full record introduce unnecessary complexity and additional Get Records queries. Using the complete record simplifies the Flow and improves performance.
+
+**Rule ID:** `record-id-as-string`
+**Class Name:** _[RecordIdAsString](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/RecordIdAsString.ts)_
+**Severity:** 🔵 *Note*
+
+### Transform Instead of Loop ![Beta](https://img.shields.io/badge/status-beta-yellow)
+Loop elements that perform direct Assignments on each item can slow down Flows. Using Transform elements allows bulk operations on collections, improving performance and reducing complexity.
+
+**Rule ID:** `transform-instead-of-loop`
+**Class Name:** _[TransformInsteadOfLoop](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/TransformInsteadOfLoop.ts)_
+**Severity:** 🔵 *Note*
+
+
+
+### Layout
+
+### Flow Naming Convention
+Using clear and consistent Flow names improves readability, discoverability, and maintainability. A good naming convention helps team members quickly understand a Flow's purpose—for example, including a domain and brief description like Service_OrderFulfillment. Adopt a naming pattern that aligns with your organization's standards.
+
+**Rule ID:** `invalid-naming-convention`
+**Class Name:** _[FlowName](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/FlowName.ts)_
+**Severity:** 🔴 *Error*
+
+### Missing Flow Description
+Flow descriptions are essential for documentation and maintainability. Include a description for each Flow, explaining its purpose and where it's used.
+
+**Rule ID:** `missing-flow-description`
+**Class Name:** _[FlowDescription](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/FlowDescription.ts)_
+**Severity:** 🔴 *Error*
+
+### Missing Metadata Description ![Beta](https://img.shields.io/badge/status-beta-yellow)
+Elements and metadata without a description reduce clarity and maintainability. Adding descriptions improves readability and makes your automation easier to understand.
+
+**Rule ID:** `missing-metadata-description`
+**Class Name:** _[MissingMetadataDescription](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/MissingMetadataDescription.ts)_
+**Severity:** 🟡 *Warning*
+
+### Unclear API Name
+Elements with unclear or duplicated API names, like Copy_X_Of_Element, reduce Flow readability. Make sure to update the API name when copying elements to keep your Flow organized.
+
+**Rule ID:** `unclear-api-naming`
+**Class Name:** _[CopyAPIName](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/CopyAPIName.ts)_
+**Severity:** 🟡 *Warning*
+
+### Unreachable Element
+Unconnected elements never execute and add unnecessary clutter. Remove or connect unused Flow elements to keep Flows clean and efficient.
+
+**Rule ID:** `unreachable-element`
+**Class Name:** _[UnconnectedElement](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/UnconnectedElement.ts)_
+**Severity:** 🟡 *Warning*
+
+### Unused Variable
+Unused variables are never referenced and add unnecessary clutter. Remove them to keep Flows efficient and easy to maintain.
+
+**Rule ID:** `unused-variable`
+**Class Name:** _[UnusedVariable](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/UnusedVariable.ts)_
+**Severity:** 🟡 *Warning*
+
+### Missing Auto Layout
+Auto-Layout automatically arranges and aligns Flow elements, keeping the canvas organized and easier to maintain. Enabling it saves time and improves readability.
+
+**Rule ID:** `missing-auto-layout`
+**Class Name:** _[AutoLayout](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/AutoLayout.ts)_
+**Severity:** 🔵 *Note*
 <!-- END GENERATED_RULES -->
 
 ---
@@ -279,12 +291,14 @@ By default, all default rules are executed. You can customize individual rules a
       "expression": "<Expression>", // Override rule expression
       "message": "<Message>", // Set custom message
       "messageUrl": "<URL>", // Set custom documentation URL
-      "enabled": false  // Disable this rule
+      "enabled": false, // Disable this rule
     }
   }
 }
 ```
 
+#### Configure Severity
+
 When the severity is not provided it will be `warning` by default. Other available values for severity are `error` and `note`. Configure the severity per rule as demonstrated below:
 
 ```json
@@ -300,6 +314,25 @@ When the severity is not provided it will be `warning` by default. Other availab
 }
 ```
 
+#### Override Expressions
+
+Some rules are configurable and allow overriding their default expressions. You configure these overrides the same way as severity, as shown in the examples below.
+
+```json
+{
+  "rules": {
+    "invalid-api-version": {
+      "expression": "===58" // comparison expression
+    },
+    "invalid-naming-convention": {
+      "expression": "[A-Za-z0-9]" // regular expression
+    }
+  }
+}
+```
+
+#### Customize Messages
+
 If not provided, `message` shows the standard rule summary and `messageUrl` links to the README; providing either overrides the default behavior.
 
 ```json
@@ -313,18 +346,15 @@ If not provided, `message` shows the standard rule summary and `messageUrl` link
 }
 ```
 
-### Overwrite Expressions
+#### Disable Rules
 
-Some rules are configurable and allow overriding their default expressions. You configure these overrides the same way as severity, as shown in the examples below.
+To disable a rule, set `"enabled": false` as shown below:
 
 ```json
 {
   "rules": {
-    "invalid-api-version": {
-      "expression": "===58" // comparison expression
-    },
-    "invalid-naming-convention": {
-      "expression": "[A-Za-z0-9]" // regular expression
+    "dml-in-loop": {
+      "enabled": false
     }
   }
 }

package/main/models/RuleCommon.d.ts

@@ -1,6 +1,7 @@
 import { RuleInfo } from "./RuleInfo";
 import * as core from "../internals/internals";
 export declare abstract class RuleCommon {
+    category?: 'problem' | 'suggestion' | 'layout';
     description: string;
     summary: string;
     docRefs: Array<{

package/main/models/RuleCommon.js

@@ -127,6 +127,7 @@ let RuleCommon = class RuleCommon {
         return undefined;
     }
     constructor(info, optional){
+        _define_property(this, "category", void 0);
         _define_property(this, "description", void 0);
         _define_property(this, "summary", void 0);
         _define_property(this, "docRefs", []);
@@ -137,6 +138,7 @@ let RuleCommon = class RuleCommon {
         _define_property(this, "supportedTypes", void 0);
         _define_property(this, "uri", void 0);
         _define_property(this, "ruleId", void 0);
+        this.category = info.category;
         this.ruleId = info.ruleId;
         this.name = info.name;
         this.supportedTypes = info.supportedTypes;

package/main/models/RuleInfo.d.ts

@@ -27,6 +27,11 @@ export declare class RuleInfo {
      * This property is being displayed on sf cli and on vsce
      */
     label: string;
+    /**
+     * The category for the rule.
+     * 'problem' | 'suggestion' | 'layout'
+     */
+    category: 'problem' | 'suggestion' | 'layout';
     /**
      * Stable public identifier used for config, suppression, and reporting.
      */

package/main/models/RuleInfo.js

@@ -37,6 +37,10 @@ let RuleInfo = class RuleInfo {
    * This property is being displayed on sf cli and on vsce
    */ _define_property(this, "label", void 0);
         /**
+   * The category for the rule.
+   * 'problem' | 'suggestion' | 'layout'
+   */ _define_property(this, "category", void 0);
+        /**
    * Stable public identifier used for config, suppression, and reporting.
    */ _define_property(this, "ruleId", void 0);
         /**

package/main/rules/APIVersion.js

@@ -114,6 +114,7 @@ let APIVersion = class APIVersion extends _RuleCommon.RuleCommon {
     constructor(){
         super({
             ruleId: "invalid-api-version",
+            category: "suggestion",
             name: "APIVersion",
             label: "Invalid API Version",
             description: "Flows running on outdated API versions may behave inconsistently when newer platform features or components are used. From API version 50.0 onward, the API Version attribute explicitly controls Flow runtime behavior. Keeping Flows aligned with a supported API version helps prevent compatibility issues and ensures predictable execution.",

package/main/rules/ActionCallsInLoop.js

@@ -20,6 +20,7 @@ let ActionCallsInLoop = class ActionCallsInLoop extends _LoopRuleCommon.LoopRule
     constructor(){
         super({
             ruleId: "action-call-in-loop",
+            category: "suggestion",
             description: "Repeatedly invoking Apex actions inside a loop can exhaust governor limits and lead to performance issues. Where possible, bulkify your logic by moving the action call outside the loop and passing a collection variable instead.",
             summary: "Action calls inside loop risk governor limits",
             docRefs: [

package/main/rules/AutoLayout.js

@@ -66,6 +66,7 @@ let AutoLayout = class AutoLayout extends _RuleCommon.RuleCommon {
     constructor(){
         super({
             ruleId: "missing-auto-layout",
+            category: "layout",
             name: "AutoLayout",
             label: "Missing Auto Layout",
             description: "Auto-Layout automatically arranges and aligns Flow elements, keeping the canvas organized and easier to maintain. Enabling it saves time and improves readability.",

package/main/rules/CopyAPIName.js

@@ -60,6 +60,7 @@ let CopyAPIName = class CopyAPIName extends _RuleCommon.RuleCommon {
     constructor(){
         super({
             ruleId: "unclear-api-naming",
+            category: "layout",
             name: "CopyAPIName",
             label: "Unclear API Name",
             description: "Elements with unclear or duplicated API names, like Copy_X_Of_Element, reduce Flow readability. Make sure to update the API name when copying elements to keep your Flow organized.",

package/main/rules/CyclomaticComplexity.js

@@ -88,6 +88,7 @@ let CyclomaticComplexity = class CyclomaticComplexity extends _RuleCommon.RuleCo
     constructor(){
         super({
             ruleId: "excessive-cyclomatic-complexity",
+            category: "suggestion",
             name: "CyclomaticComplexity",
             label: "Excessive Cyclomatic Complexity",
             description: "High numbers of loops and decision elements increase a Flow's cyclomatic complexity. To maintain simplicity and readability, consider using subflows or splitting a Flow into smaller, ordered Flows.",

package/main/rules/DMLStatementInLoop.js

@@ -21,6 +21,7 @@ let DMLStatementInLoop = class DMLStatementInLoop extends _LoopRuleCommon.LoopRu
     constructor(){
         super({
             ruleId: "dml-in-loop",
+            category: "problem",
             description: "Executing DML operations (insert, update, delete) inside a loop is a high-risk anti-pattern that frequently causes governor limit exceptions. All database operations should be collected and executed once, outside the loop.",
             summary: "DML operations inside loop risk governor limits",
             docRefs: [

package/main/rules/DuplicateDMLOperation.js

@@ -95,6 +95,7 @@ let DuplicateDMLOperation = class DuplicateDMLOperation extends _RuleCommon.Rule
     constructor(){
         super({
             ruleId: "duplicate-dml",
+            category: "problem",
             name: "DuplicateDMLOperation",
             label: "Duplicate DML Operation",
             description: "When a Flow performs database operations across multiple screens, users navigating backward can cause the same actions to run multiple times. To prevent unintended changes, either restrict backward navigation or redesign the Flow so database operations execute in a single, forward-moving step.",

package/main/rules/FlowDescription.js

@@ -64,6 +64,7 @@ let FlowDescription = class FlowDescription extends _RuleCommon.RuleCommon {
     constructor(){
         super({
             ruleId: "missing-flow-description",
+            category: "layout",
             description: "Flow descriptions are essential for documentation and maintainability. Include a description for each Flow, explaining its purpose and where it's used.",
             summary: "Flow descriptions improve documentation and maintainability",
             docRefs: [],

package/main/rules/FlowName.js

@@ -67,6 +67,7 @@ let FlowName = class FlowName extends _RuleCommon.RuleCommon {
     constructor(){
         super({
             ruleId: "invalid-naming-convention",
+            category: "layout",
             description: "Using clear and consistent Flow names improves readability, discoverability, and maintainability. A good naming convention helps team members quickly understand a Flow's purpose—for example, including a domain and brief description like Service_OrderFulfillment. Adopt a naming pattern that aligns with your organization's standards.",
             summary: "Consistent naming improves Flow discoverability and maintainability",
             docRefs: [

package/main/rules/GetRecordAllFields.js

@@ -69,6 +69,7 @@ let GetRecordAllFields = class GetRecordAllFields extends _RuleCommon.RuleCommon
     constructor(){
         super({
             ruleId: "get-record-all-fields",
+            category: "suggestion",
             description: "Avoid using Get Records to retrieve all fields unless necessary. This improves performance, reduces processing time, and limits exposure of unnecessary data.",
             summary: "Retrieving all fields harms performance and security",
             docRefs: [

package/main/rules/HardcodedId.js

@@ -60,6 +60,7 @@ let HardcodedId = class HardcodedId extends _RuleCommon.RuleCommon {
         super({
             ruleId: "hardcoded-id",
             name: "HardcodedId",
+            category: "problem",
             label: "Hardcoded Id",
             description: "Avoid hard-coding record IDs, as they are unique to a specific org and will not work in other environments. Instead, store IDs in variables—such as merge-field URL parameters or a **Get Records** element—to make the Flow portable, maintainable, and flexible.",
             summary: "Hardcoded IDs break portability across environments",

package/main/rules/HardcodedUrl.js

@@ -19,6 +19,7 @@ let HardcodedUrl = class HardcodedUrl extends _RuleCommon.RuleCommon {
     constructor(){
         super({
             ruleId: "hardcoded-url",
+            category: "problem",
             description: "Avoid hard-coding URLs, as they may change between environments or over time. Instead, store URLs in variables or custom settings to make the Flow adaptable, maintainable, and environment-independent.",
             summary: "Hardcoded URLs break across different environments",
             docRefs: [

package/main/rules/InactiveFlow.js

@@ -63,6 +63,7 @@ let InactiveFlow = class InactiveFlow extends _RuleCommon.RuleCommon {
     constructor(){
         super({
             ruleId: "inactive-flow",
+            category: "suggestion",
             name: "InactiveFlow",
             label: "Inactive Flow",
             description: "Inactive Flows should be deleted or archived to reduce risk. Even when inactive, they can cause unintended record changes during testing or be activated as subflows. Keeping only active, relevant Flows improves safety and maintainability.",

package/main/rules/MissingFaultPath.js

@@ -127,6 +127,7 @@ let MissingFaultPath = class MissingFaultPath extends _RuleCommon.RuleCommon {
     constructor(){
         super({
             ruleId: "missing-fault-path",
+            category: "problem",
             description: "Elements that can fail should include a Fault Path to handle errors gracefully. Without it, failures show generic errors to users. Fault Paths improve reliability and user experience.",
             summary: "Fault Paths enable graceful error handling",
             docRefs: [

package/main/rules/MissingMetadataDescription.js

@@ -66,6 +66,7 @@ let MissingMetadataDescription = class MissingMetadataDescription extends _RuleC
     constructor(){
         super({
             ruleId: "missing-metadata-description",
+            category: "layout",
             description: "Elements and metadata without a description reduce clarity and maintainability. Adding descriptions improves readability and makes your automation easier to understand.",
             summary: "Element descriptions improve clarity and maintainability",
             docRefs: [],

package/main/rules/MissingNullHandler.js

@@ -138,6 +138,7 @@ let MissingNullHandler = class MissingNullHandler extends _RuleCommon.RuleCommon
     constructor(){
         super({
             ruleId: "missing-null-handler",
+            category: "problem",
             description: "Get Records operations return null when no data is found. Without handling these null values, Flows can fail or produce unintended results. Adding a null check improves reliability and ensures the Flow behaves as expected.",
             summary: "Null checks prevent failures from missing records",
             docRefs: [],

package/main/rules/MissingRecordTriggerFilter.js

@@ -78,6 +78,7 @@ let MissingRecordTriggerFilter = class MissingRecordTriggerFilter extends _RuleC
     constructor(){
         super({
             ruleId: "missing-record-trigger-filter",
+            category: "suggestion",
             name: "MissingRecordTriggerFilter",
             label: "Missing Filter Record Trigger",
             description: "Record-triggered Flows without filters on changed fields or entry conditions execute on every record change. Adding filters ensures the Flow runs only when needed, improving performance.",

package/main/rules/ProcessBuilder.js

@@ -60,6 +60,7 @@ let ProcessBuilder = class ProcessBuilder extends _RuleCommon.RuleCommon {
     constructor(){
         super({
             ruleId: "process-builder-usage",
+            category: "problem",
             name: "ProcessBuilder",
             label: "Process Builder",
             description: "Process Builder is retired. Continuing to use it increases maintenance overhead and risks future compatibility issues. Migrating automation to Flow reduces risk and improves maintainability.",

package/main/rules/RecordIdAsString.js

@@ -74,6 +74,7 @@ let RecordIdAsString = class RecordIdAsString extends _RuleCommon.RuleCommon {
     constructor(){
         super({
             ruleId: "record-id-as-string",
+            category: "suggestion",
             name: "RecordIdAsString",
             label: "Record ID as String",
             description: "Flows that use a String variable for a record ID instead of receiving the full record introduce unnecessary complexity and additional Get Records queries. Using the complete record simplifies the Flow and improves performance.",

package/main/rules/RecursiveAfterUpdate.js

@@ -105,6 +105,7 @@ let RecursiveAfterUpdate = class RecursiveAfterUpdate extends _RuleCommon.RuleCo
     constructor(){
         super({
             ruleId: "recursive-record-update",
+            category: "problem",
             description: "After-save Flows that update the same record can trigger recursion, causing unintended behavior or performance issues. Avoid updating the triggering record in after-save Flows; use before-save Flows instead to prevent recursion.",
             summary: "After-save updates to same record trigger recursion",
             docRefs: [

package/main/rules/SOQLQueryInLoop.js

@@ -19,6 +19,7 @@ let SOQLQueryInLoop = class SOQLQueryInLoop extends _LoopRuleCommon.LoopRuleComm
     constructor(){
         super({
             ruleId: "soql-in-loop",
+            category: "problem",
             description: "Running SOQL queries inside a loop can rapidly exceed query limits and severely degrade performance. Queries should be executed once, with results reused throughout the loop.",
             summary: "SOQL queries inside loop risk governor limits",
             docRefs: [

package/main/rules/SameRecordFieldUpdates.js

@@ -87,6 +87,7 @@ let SameRecordFieldUpdates = class SameRecordFieldUpdates extends _RuleCommon.Ru
     constructor(){
         super({
             ruleId: "same-record-field-updates",
+            category: "suggestion",
             name: "SameRecordFieldUpdates",
             label: "Same Record Field Updates",
             description: "Before-save Flows can safely update the triggering record directly via $Record, applying changes efficiently without extra DML operations. Using before-save updates improves performance",

package/main/rules/TransformInsteadOfLoop.js

@@ -77,6 +77,7 @@ let TransformInsteadOfLoop = class TransformInsteadOfLoop extends _RuleCommon.Ru
     constructor(){
         super({
             ruleId: "transform-instead-of-loop",
+            category: "suggestion",
             name: "TransformInsteadOfLoop",
             label: "Transform Instead of Loop",
             description: "Loop elements that perform direct Assignments on each item can slow down Flows. Using Transform elements allows bulk operations on collections, improving performance and reducing complexity.",

package/main/rules/TriggerOrder.js

@@ -69,6 +69,7 @@ let TriggerOrder = class TriggerOrder extends _RuleCommon.RuleCommon {
     constructor(){
         super({
             ruleId: "unspecified-trigger-order",
+            category: "suggestion",
             name: "TriggerOrder",
             label: "Missing Trigger Order",
             description: "Record-triggered Flows without a specified Trigger Order may execute in an unpredictable sequence. Setting a Trigger Order ensures your Flows run in the intended order.",

package/main/rules/UnconnectedElement.js

@@ -62,6 +62,7 @@ let UnconnectedElement = class UnconnectedElement extends _RuleCommon.RuleCommon
     constructor(){
         super({
             ruleId: "unreachable-element",
+            category: "layout",
             description: "Unconnected elements never execute and add unnecessary clutter. Remove or connect unused Flow elements to keep Flows clean and efficient.",
             summary: "Unconnected elements add clutter without executing",
             docRefs: [],

package/main/rules/UnsafeRunningContext.js

@@ -68,6 +68,7 @@ let UnsafeRunningContext = class UnsafeRunningContext extends _RuleCommon.RuleCo
     constructor(){
         super({
             ruleId: "unsafe-running-context",
+            category: "problem",
             name: "UnsafeRunningContext",
             label: "Unsafe Running Context",
             description: "Flows configured to run in System Mode without Sharing grant access to all data, bypassing user permissions. Avoid this setting to prevent security risks and protect sensitive data.",

package/main/rules/UnusedVariable.js

@@ -80,6 +80,7 @@ let UnusedVariable = class UnusedVariable extends _RuleCommon.RuleCommon {
     constructor(){
         super({
             ruleId: "unused-variable",
+            category: "layout",
             name: "UnusedVariable",
             label: "Unused Variable",
             description: "Unused variables are never referenced and add unnecessary clutter. Remove them to keep Flows efficient and easy to maintain.",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@flow-scanner/lightning-flow-scanner-core",
   "description": "A lightweight engine for Flow metadata in Node.js, and browser environments. Assess and enhance Salesforce Flow automations for best practices, security, governor limits, and performance issues.",
-  "version": "6.15.1",
+  "version": "6.15.2",
   "main": "index.js",
   "exports": {
     ".": {