chore(vsx): improve category documentation

Author: RubenHalman

packages/vsx/README.md

@@ -37,6 +37,9 @@
 
 - **[Usage](#usage)**
 - **[Default Rules](#default-rules)**
+  - [Problems](#problems)
+  - [Suggestions](#suggestions)
+  - [Layout](#layout)
 - **[Configuration](#configuration)**
 - **[Installation](#installation)**
 - **[Development](#development)**
@@ -67,201 +70,179 @@ Lightning Flow Scanner VSX is plug-and-play. Open any project with flows and use
 > Want to help improve this project? See our [Contributing Guidelines](https://github.com/Flow-Scanner/lightning-flow-scanner?tab=contributing-ov-file)
 
 <!-- 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.
+Rules that detect issues highly likely to cause runtime errors, security risks, governor limit exceptions, or deployment failures.
 
+#### 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
+#### 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
+#### 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
 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
+#### 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
+#### 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
+#### 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
+#### 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
+#### 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
+#### 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.
+Rules in this category recommend better patterns and optimizations related to performance, bulkification, trigger behavior, and overall design. Following them improves efficiency and long-term maintainability without affecting correctness.
 
+#### 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
+#### 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 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
+#### 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)
+#### 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
+#### 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
+#### 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
+#### 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)
+#### 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)
+#### 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.
+Rules in this category enforce consistency in naming, documentation, element organization, and visual layout. They help ensure Flows remain readable, well-documented, and structured as automations scale.
 
+#### 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
+#### 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)
+#### 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
+#### 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
+#### 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 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
+#### 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*

packages/vsx/package.json

@@ -10,7 +10,7 @@
   },
   "icon": "media/lightningflow.png",
   "description": "A VS Code Extension for analysis and optimization of Salesforce Flows. Scans metadata for 20+ issues such as hardcoded IDs, unsafe contexts, inefficient SOQL/DML operations, recursion risks, and missing fault handling. Supports auto-fixes, rule configurations, and tests integration.",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "engines": {
     "vscode": "^1.92.0"
   },