|
6 | 6 |
|
7 | 7 | <p align="center"><i>Detect unsafe contexts, queries in loops, hardcoded IDs, and more to optimize Salesforce Flows</i></p> |
8 | 8 |
|
| 9 | +[](https://img.shields.io/github/stars/Flow-Scanner/lightning-flow-scanner) |
| 10 | +[](https://gitHub.com/Flow-Scanner/lightning-flow-scanner/graphs/contributors/) |
| 11 | +[](github.com/Flow-Scanner/lightning-flow-scanner/raw/main/LICENSE.md) |
| 12 | +[](https://www.npmjs.com/package/@flow-scanner/lightning-flow-scanner-core) |
| 13 | +[](https://www.npmjs.com/package/lightning-flow-scanner) |
| 14 | +[](https://marketplace.visualstudio.com/items?itemName=ForceConfigControl.lightning-flow-scanner-vsx) |
| 15 | +[](https://open-vsx.org/extension/ForceConfigControl/lightning-flow-scanner-vsx) |
| 16 | + |
9 | 17 | --- |
10 | 18 |
|
11 | 19 | ## Table of contens |
12 | 20 |
|
13 | | -- **[Distributions](#distributions)** |
14 | 21 | - **[Default Rules](#default-rules)** |
15 | 22 | - **[Configuration](#configuration)** |
16 | 23 | - [Defining Severity Levels](#defining-severity-levels) |
17 | 24 | - [Configuring Expressions](#configuring-expressions) |
18 | 25 | - [Specifying Exceptions](#specifying-exceptions) |
19 | 26 | - [Include Beta Rules](#include-beta-rules) |
20 | 27 | - **[Installation](#installation)** |
21 | | - - [Salesforce CLI Plugin](#salesforce-cli-plugin) |
22 | | - - [Core Module](#core-module) |
| 28 | + - [Distributions](#distributions) |
23 | 29 | - [CICD Templates](#cicd-templates) |
24 | 30 | - **[Quick Start](#quick-start)** |
25 | 31 | - **[Development](#development)** |
26 | 32 |
|
27 | 33 | --- |
28 | 34 |
|
29 | | -## Distributions |
30 | | - |
31 | | -| Distribution | Best for | Install / Use | |
32 | | -|----------------------------------------------------------------|-----------------------------------------------|---------------------------------------------------------------------------------------------------------| |
33 | | -| **[Salesforce CLI Plugin](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/cli/README.md)** | Local development, scratch orgs, CI/CD | `sf plugins install lightning-flow-scanner` | |
34 | | -| **[VS Code Extension](https://github.com/Flow-Scanner/lightning-flow-scanner-vsx)** | Real-time scanning inside VS Code | `code --install-extension ForceConfigControl.lightning-flow-scanner-vsx` | |
35 | | -| **[Salesforce App (Managed Package)](https://github.com/Flow-Scanner/lightning-flow-scanner-app)** | Run scans directly inside a Salesforce org | `sf package install --package 04tgK0000007M73QAE` | |
36 | | -| **[Core Library](https://github.com/Flow-Scanner/lightning-flow-scanner/tree/main/packages/core)** (Node.js + Browser) | Custom tools, scripts, extensions, web apps | `npm install -g @flow-scanner/lightning-flow-scanner-core` | |
37 | | - |
38 | | -**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). |
39 | | - |
40 | 35 | ## Default Rules |
41 | 36 |
|
42 | 37 | <p>📌<strong>Tip:</strong> To link directly to a specific rule, use the full GitHub anchor link format. Example:</p> |
@@ -260,29 +255,16 @@ New rules are introduced in Beta mode before being added to the default ruleset. |
260 | 255 |
|
261 | 256 | ## Installation |
262 | 257 |
|
263 | | -[](https://img.shields.io/github/stars/Flow-Scanner/lightning-flow-scanner) |
264 | | -[](https://gitHub.com/Flow-Scanner/lightning-flow-scanner/graphs/contributors/) |
265 | | -[](github.com/Flow-Scanner/lightning-flow-scanner/raw/main/LICENSE.md) |
266 | | - |
267 | | -### Salesforce CLI Plugin |
268 | | -[](https://www.npmjs.com/package/lightning-flow-scanner) |
| 258 | +### Distributions |
269 | 259 |
|
270 | | -```bash |
271 | | -sf plugins install lightning-flow-scanner |
272 | | -``` |
273 | | -OR |
274 | | -```bash |
275 | | -npm install -g lightning-flow-scanner |
276 | | -``` |
277 | | - |
278 | | -### Core Module |
279 | | -[](https://www.npmjs.com/package/@flow-scanner/lightning-flow-scanner-core) |
280 | | - |
281 | | -```bash |
282 | | -npm install -g @flow-scanner/lightning-flow-scanner-core |
283 | | -``` |
| 260 | +| Distribution | Best for | Install / Use | |
| 261 | +|----------------------------------------------------------------|-----------------------------------------------|---------------------------------------------------------------------------------------------------------| |
| 262 | +| **[Salesforce CLI Plugin](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/cli/README.md)** | Local development, scratch orgs, CI/CD | `sf plugins install lightning-flow-scanner` | |
| 263 | +| **[VS Code Extension](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/vsx/README.md)** | Real-time scanning inside VS Code | `code --install-extension ForceConfigControl.lightning-flow-scanner-vsx` | |
| 264 | +| **[Salesforce App (Managed Package)](https://github.com/Flow-Scanner/lightning-flow-scanner-app)** | Run scans directly inside a Salesforce org | `sf package install --package 04tgK0000007M73QAE` | |
| 265 | +| **[Core Library](https://github.com/Flow-Scanner/lightning-flow-scanner/tree/main/packages/core)** (Node.js + Browser) | Custom tools, scripts, extensions, web apps | `npm install -g @flow-scanner/lightning-flow-scanner-core` | |
284 | 266 |
|
285 | | ---- |
| 267 | +**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). |
286 | 268 |
|
287 | 269 | ### CICD Templates |
288 | 270 | Ready-to-use CI/CD templates and a **native GitHub Action**. |
|
0 commit comments