Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 0 additions & 15 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,20 +59,5 @@
"${workspaceFolder}/out/test/**/*.js"
]
},
{
"name": "ReactiveVSCE Run Extension",
"type": "extensionHost",
"request": "launch",
"args": [
"--extensionDevelopmentPath=${workspaceFolder}"
],
"outFiles": [
"${workspaceFolder}/dist/**/*.js"
],
"env": {
"LFS_USE_REACTIVE_VSCE": "true"
},
"preLaunchTask": "npm: v:dev",
}
]
}
9 changes: 0 additions & 9 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,4 @@
"jest.jestCommandLine": "npm run v:test:reactive --",
"jest.runMode": "on-demand",

"emeraldwalk.runonsave": {
"commands": [
{
"match": "package.json",
"isAsync": true,
"cmd": "npm run v:update"
}
]
},
}
69 changes: 46 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<img src="media/bannerslim.png" style="width: 41%;" />
</a>
</p>
<p align="center">Scans for unsafe contexts, hardcoded IDs, and other issues to optimize your Flows.</p>
<p align="center"><i>Detect unsafe contexts, queries in loops, hardcoded IDs, and more to optimize your Salesforce Flows</i></p>

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

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

## Configuration

| Key | Description | Default Value |
| ----------------------------------------- | --------------------------------------------------------------------------------- | ------------------------------- |
| `lightningFlowScanner.SpecifyFiles` | Specify flow file paths instead of a root directory. | `false` |
| `lightningFlowScanner.NamingConvention` | Specify a REGEX expression to use as Flow Naming convention. | `"[A-Za-z0-9]+_[A-Za-z0-9]+"` |
| `lightningFlowScanner.APIVersion` | Specify an expression to validate the API version, i.e. '===50'(use at least 50). | `">50"` |
| `flowscanner.SpecifyFiles` | Specify flow file paths instead of a root directory. | `false` |
| `flowscanner.NamingConvention` | Specify a REGEX expression to use as Flow Naming convention. | `"[A-Za-z0-9]+_[A-Za-z0-9]+"` |
| `flowscanner.APIVersion` | Specify an expression to validate the API version, i.e. '===50'(use at least 50). | `">50"` |

## Development

Expand All @@ -36,29 +37,51 @@ Use our side bar or the **Command Palette** and type `Flow Scanner` to see the l
>
> Volta will automatically use the Node.js version defined in `package.json`.

1. Clone the repo:
1. **Clone the repository**

```bash
git clone https://github.com/Flow-Scanner/lightning-flow-scanner-vsx.git
```
2. Install dependencies:
```bash
git clone https://github.com/Flow-Scanner/lightning-flow-scanner-vsx.git
```

```bash
npm install
```
3. run dev environment
2. **Install Dependencies**

```
npm run watch
```
4. build vsix
```bash
npm install
```

```
npm run build
```
3. **Build the Project**

## Contributing
```bash
npm run build
```

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.
4. **Watch for Changes**

###### Want to help improve Lightning Flow Scanner? See our [Contributing Guidelines](https://github.com/Flow-Scanner/lightning-flow-scanner-core?tab=contributing-ov-file).
```bash
npm run watch
```

5. **Run End-to-End Tests**

```bash
npm run test
```

6. **Linking** **Core Module (Optional)**

If you’re developing or testing updates to the core module, you can link it locally:

- In the core module directory, run:
```bash
npm run link
```
- In this CLI project directory, run:
```bash
npm link lightning-flow-scanner-core
```

## VSCE to VSX

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.

<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>
7 changes: 0 additions & 7 deletions beta-vscode.tsconfig.json

This file was deleted.

Loading
Loading