Skip to content

Commit dd07037

Browse files
committed
update readme
1 parent ae4e1f8 commit dd07037

File tree

2 files changed

+46
-23
lines changed

2 files changed

+46
-23
lines changed

README.md

Lines changed: 43 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<img src="media/bannerslim.png" style="width: 41%;" />
44
</a>
55
</p>
6-
<p align="center">Scans for unsafe contexts, hardcoded IDs, and other issues to optimize your Flows.</p>
6+
<p align="center"><i>Detect unsafe contexts, queries in loops, hardcoded IDs, and more to optimize your Salesforce Flows</i></p>
77

88
<p align="center">
99
<img src="media/demo.gif" alt="Flow Overview" width="88%" />
@@ -15,6 +15,7 @@ Use our side bar or the **Command Palette** and type `Flow Scanner` to see the l
1515

1616
* `Configure Rules` Allows to define rules and expressions as per defined in the [core documentation](https://github.com/Flow-Scanner/lightning-flow-scanner-core).
1717
* `Scan Flows` allows choosing either a directory or a selection of flows to run the analysis against.
18+
* `Calc Coverage` calculates the test coverage of Flows in the default org.
1819
* `Fix Flows` will apply available fixes automatically.
1920
* `Open Documentation` can be used to reference the documentation.
2021

@@ -36,29 +37,51 @@ Use our side bar or the **Command Palette** and type `Flow Scanner` to see the l
3637
>
3738
> Volta will automatically use the Node.js version defined in `package.json`.
3839
39-
1. Clone the repo:
40+
1. **Clone the repository**
4041
41-
```bash
42-
git clone https://github.com/Flow-Scanner/lightning-flow-scanner-vsx.git
43-
```
44-
2. Install dependencies:
42+
```bash
43+
git clone https://github.com/Flow-Scanner/lightning-flow-scanner-vsx.git
44+
```
4545
46-
```bash
47-
npm install
48-
```
49-
3. run dev environment
46+
2. **Install Dependencies**
5047

51-
```
52-
npm run watch
53-
```
54-
4. build vsix
48+
```bash
49+
npm install
50+
```
5551

56-
```
57-
npm run build
58-
```
52+
3. **Build the Project**
5953

60-
## Contributing
54+
```bash
55+
npm run build
56+
```
6157

62-
The original `lightning-flow-scanner-vsce` package was unpublished from the Visual Studio Marketplace after a Remote Code Execution (RCE) vulnerability was identified in its core dependency, `lightning-flow-scanner-core`. This issue, caused by unsafe custom rule loading, has been fully resolved in the [v5.1.0 release of the core library](https://github.com/Flow-Scanner/lightning-flow-scanner-core/releases/tag/v5.1.0). The [lightning-flow-scanner-vsx](https://github.com/Flow-Scanner/lightning-flow-scanner-vsx) fork, focusses on security and maintainability.
58+
4. **Watch for Changes**
6359

64-
###### Want to help improve Lightning Flow Scanner? See our [Contributing Guidelines](https://github.com/Flow-Scanner/lightning-flow-scanner-core?tab=contributing-ov-file).
60+
```bash
61+
npm run watch
62+
```
63+
64+
5. **Run End-to-End Tests**
65+
66+
```bash
67+
npm run wdio-test
68+
```
69+
70+
6. **Linking** **Core Module (Optional)**
71+
72+
If you’re developing or testing updates to the core module, you can link it locally:
73+
74+
- In the core module directory, run:
75+
```bash
76+
npm run link
77+
```
78+
- In this CLI project directory, run:
79+
```bash
80+
npm link lightning-flow-scanner-core
81+
```
82+
83+
## VSCE to VSX
84+
85+
The `lightning-flow-scanner-vsce` package was unpublished from the Visual Studio and Open VSX Marketplaces due to a vulnerability in `lightning-flow-scanner-core`, stemming from unsafe rule loading. This issue was addressed in [v5 of the core library](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.
86+
87+
<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>

package-lock.json

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)