Skip to content

Commit 32f3a6a

Browse files
committed
add table of contents
1 parent 5fc4e23 commit 32f3a6a

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,19 @@
66
<p align="center"><i>Detect unsafe contexts, queries in loops, hardcoded IDs, and more to optimize Salesforce Flows</i></p>
77

88
<p align="center">
9-
<img src="media/demo.gif" alt="Flow Overview" width="88%" />
9+
<img src="media/demo.gif" alt="Flow Overview" width="76%" />
1010
</p>
1111

12+
## Table of contents
13+
14+
- **[Usage](#usage)**
15+
- **[Configuration](#configuration)**
16+
- **[Scanner Options](#scanner-options)**
17+
- **[Extension Settings](#extension-settings)**
18+
- **[Development](#development)**
19+
20+
---
21+
1222
## Usage
1323

1424
Use our side bar or the **Command Palette** and type `flowscanner` to see the list of all available commands.
@@ -21,6 +31,8 @@ Use our side bar or the **Command Palette** and type `flowscanner` to see the li
2131
**Privacy:** Zero user data collected. All processing is client-side.
2232
→ See Data Handling in our [Security Policy](https://github.com/Flow-Scanner/lightning-flow-scanner-vsx?tab=security-ov-file).
2333

34+
---
35+
2436
## Configuration
2537

2638
It is recommended to set up a `.flow-scanner.yml` and define:
@@ -30,6 +42,8 @@ It is recommended to set up a `.flow-scanner.yml` and define:
3042
- Rule properties such as REGEX expressions.
3143
- Any known exceptions that should be ignored during scanning.
3244

45+
### Scanner Options
46+
3347
```json
3448
{
3549
"rules": {
@@ -118,9 +132,10 @@ If you’re developing or testing updates to the core module, you can link it lo
118132
npm link @flow-scanner/lightning-flow-scanner-core
119133
```
120134

135+
---
136+
121137
## VSCE to VSX
122138

123139
The `lightning-flow-scanner-vsce` package was unpublished from the Visual Studio and Open VSX Marketplaces due to a vulnerability stemming from unsafe rule loading. The issue was addressed in [core library v5](https://github.com/Flow-Scanner/lightning-flow-scanner-core/releases/tag/v5.1.0). This fork, created on 22/09/2025, emphasizes security and maintainability.
124140

125141
<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>
126-
<!-- force-contributors-render: 2025-10-28 22:10:01 -->

0 commit comments

Comments
 (0)