@flow-scanner/lightning-flow-scanner-core 6.5.1 → 6.6.1

package/README.md

@@ -1,409 +1,428 @@
-<p align="center">
-  <a href="https://github.com/Flow-Scanner">
-    <img src="assets/media/bannerslim.png" style="width: 43%;" />
-  </a>
-</p>
-
-<p align="center"><i>UMD-compatible Flow metadata engine for Node.js & browsers—20+ rules to catch issues.</i></p>
-
----
-
-## Table of contens
-
-- **[Default Rules](#default-rules)**
-- **[Configuration](#configuration)**
-  - [Defining Severity Levels](#defining-severity-levels)
-  - [Configuring Expressions](#configuring-expressions)
-  - [Specifying Exceptions](#specifying-exceptions)
-  - [Report Detail Level](#report-detail-level)
-  - [Include Beta Rules](#include-beta-rules)
-- **[Usage](#Usage)**
-  - [Examples](#examples)
-  - [Functions](#functions)
-- **[Installation](#installation)**
-- **[Development](#development)**
-
----
-
-## Default Rules
-
-<p>📌<strong>Tip:</strong> To link directly to a specific rule, use the full GitHub anchor link format. Example:</p>
-<p><em><a href="https://github.com/Flow-Scanner/lightning-flow-scanner-core#unsafe-running-context">https://github.com/Flow-Scanner/lightning-flow-scanner-core#unsafe-running-context</a></em></p>
-
-> Want to code a new rule? → See [How to Write a Rule](docs/write-a-rule.md)
-
-### Action Calls In Loop(Beta)
-
-_[ActionCallsInLoop](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/rules/ActionCallsInLoop.ts)_ - To prevent exceeding Apex governor limits, it is advisable to consolidate and bulkify your apex calls, utilizing a single action call containing a collection variable at the end of the loop.
-
-### Outdated API Version
-
-_[APIVersion](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/rules/APIVersion.ts)_ - Introducing newer API components may lead to unexpected issues with older versions of Flows, as they might not align with the underlying mechanics. Starting from API version 50.0, the **Api Version** attribute has been readily available on the Flow Object. To ensure smooth operation and reduce discrepancies between API versions, it is strongly advised to regularly update and maintain them.
-
-### Auto Layout
-
-_[AutoLayout](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/rules/AutoLayout.ts)_ - With Canvas Mode set to Auto‑Layout, elements are spaced, connected, and aligned automatically, keeping your Flow neatly organized—saving you time.
-
-### Copy API Name
-
-_[CopyAPIName](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/rules/CopyAPIName.ts)_ - Maintaining multiple elements with a similar name, like `Copy_X_Of_Element`, can diminish the overall readability of your Flow. When copying and pasting these elements, remember to update the API name of the newly created copy.
-
-### Cyclomatic Complexity
-
-_[CyclomaticComplexity](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/rules/CyclomaticComplexity.ts)_ - The number of loops and decision rules, plus the number of decisions. Use a combination of 1) subflows and 2) breaking flows into multiple concise trigger‑ordered flows to reduce cyclomatic complexity within a single flow, ensuring maintainability and simplicity.
-
-### DML Statement In A Loop
-
-_[DMLStatementInLoop](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/rules/DMLStatementInLoop.ts)_ - To prevent exceeding Apex governor limits, consolidate all your database operations—record creation, updates, or deletions—at the conclusion of the flow.
-
-### Duplicate DML Operation
-
-_[DuplicateDMLOperation](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/rules/DuplicateDMLOperation.ts)_ - When a flow executes database changes or actions between two screens, prevent users from navigating backward between screens; otherwise, duplicate database operations may be performed.
-
-### Flow Naming Convention
-
-_[FlowName](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/rules/FlowName.ts)_ - The readability of a flow is paramount. Establishing a naming convention significantly enhances findability, searchability, and overall consistency. Include at least a domain and a brief description of the flow’s actions, for example `Service_OrderFulfillment`.
-
-### Get Record All Fields
-
-_[GetRecordAllFields](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/rules/GetRecordAllFields.ts)_ - Following the principle of least privilege (PoLP), avoid using **Get Records** with “Automatically store all fields” unless necessary.
-
-### Hardcoded Id
-
-_[HardcodedId](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/rules/HardcodedId.ts)_ - Avoid hard‑coding IDs because they are org specific. Instead, pass them into variables at the start of the flow—via merge‑field URL parameters or a **Get Records** element.
-
-### Hardcoded Url
-
-_[HardcodedUrl](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/rules/HardcodedUrl.ts)_ - Avoid hard‑coding URLs because they are environment specific. Use an `$API` formula (preferred) or environment‑specific sources like custom labels, metadata, or settings.
-
-### Inactive Flow
-
-_[InactiveFlow](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/rules/InactiveFlow.ts)_ - Like cleaning out your closet: deleting unused flows is essential. Inactive flows can still cause trouble—such as accidentally deleting records during testing, or being activated as subflows.
-
-### Missing Fault Path
-
-_[MissingFaultPath](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/rules/MissingFaultPath.ts)_ - A flow may fail to execute an operation as intended. By default, the flow displays an error to the user and emails the creator. Customize this behavior by incorporating a Fault Path.
-
-### Missing Flow Description
-
-_[FlowDescription](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/rules/FlowDescription.ts)_ - Descriptions play a vital role in documentation. We highly recommend including details about where flows are used and their intended purpose.
-
-### Missing Null Handler
-
-_[MissingNullHandler](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/rules/MissingNullHandler.ts)_ - When a **Get Records** operation finds no data, it returns `null`. Validate data by using a Decision element to check for a non‑null result.
-
-### Process Builder
-
-_[ProcessBuilder](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/rules/ProcessBuilder.ts)_ - Salesforce is transitioning away from Workflow Rules and Process Builder in favor of Flow. Begin migrating your organization’s automation to Flow.
-
-### Recursive After Update
-
-_[RecursiveAfterUpdate](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/rules/RecursiveAfterUpdate.ts)_ - After‑update flows are meant for modifying **other** records. Using them on the same record can cause recursion. Consider **before‑save** flows for same‑record updates.
-
-### Same Record Field Updates
-
-_[SameRecordFieldUpdates](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/rules/SameRecordFieldUpdates.ts)_ - Similar to triggers, **before‑save** contexts can update the same record via `$Record` without invoking DML.
-
-### SOQL Query In A Loop
-
-_[SOQLQueryInLoop](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/rules/SOQLQueryInLoop.ts)_ - To prevent exceeding Apex governor limits, consolidate all SOQL queries at the end of the flow.
-
-### Trigger Order
-
-_[TriggerOrder](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/rules/TriggerOrder.ts)_ - Guarantee your flow execution order with the **Trigger Order** property introduced in Spring ’22.
-
-### Unconnected Element
-
-_[UnconnectedElement](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/rules/UnconnectedElement.ts)_ - Avoid unconnected elements that are not used by the flow to keep flows efficient and maintainable.
-
-### Unsafe Running Context
-
-_[UnsafeRunningContext](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/rules/UnsafeRunningContext.ts)_ - This flow is configured to run in **System Mode without Sharing**, granting all users permission to view and edit all data. This can lead to unsafe data access.
-
-### Unused Variable
-
-_[UnusedVariable](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/rules/UnusedVariable.ts)_ - To maintain efficiency and manageability, avoid including variables that are never referenced.
-
----
-
-## Configuration
-
-Lightning Flow Scanner is plug-and-play by default, but we recommend configuring and defining:
-
-- The rules to be executed.
-- The severity of violating any specific rule.
-- Rule properties such as REGEX expressions.
-- Any known exceptions that should be ignored during scanning.
-
-```json
-{
-  "rules": {
-    // Your rules here
-  },
-  "exceptions": {
-    // Your exceptions here
-  }
-}
-```
-
-Using the rules section of your configurations, you can specify the list of rules to be run. Furthermore, you can define the severity and configure expressions of rules. Below is a breakdown of the available attributes of rule configuration:
-
-```json
-{
-  "rules": {
-    "<RuleName>": {
-      "severity": "<Severity>",
-      "expression": "<Expression>"
-    }
-  }
-}
-```
-
-### Defining Severity Levels
-
-When the severity is not provided it will be `warning` by default. Other available values for severity are `error` and `note`. Define the severity per rule as shown below:
-
-```json
-{
-  "rules": {
-    "FlowDescription": {
-      "severity": "error"
-    },
-    "UnusedVariable": {
-      "severity": "note"
-    }
-  }
-}
-```
-
-### Configuring Expressions
-
-Some rules have additional attributes to configure, such as the expression, that will overwrite default values. These can be configured in the same way as severity as shown in the following example.
-
-```json
-{
-  "rules": {
-    "APIVersion": {
-      "severity": "error",
-      "expression": "===58" // comparison operator
-    },
-    "FlowName": {
-      "severity": "note",
-      "expression": "[A-Za-z0-9]" // regular expression
-    }
-  }
-}
-```
-
-### Specifying Exceptions
-
-Specifying exceptions allows you to exclude specific scenarios from rule enforcement. Exceptions can be specified at the flow, rule, or result level to provide fine-grained control. Below is a breakdown of the available attributes of exception configuration:
-
-```json
-{
-  "exceptions": {
-    "<FlowName>": {
-      "<RuleName>": [
-        // Suppress a specific result:
-        "<ResultName>",
-        // Suppress ALL results of rule:
-        "*",
-        ...
-      ]
-    },
-    ...
-  }
-}
-```
-
-_Example_
-
-```json
-{
-  "exceptions": {
-    "MyFlow": {
-      "MissingNullHandler": ["*"],
-      "HardcodedId": ["Old_Lookup_1"]
-    }
-  }
-}
-```
-
-### Report Detail Level
-
-Control the verbosity of violation reports via detailLevel. By default (`enriched`), outputs include element or flow-level details like variable data types, node connectors/locations, or attribute expressions for comprehensive reports. Set to `simple` for lighter output with only line and column numbers.
-
-```json
-{
-  "rules": {
-    ...
-  },
-  "exceptions": {
-    ...
-  },
-  "detailLevel": "simple"
-}
-```
-
-### Include Beta Rules
-
-New rules are introduced in Beta mode before being added to the default ruleset. To include current Beta rules, enable the optional betamode parameter in your configuration:
-
-```json
-{
-  "rules": {
-    ...
-  },
-  "exceptions": {
-    ...
-  },
-  "betaMode": true
-}
-
-```
-
----
-
-## Usage
-
-Use `lightning-flow-scanner-core` as a Node.js/browser dependency or standalone UMD module.
-
-### Examples
-
-```js
-// Basic
-import { parse, scan } from "@flow-scanner/lightning-flow-scanner-core";
-parse("flows/*.xml").then(scan);
-
-// Apply available patches
-import { parse, scan, fix } from "@flow-scanner/lightning-flow-scanner-core";
-parse("flows/*.xml").then(scan).then(fix);
-
-// Get SARIF output
-import { parse, scan, exportSarif } from "@flow-scanner/lightning-flow-scanner-core";
-parse("flows/*.xml").then(scan).then(exportSarif); //.then((sarif) => save("results.sarif", sarif));
-
-// Browser Usage (Tooling API)
-const { Flow, scan } = window.lightningflowscanner;
-const metadataRes = await conn.tooling.query(`SELECT Id, FullName, Metadata FROM Flow`);
-const results = scan(
-  metadataRes.records.map((r) => ({
-    uri: `/services/data/v60.0/tooling/sobjects/Flow/${r.Id}`,
-    flow: new Flow(r.FullName, r.Metadata),
-  })) //, optionsForScan
-);
-```
-
-**Privacy:** Zero user data collected. All processing is client-side. → See our [Security Policy](https://github.com/Flow-Scanner/lightning-flow-scanner-core?tab=security-ov-file).
-
-### Functions
-
-#### [`getRules(ruleNames?: string[]): IRuleDefinition[]`](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/libs/GetRuleDefinitions.ts)
-
-_Retrieves rule definitions used in the scanner._
-
-#### [`parse(selectedUris: any): Promise<ParsedFlow[]>`](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/libs/ParseFlows.ts)
-
-_Loads Flow XML files into in-memory models.(Node.js only)_
-
-#### [`scan(parsedFlows: ParsedFlow[], ruleOptions?: IRulesConfig): ScanResult[]`](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/libs/ScanFlows.ts)
-
-_Runs all enabled rules and returns detailed violations._
-
-#### [`fix(results: ScanResult[]): ScanResult[]`](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/libs/FixFlows.ts)
-
-_Automatically applies available fixes(removing variables and unconnected elements)._
-
-#### [`exportSarif(results: ScanResult[]): string`](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/libs/exportAsSarif.ts)
-
-_Get SARIF output including exact line numbers of violations._
-
----
-
-## Installation
-
-[![GitHub stars](https://img.shields.io/github/stars/Flow-Scanner/lightning-flow-scanner-core)](https://img.shields.io/github/stars/Flow-Scanner/lightning-flow-scanner-core)
-[![GitHub contributors](https://img.shields.io/github/contributors/Flow-Scanner/lightning-flow-scanner-core.svg)](https://gitHub.com/Flow-Scanner/lightning-flow-scanner-core/graphs/contributors/)
-[![License](https://img.shields.io/npm/l/lightning-flow-scanner-core.svg)](https://github.com/Flow-Scanner/lightning-flow-scanner-core/raw/main/LICENSE.md)
-[![npm version](https://img.shields.io/npm/v/@flow-scanner/lightning-flow-scanner-core)](https://www.npmjs.com/package/@flow-scanner/lightning-flow-scanner-core)
-[![Known Vulnerabilities](https://snyk.io/test/github/Flow-Scanner/lightning-flow-scanner-core/badge.svg)](https://snyk.io/test/github/Flow-Scanner/lightning-flow-scanner-core)
-
-**To install with npm:**
-
-```bash
-npm install @flow-scanner/lightning-flow-scanner-core
-```
-
----
-
-## Development
-
-> This project optionally uses [Volta](https://volta.sh) to manage Node.js versions. Install Volta with:
->
-> ```sh
-> curl https://get.volta.sh | bash
-> ```
->
-> Volta will automatically use the Node.js version defined in `package.json`.
-
-1. Clone the repository
-
-   ```bash
-   git clone https://github.com/Flow-Scanner/lightning-flow-scanner-core.git
-   ```
-
-2. Install dependencies:
-
-   ```bash
-   npm install
-   ```
-
-3. Compile a new version:
-
-   ```bash
-   npm run build
-   ```
-
-4. Run tests:
-
-   ```bash
-   npm run test
-   ```
-
-5. Testing the module locally(Optional):
-
-   To link the module, run:
-
-   ```bash
-   npm run link
-   ```
-
-   a. Ad-Hoc Testing with node:
-
-   ```bash
-   npm run link
-   ```
-
-   b. Test in a dependent project (e.g. VSX or CLI):
-
-   ```bash
-   npm link @flow-scanner/lightning-flow-scanner-core
-   ```
-
-   Your local module will now replace any installed version and update on rebuild.
-
-6. Deploy Demo Flows (Optional):
-
-   ```bash
-   cd assets/example-flows && sf project deploy start &&
-   ```
-
-   Navigate to the [Demo Readme](assets\example-flows\README.md) for full details
-
-7. Create a standalone UMD Module(Optional):
-
-   ```bash
-     npm run vite:dist // creates UMD at`dist/lightning-flow-scanner-core.umd.js`.
-   ```
-
-<p><strong>Want to help improve Lightning Flow Scanner? See our <a href="https://github.com/Flow-Scanner/lightning-flow-scanner-core?tab=contributing-ov-file">Contributing Guidelines</a></strong></p>
+<p align="center">
+  <a href="https://github.com/Flow-Scanner">
+    <img src="assets/media/banner.png" style="width: 43%;" />
+  </a>
+</p>
+
+<p align="center"><i>Detect unsafe contexts, queries in loops, hardcoded IDs, and more to optimize Salesforce Flows</i></p>
+
+---
+
+## Table of contens
+
+- **[Distributions](#distributions)**
+- **[Default Rules](#default-rules)**
+- **[Configuration](#configuration)**
+  - [Defining Severity Levels](#defining-severity-levels)
+  - [Configuring Expressions](#configuring-expressions)
+  - [Specifying Exceptions](#specifying-exceptions)
+  - [Report Detail Level](#report-detail-level)
+  - [Include Beta Rules](#include-beta-rules)
+- **[Installation](#installation)**
+  - [Salesforce CLI Plugin](#salesforce-cli-plugin)
+  - [Core Module](#core-module)
+  - [CICD Templates](#cicd-templates)
+- **[Quick Start](#quick-start)**
+- **[Development](#development)**
+
+---
+
+## Distributions
+
+| Distribution                        | Best for                                      | Repository                                                                                   | Install / Use                                                                 |
+|-------------------------------------|-----------------------------------------------|----------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------|
+| **Salesforce CLI Plugin**           | Local development, scratch orgs, CI/CD        | [Flow-Scanner/lightning-flow-scanner](https://github.com/Flow-Scanner/lightning-flow-scanner) | `sf plugins install lightning-flow-scanner`                                   |
+| **VS Code Extension**               | Real-time scanning inside VS Code             | [Flow-Scanner/lightning-flow-scanner-vsx](https://github.com/Flow-Scanner/lightning-flow-scanner-vsx)     | `code --install-extension ForceConfigControl.lightning-flow-scanner-vsx`                        |
+| **Salesforce App**                  | Run scans directly inside any Salesforce org  | [Flow-Scanner/lightning-flow-scanner-app](https://github.com/Flow-Scanner/lightning-flow-scanner-app)     |  <a href="https://login.salesforce.com/packaging/installPackage.apexp?p0=04tgK0000007M73QAE"><img alt="Install Managed Package" src="https://raw.githubusercontent.com/afawcett/githubsfdeploy/master/deploy.png"></a>                 |
+| **GitHub Action**                   | Native PR checks                              | [Flow-Scanner/lightning-flow-scanner-action](https://github.com/Flow-Scanner/lightning-flow-scanner-action) | [GitHub Marketplace](https://github.com/marketplace/actions/run-flow-scanner)                        |
+| **Copado Plugin**                   | Copado CI/CD pipelines                        | [Flow-Scanner/lightning-flow-scanner-copado](https://github.com/Flow-Scanner/lightning-flow-scanner-copado) | [Copado Marketplace](https://success.copado.com/s/listing-detail?language=en_US&recordId=a54P7000003G3gBIAS)                                               |
+| **Core Library** (Node.js + Browser)| Custom tools, scripts, extensions, web apps   | [Flow-Scanner/lightning-flow-scanner](https://github.com/Flow-Scanner/lightning-flow-scanner) | `npm install @flow-scanner/lightning-flow-scanner-core`                        |
+
+**Privacy:** Zero user data collected. All processing is client-side. → See our [Security Policy](https://github.com/Flow-Scanner/lightning-flow-scanner?tab=security-ov-file).
+
+## Default Rules
+
+<p>📌<strong>Tip:</strong> To link directly to a specific rule, use the full GitHub anchor link format. Example:</p>
+<p><em><a href="https://github.com/Flow-Scanner/lightning-flow-scanner#unsafe-running-context">https://github.com/Flow-Scanner/lightning-flow-scanner#unsafe-running-context</a></em></p>
+
+> 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)
+
+### Action Calls In Loop
+
+_[ActionCallsInLoop](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/ActionCallsInLoop.ts)_ - To prevent exceeding Apex governor limits, it is advisable to consolidate and bulkify your apex calls, utilizing a single action call containing a collection variable at the end of the loop.
+
+### Outdated API Version
+
+_[APIVersion](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/APIVersion.ts)_ - Introducing newer API components may lead to unexpected issues with older versions of Flows, as they might not align with the underlying mechanics. Starting from API version 50.0, the **Api Version** attribute has been readily available on the Flow Object. To ensure smooth operation and reduce discrepancies between API versions, it is strongly advised to regularly update and maintain them.
+
+### Auto Layout
+
+_[AutoLayout](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/AutoLayout.ts)_ - With Canvas Mode set to Auto‑Layout, elements are spaced, connected, and aligned automatically, keeping your Flow neatly organized—saving you time.
+
+### Copy API Name
+
+_[CopyAPIName](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/CopyAPIName.ts)_ - Maintaining multiple elements with a similar name, like `Copy_X_Of_Element`, can diminish the overall readability of your Flow. When copying and pasting these elements, remember to update the API name of the newly created copy.
+
+### Cyclomatic Complexity
+
+_[CyclomaticComplexity](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/CyclomaticComplexity.ts)_ - The number of loops and decision rules, plus the number of decisions. Use a combination of 1) subflows and 2) breaking flows into multiple concise trigger‑ordered flows to reduce cyclomatic complexity within a single flow, ensuring maintainability and simplicity.
+
+### DML Statement In A Loop
+
+_[DMLStatementInLoop](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/DMLStatementInLoop.ts)_ - To prevent exceeding Apex governor limits, consolidate all your database operations—record creation, updates, or deletions—at the conclusion of the flow.
+
+### Duplicate DML Operation
+
+_[DuplicateDMLOperation](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/DuplicateDMLOperation.ts)_ - When a flow executes database changes or actions between two screens, prevent users from navigating backward between screens; otherwise, duplicate database operations may be performed.
+
+### Flow Naming Convention
+
+_[FlowName](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/FlowName.ts)_ - The readability of a flow is paramount. Establishing a naming convention significantly enhances findability, searchability, and overall consistency. Include at least a domain and a brief description of the flow’s actions, for example `Service_OrderFulfillment`.
+
+### Get Record All Fields
+
+_[GetRecordAllFields](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/GetRecordAllFields.ts)_ - Following the principle of least privilege (PoLP), avoid using **Get Records** with “Automatically store all fields” unless necessary.
+
+### Hardcoded Id
+
+_[HardcodedId](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/HardcodedId.ts)_ - Avoid hard‑coding IDs because they are org specific. Instead, pass them into variables at the start of the flow—via merge‑field URL parameters or a **Get Records** element.
+
+### Hardcoded Url
+
+_[HardcodedUrl](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/HardcodedUrl.ts)_ - Avoid hard‑coding URLs because they are environment specific. Use an `$API` formula (preferred) or environment‑specific sources like custom labels, metadata, or settings.
+
+### Inactive Flow
+
+_[InactiveFlow](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/InactiveFlow.ts)_ - Like cleaning out your closet: deleting unused flows is essential. Inactive flows can still cause trouble—such as accidentally deleting records during testing, or being activated as subflows.
+
+### Missing Fault Path
+
+_[MissingFaultPath](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/MissingFaultPath.ts)_ - A flow may fail to execute an operation as intended. By default, the flow displays an error to the user and emails the creator. Customize this behavior by incorporating a Fault Path.
+
+### Missing Flow Description
+
+_[FlowDescription](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/FlowDescription.ts)_ - Descriptions play a vital role in documentation. We highly recommend including details about where flows are used and their intended purpose.
+
+### Missing Metadata Description
+
+_[MissingMetadataDescription](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/MissingMetadataDescription.ts)_ – Flags Flow elements (Get Records, Assignments, Decisions, Actions, etc.) and metadata components (Variables, Formulas, Constants, Text Templates) that lack a description. Adding concise descriptions greatly improves readability, maintainability, and helps AI tools understand your automation intent.
+
+### Missing Null Handler
+
+_[MissingNullHandler](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/MissingNullHandler.ts)_ - When a **Get Records** operation finds no data, it returns `null`. Validate data by using a Decision element to check for a non‑null result.
+
+### Process Builder
+
+_[ProcessBuilder](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/ProcessBuilder.ts)_ - Salesforce is transitioning away from Workflow Rules and Process Builder in favor of Flow. Begin migrating your organization’s automation to Flow.
+
+### Recursive After Update
+
+_[RecursiveAfterUpdate](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/RecursiveAfterUpdate.ts)_ - After‑update flows are meant for modifying **other** records. Using them on the same record can cause recursion. Consider **before‑save** flows for same‑record updates.
+
+### Same Record Field Updates
+
+_[SameRecordFieldUpdates](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/SameRecordFieldUpdates.ts)_ - Similar to triggers, **before‑save** contexts can update the same record via `$Record` without invoking DML.
+
+### SOQL Query In A Loop
+
+_[SOQLQueryInLoop](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/SOQLQueryInLoop.ts)_ - To prevent exceeding Apex governor limits, consolidate all SOQL queries at the end of the flow.
+
+### Trigger Order
+
+_[TriggerOrder](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/TriggerOrder.ts)_ - Guarantee your flow execution order with the **Trigger Order** property introduced in Spring ’22.
+
+### Unconnected Element
+
+_[UnconnectedElement](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/UnconnectedElement.ts)_ - Avoid unconnected elements that are not used by the flow to keep flows efficient and maintainable.
+
+### Unsafe Running Context
+
+_[UnsafeRunningContext](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/UnsafeRunningContext.ts)_ - This flow is configured to run in **System Mode without Sharing**, granting all users permission to view and edit all data. This can lead to unsafe data access.
+
+### Unused Variable
+
+_[UnusedVariable](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/UnusedVariable.ts)_ - To maintain efficiency and manageability, avoid including variables that are never referenced.
+
+---
+
+## Configuration
+
+It is recommend to configure and define:
+
+- The rules to be executed.
+- The severity of violating any specific rule.
+- Rule properties such as REGEX expressions.
+- Any known exceptions that should be ignored during scanning.
+
+```json
+{
+  "rules": {
+    // Your rules here
+  },
+  "exceptions": {
+    // Your exceptions here
+  }
+}
+```
+
+Most Lightning Flow Scanner distributions automatically resolve configurations from `.flow-scanner.yml`, `.flow-scanner.json`, or `package.json` → `flowScanner`.
+
+Using the rules section of your configurations, you can specify the list of rules to be run. Furthermore, you can define the severity and configure expressions of rules. Below is a breakdown of the available attributes of rule configuration:
+
+```json
+{
+  "rules": {
+    "<RuleName>": {
+      "severity": "<Severity>",
+      "expression": "<Expression>"
+    }
+  }
+}
+```
+
+### Defining Severity Levels
+
+When the severity is not provided it will be `warning` by default. Other available values for severity are `error` and `note`. Define the severity per rule as shown below:
+
+```json
+{
+  "rules": {
+    "FlowDescription": {
+      "severity": "error"
+    },
+    "UnusedVariable": {
+      "severity": "note"
+    }
+  }
+}
+```
+
+### Configuring Expressions
+
+Some rules have additional attributes to configure, such as the expression, that will overwrite default values. These can be configured in the same way as severity as shown in the following example.
+
+```json
+{
+  "rules": {
+    "APIVersion": {
+      "severity": "error",
+      "expression": "===58" // comparison operator
+    },
+    "FlowName": {
+      "severity": "note",
+      "expression": "[A-Za-z0-9]" // regular expression
+    }
+  }
+}
+```
+
+### Specifying Exceptions
+
+Specifying exceptions allows you to exclude specific scenarios from rule enforcement. Exceptions can be specified at the flow, rule, or result level to provide fine-grained control. Below is a breakdown of the available attributes of exception configuration:
+
+```json
+{
+  "exceptions": {
+    "<FlowName>": {
+      "<RuleName>": [
+        // Suppress a specific result:
+        "<ResultName>",
+        // Suppress ALL results of rule:
+        "*",
+        ...
+      ]
+    },
+    ...
+  }
+}
+```
+
+_Example_
+
+```json
+{
+  "exceptions": {
+    "MyFlow": {
+      "MissingNullHandler": ["*"],
+      "HardcodedId": ["Old_Lookup_1"]
+    }
+  }
+}
+```
+
+### Report Detail Level
+
+Control the verbosity of violation reports via detailLevel. By default (`enriched`), outputs include element or flow-level details like variable data types, node connectors/locations, or attribute expressions for comprehensive reports. Set to `simple` for lighter output with only line and column numbers.
+
+```json
+{
+  "rules": {
+    ...
+  },
+  "exceptions": {
+    ...
+  },
+  "detailLevel": "simple"
+}
+```
+
+### Include Beta Rules
+
+New rules are introduced in Beta mode before being added to the default ruleset. To include current Beta rules, enable the optional betamode parameter in your configuration:
+
+```json
+{
+  "rules": {
+    ...
+  },
+  "exceptions": {
+    ...
+  },
+  "betaMode": true
+}
+
+```
+
+## Installation
+
+[![GitHub stars](https://img.shields.io/github/stars/Flow-Scanner/lightning-flow-scanner)](https://img.shields.io/github/stars/Flow-Scanner/lightning-flow-scanner)
+[![GitHub contributors](https://img.shields.io/github/contributors/Flow-Scanner/lightning-flow-scanner.svg)](https://gitHub.com/Flow-Scanner/lightning-flow-scanner/graphs/contributors/)
+[![License](https://img.shields.io/npm/l/lightning-flow-scanner.svg)](github.com/Flow-Scanner/lightning-flow-scanner/raw/main/LICENSE.md)
+
+### Salesforce CLI Plugin
+[![npm](https://img.shields.io/npm/v/lightning-flow-scanner?label=)](https://www.npmjs.com/package/lightning-flow-scanner)
+
+```bash
+sf plugins install lightning-flow-scanner
+```
+OR
+```bash
+npm install -g lightning-flow-scanner
+```
+
+### Core Module
+[![npm](https://img.shields.io/npm/v/@flow-scanner/lightning-flow-scanner-core?label=)](https://www.npmjs.com/package/@flow-scanner/lightning-flow-scanner-core)
+
+```bash
+npm install -g @flow-scanner/lightning-flow-scanner-core
+```
+
+---
+
+### CICD Templates
+Ready-to-use CI/CD templates and a **native GitHub Action**.  
+
+| Platform       | Template Type                     | Link |
+|----------------|-----------------------------------|------|
+| Azure DevOps   | Full Project Scan                 | [`azure-pipelines-flow-FullScan.yml`](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/docs/examples/azure-devops/azure-pipelines-flow-FullScan.yml) |
+| Azure DevOps   | Change-Based Scan                 | [`azure-pipelines-flow-changedFiles.yml`](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/docs/examples/azure-devops/azure-pipelines-flow-changedFiles.yml) |
+| Copado DevOps | Full & Change-Based Scans       | [CI/CD Plugin](https://github.com/Flow-Scanner/lightning-flow-scanner-copado) |
+| GitHub | Full & Change-Based Scans       | [`scan-flows.yml`](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/docs/examples/github-action/scan-flows.yml) |
+
+## Quick Start
+
+### Salesforce CLI Plugin
+
+Use `lightning-flow-scanner` in the Salesforce CLI:
+
+```bash
+sf flow:scan 
+sf flow:fix -d src/force-app
+sf flow:scan --sarif > report.sarif
+```
+
+### Core Module
+Use `lightning-flow-scanner-core` as a Node.js/browser dependency:
+
+```js
+// Basic
+import { parse, scan } from "@flow-scanner/lightning-flow-scanner-core";
+parse("flows/*.xml").then(scan);
+
+// Get SARIF output
+import { parse, scan, exportSarif } from "@flow-scanner/lightning-flow-scanner-core";
+parse("flows/*.xml").then(scan).then(exportSarif);
+```
+
+## Development
+
+> This project optionally uses [Volta](https://volta.sh) to guarantee the exact same Node.js and tool versions for every contributor. Install Volta with:
+>
+> ```sh
+> curl https://get.volta.sh | bash
+> ```
+>
+> ```sh
+> winget install Volta.Volta 
+> ```
+> Volta will automatically lock the exact versions of **Node.js**, **pnpm**, and all tools defined in `package.json`.
+
+1. Clone the repository
+
+   ```bash
+   git clone https://github.com/Flow-Scanner/lightning-flow-scanner.git
+   ```
+
+2. Install dependencies:
+
+   ```bash
+   pnpm install
+   ```
+
+3. Compile:
+
+   ```bash
+   pnpm run build
+   ```
+
+   To compile just the core package::
+   ```bash
+   pnpm build:core 
+   ```
+
+4. Run tests:
+
+   ```bash
+   pnpm test 
+   ```
+
+  Or to test a new version of the core:
+   ```bash
+   pnpm test:core 
+   ```
+
+5. Linking the core module locally(Optional):
+
+   To link the module, run:
+
+   ```bash
+   pnpm link --global @flow-scanner/lightning-flow-scanner-core
+   ```
+
+   You can now do Ad-Hoc Testing with node:
+
+   ```bash
+   node -i -e "import('@flow-scanner/lightning-flow-scanner-core').then(m => { Object.assign(global, m.default ? m.default : m); console.log('✅ Core loaded! Try: await parse(...), scan(...), etc.'); })"
+   ```
+
+   Or test in a dependent project:
+
+   ```bash
+   npm link @flow-scanner/lightning-flow-scanner-core
+   ```
+
+6. Deploy Demo Flows (Optional):
+
+   ```bash
+   cd assets/example-flows && sf project deploy start
+   ```
+
+   Navigate to the [Demo Readme](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/assets/example-flows\README.md) for full details
+
+7. Create a standalone UMD Module(Optional):
+
+   ```bash
+     pnpm dist // creates UMD at`dist/lightning-flow-scanner-core.umd.js`.
+   ```
+
+<p><strong>Want to help improve Lightning Flow Scanner? See our <a href="https://github.com/Flow-Scanner/lightning-flow-scanner?tab=contributing-ov-file">Contributing Guidelines</a></strong></p>