![\"GitHub](\"https://img.shields.io/github/stars/Flow-Scanner/lightning-flow-scanner?label=Stargazers&style=flat-square\")
\n \n \n ![\"Core](\"https://img.shields.io/npm/v/@flow-scanner/lightning-flow-scanner-core?label=Core&style=flat-square\")
\n \n \n ![\"CLI](\"https://img.shields.io/npm/v/lightning-flow-scanner?label=CLI&style=flat-square\")
\n \n \n ![\"Downloads](\"https://img.shields.io/npm/dt/lightning-flow-scanner-core?label=Downloads%3Cv6&style=flat-square\")
\n\n\n ![\"Downloads](\"https://img.shields.io/npm/dt/@flow-scanner/lightning-flow-scanner-core?label=Downloads%3Ev6&style=flat-square\")
v6\">\n\n\n \n \n\n \n
\n \n ![\"Lightning](\"https://raw.githubusercontent.com/Flow-Scanner/Lightning-Flow-Scanner/main/docs/media/banner.png\")
\n \n
Detect unsafe contexts, queries in loops, hardcoded IDs, and more to optimize Salesforce Flows
\n\nAlso available in the Salesforce Inspector Reloaded extension and OrgCheck app
\n\n---\n\n## Table of contents\n\n- **[Default Rules](#default-rules)**\n - [Problems](#problems)\n - [Suggestions](#suggestions)\n - [Layout](#layout)\n- **[Configuration](#configuration)**\n - [Configure Rules](#configure-rules)\n - [Define Exceptions](#define-exceptions)\n - [Exclude Flows](#exclude-flows)\n - [Scan Options](#scan-options)\n- **[Installation](#installation)**\n - [Distributions](#distributions)\n - [CICD Templates](#cicd-templates)\n- **[Quick Start](#quick-start)**\n- **[Development](#development)**\n\n---\n\n## Default Rules\n\nπTip: To link directly to a specific rule, use the full GitHub anchor link format. Example:
\nhttps://flow-scanner.github.io/lightning-flow-scanner/#unsafe-running-context
\n\n> Want to help improve this project? See our [Contributing Guidelines](https://github.com/Flow-Scanner/lightning-flow-scanner?tab=contributing-ov-file)\n\n\n\n---\n\n### Problems\n\nThese rules detect anti-patterns and unsafe practices in your Flows that could break functionality, compromise security, or cause deployment failures.\n\n#### DML Statement In A Loop\nExecuting 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.\n\n**Rule ID:** `dml-in-loop`\n**Class Name:** _[DMLStatementInLoop](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/DMLStatementInLoop.ts)_\n**Severity:** π΄ *Error*\n\n#### Hardcoded Id\nAvoid 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.\n\n**Rule ID:** `hardcoded-id`\n**Class Name:** _[HardcodedId](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/HardcodedId.ts)_\n**Severity:** π΄ *Error*\n\n#### Hardcoded Secret \nAvoid hardcoding secrets, API keys, tokens, or credentials in Flows. These should be stored securely in Named Credentials, Custom Settings, Custom Metadata, or external secret management systems.\n\n**Rule ID:** `hardcoded-secret`\n**Class Name:** _[HardcodedSecret](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/HardcodedSecret.ts)_\n**Severity:** π΄ *Error*\n\n#### Hardcoded Url\nAvoid 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.\n\n**Rule ID:** `hardcoded-url`\n**Class Name:** _[HardcodedUrl](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/HardcodedUrl.ts)_\n**Severity:** π΄ *Error*\n\n#### Process Builder\nProcess Builder is retired. Continuing to use it increases maintenance overhead and risks future compatibility issues. Migrating automation to Flow reduces risk and improves maintainability.\n\n**Rule ID:** `process-builder-usage`\n**Class Name:** _[ProcessBuilder](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/ProcessBuilder.ts)_\n**Severity:** π΄ *Error*\n\n#### SOQL Query In A Loop\nRunning 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.\n\n**Rule ID:** `soql-in-loop`\n**Class Name:** _[SOQLQueryInLoop](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/SOQLQueryInLoop.ts)_\n**Severity:** π΄ *Error*\n\n#### Unsafe Running Context\nFlows 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.\n\n**Rule ID:** `unsafe-running-context`\n**Class Name:** _[UnsafeRunningContext](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/UnsafeRunningContext.ts)_\n**Severity:** π΄ *Error*\n\n#### Duplicate DML Operation\nWhen 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.\n\n**Rule ID:** `duplicate-dml`\n**Class Name:** _[DuplicateDMLOperation](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/DuplicateDMLOperation.ts)_\n**Severity:** π‘ *Warning*\n\n#### Missing Fault Path\nElements 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.\n\n**Rule ID:** `missing-fault-path`\n**Class Name:** _[MissingFaultPath](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/MissingFaultPath.ts)_\n**Severity:** π‘ *Warning*\n\n#### Missing Null Handler\nGet 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.\n\n**Rule ID:** `missing-null-handler`\n**Class Name:** _[MissingNullHandler](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/MissingNullHandler.ts)_\n**Severity:** π‘ *Warning*\n\n#### Recursive After Update\nAfter-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.\n\n**Rule ID:** `recursive-record-update`\n**Class Name:** _[RecursiveAfterUpdate](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/RecursiveAfterUpdate.ts)_\n**Severity:** π‘ *Warning*\n\n---\n\n### Suggestions\n\nThese rules highlight areas where Flows can be improved. Following them increases reliability and long-term maintainability.\n\n#### Action Call In A Loop\nRepeatedly 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.\n\n**Rule ID:** `action-call-in-loop`\n**Class Name:** _[ActionCallsInLoop](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/ActionCallsInLoop.ts)_\n**Severity:** π‘ *Warning*\n\n#### Get Record All Fields\nAvoid using Get Records to retrieve all fields unless necessary. This improves performance, reduces processing time, and limits exposure of unnecessary data.\n\n**Rule ID:** `get-record-all-fields`\n**Class Name:** _[GetRecordAllFields](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/GetRecordAllFields.ts)_\n**Severity:** π‘ *Warning*\n\n#### Inactive Flow\nInactive 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.\n\n**Rule ID:** `inactive-flow`\n**Class Name:** _[InactiveFlow](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/InactiveFlow.ts)_\n**Severity:** π‘ *Warning*\n\n#### Invalid API Version \nFlows 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.\n\n**Rule ID:** `invalid-api-version`\n**Class Name:** _[APIVersion](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/APIVersion.ts)_\n**Severity:** π‘ *Warning*\n\n| Option | Type | Default | Description |\n|--------|------|---------|-------------|\n| expression | expression | `>= 50` | Comparison expression for API version (e.g., `>= 58`, `< 50`, `=== 60`) |\n\n\n#### Missing Filter Record Trigger \nRecord-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.\n\n**Rule ID:** `missing-record-trigger-filter`\n**Class Name:** _[MissingFilterRecordTrigger](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/MissingFilterRecordTrigger.ts)_\n**Severity:** π‘ *Warning*\n\n#### Same Record Field Updates\nBefore-save Flows can safely update the triggering record directly via $Record, applying changes efficiently without extra DML operations. Using before-save updates improves performance\n\n**Rule ID:** `same-record-field-updates`\n**Class Name:** _[SameRecordFieldUpdates](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/SameRecordFieldUpdates.ts)_\n**Severity:** π‘ *Warning*\n\n#### Cognitive Complexity \nFlows with deeply nested loops and decisions are hard to understand. Unlike cyclomatic complexity which counts paths, cognitive complexity penalizes nesting depth. Consider extracting nested logic into subflows.\n\n**Rule ID:** `cognitive-complexity`\n**Class Name:** _[CognitiveComplexity](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/CognitiveComplexity.ts)_\n**Severity:** π΅ *Note*\n\n| Option | Type | Default | Description |\n|--------|------|---------|-------------|\n| threshold | number | `15` | Maximum cognitive complexity score before triggering a violation |\n\n\n#### Excessive Cyclomatic Complexity\nHigh 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.\n\n**Rule ID:** `excessive-cyclomatic-complexity`\n**Class Name:** _[CyclomaticComplexity](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/CyclomaticComplexity.ts)_\n**Severity:** π΅ *Note*\n\n| Option | Type | Default | Description |\n|--------|------|---------|-------------|\n| threshold | number | `25` | Maximum cyclomatic complexity score before triggering a violation |\n\n\n#### Missing Trigger Order\nRecord-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.\n\n**Rule ID:** `unspecified-trigger-order`\n**Class Name:** _[TriggerOrder](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/TriggerOrder.ts)_\n**Severity:** π΅ *Note*\n\n#### Record ID as String \nFlows 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.\n\n**Rule ID:** `record-id-as-string`\n**Class Name:** _[RecordIdAsString](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/RecordIdAsString.ts)_\n**Severity:** π΅ *Note*\n\n#### Transform Instead of Loop \nLoop 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.\n\n**Rule ID:** `transform-instead-of-loop`\n**Class Name:** _[TransformInsteadOfLoop](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/TransformInsteadOfLoop.ts)_\n**Severity:** π΅ *Note*\n\n---\n\n### Layout\n\nFocused on naming, documentation, and organization, these rules ensure Flows remain clear, easy to understand, and maintainable as automations grow.\n\n#### Flow Naming Convention\nUsing 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.\n\n**Rule ID:** `invalid-naming-convention`\n**Class Name:** _[FlowName](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/FlowName.ts)_\n**Severity:** π΄ *Error*\n\n| Option | Type | Default | Description |\n|--------|------|---------|-------------|\n| expression | expression | `[A-Za-z0-9]+_[A-Za-z0-9]+` | Regex pattern for valid Flow names |\n\n\n#### Missing Flow Description\nFlow descriptions are essential for documentation and maintainability. Include a description for each Flow, explaining its purpose and where it's used.\n\n**Rule ID:** `missing-flow-description`\n**Class Name:** _[FlowDescription](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/FlowDescription.ts)_\n**Severity:** π΄ *Error*\n\n#### Missing Metadata Description \nElements and metadata without a description reduce clarity and maintainability. Adding descriptions improves readability and makes your automation easier to understand.\n\n**Rule ID:** `missing-metadata-description`\n**Class Name:** _[MissingMetadataDescription](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/MissingMetadataDescription.ts)_\n**Severity:** π‘ *Warning*\n\n#### Unclear API Name\nElements 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.\n\n**Rule ID:** `unclear-api-naming`\n**Class Name:** _[CopyAPIName](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/CopyAPIName.ts)_\n**Severity:** π‘ *Warning*\n\n#### Unreachable Element \nUnconnected elements never execute and add unnecessary clutter. Remove or connect unused Flow elements to keep Flows clean and efficient.\n\n**Rule ID:** `unreachable-element`\n**Class Name:** _[UnconnectedElement](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/UnconnectedElement.ts)_\n**Severity:** π‘ *Warning*\n\n#### Unused Variable \nUnused variables are never referenced and add unnecessary clutter. Remove them to keep Flows efficient and easy to maintain.\n\n**Rule ID:** `unused-variable`\n**Class Name:** _[UnusedVariable](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/UnusedVariable.ts)_\n**Severity:** π‘ *Warning*\n\n#### Missing Auto Layout \nAuto-Layout automatically arranges and aligns Flow elements, keeping the canvas organized and easier to maintain. Enabling it saves time and improves readability.\n\n**Rule ID:** `missing-auto-layout`\n**Class Name:** _[AutoLayout](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core/src/main/rules/AutoLayout.ts)_\n**Severity:** π΅ *Note*\n\n#### System (subcategory)\n\nSystem rules are a subset of Layout rules that detect structural issues normally prevented by the Flow Builder UI. See [System Rules Documentation](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/docs/system-rules.md) for the full list.\n\n\n---\n\n## Configuration\n\nIt is recommend to configure and define:\n\n- The severity of violating any specific rule.\n- Expressions used for rules, such as REGEX patterns and comparison operators.\n- Any known exceptions that should be ignored during scanning.\n- (Optional) Implement filters based on a severity **threshold** or **rule categories**.\n\nMost distributions automatically load configuration from: \n- `.flow-scanner.yml` \n- `.flow-scanner.json` \n- `package.json` β `\"flowScanner\"` key\n\n```json\n{\n \"rules\": {\n // rule customizations (severity, expression, enabled, ...)\n },\n \"exceptions\": {\n // flow β rule β result suppressions\n },\n \"threshold\": \"error\", // only consider errors\n \"categories\": [\"problem\", \"layout\"] // only run rules from these categories\n}\n```\n\n### Configure Rules\n\nBy default, all default rules are executed. You can customize individual rules and override the rules to be executed without having to specify every rule. Below is a breakdown of the available attributes of rule configuration:\n\n```json\n{\n \"rules\": {\n \"