Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Lightning-Flow-Scanner/lightning-flow-scanner-sfdx
A Salesforce CLI Plugin that can perform static analysis on Salesforce Flows and identify violations of industry best practices.
https://github.com/Lightning-Flow-Scanner/lightning-flow-scanner-sfdx
cicd linter quality salesforce-flows salesforcedx salesforcedx-plugin
Last synced: about 1 month ago
JSON representation
A Salesforce CLI Plugin that can perform static analysis on Salesforce Flows and identify violations of industry best practices.
- Host: GitHub
- URL: https://github.com/Lightning-Flow-Scanner/lightning-flow-scanner-sfdx
- Owner: Lightning-Flow-Scanner
- License: agpl-3.0
- Created: 2021-06-24T18:59:57.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-16T23:30:37.000Z (8 months ago)
- Last Synced: 2024-05-01T14:52:14.186Z (8 months ago)
- Topics: cicd, linter, quality, salesforce-flows, salesforcedx, salesforcedx-plugin
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/lightning-flow-scanner
- Size: 4 MB
- Stars: 103
- Watchers: 8
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-sfdx-plugins - lightning-flow-scanner - Flow-Scanner)) (Community supported plugins)
README
[](https://github.com/Lightning-Flow-Scanner)
__*Pinpoint deviations from Industry Best Practices in Salesforce Flows, ensuring standards of business automation excellence*__
**Also available as [VS Code Extension](https://github.com/Lightning-Flow-Scanner/lightning-flow-scanner-vsce)*
## Table of contents
- [Installation](#installation)
- [Usage](#usage)
- [Options](#options)
- [Examples](#examples)
- [Configuration](#configuration)
- [Defining the severity per rule](#defining-the-severity-per-rule)
- [Specifying an exception](#specifying-an-exception)
- [Configuring an expression](#configuring-an-expression)
- [Loading Custom Rules](#loading-custom-rules)
- [Development Setup](#development-setup)
## Installation
Install with SFDX:
```sh-session
sfdx plugins:install lightning-flow-scanner
```
Install with NPM:
```sh-session
npm install -g lightning-flow-scanner
```
## Usage
```sh-session
sfdx flow:scan [options]
```
***To learn more about the default rules and options, see the [core documentation](https://lightning-flow-scanner.github.io/lightning-flow-scanner-core/).***
### Options
```sh-session
-c, --config provide a path to the configuration file.
-f, --failon provide a threshold level for returning status 1
-p, --sourcepath provide a comma-separated list of flow paths to scan.
-u, --targetusername retrieve the latest metadata from the target before the scan.
-d, --directory provide a directory to scan.
--json set output format as json.
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level.
```
### Examples
You can test the scanner by simply opening an existing project that contains flows and running the scan without any configurations or parameters. This way all the default rules are autmatically included in the scan.
```sh-sessions
sfdx flow:scan
```
```sh-sessions
sfdx flow:scan --json
```
```sh-sessions
sfdx flow:scan --config path/to/.flow-scanner.json
```
## Configuration
Create a .flow-scanner.json file in order to configure:
- The ruleset to be executed.
- The severity of violating any specific rule.
- Custom expressions or rule implementations.
- Any known exceptions that should be ignored during scanning.
```json
{
"rules": {
...
},
"exceptions": {
...
}
}
```
_Note: if you prefer YAML format, you can create a `.flow-scanner.yml` file using the same format._
### Defining the severity per rule
When the severity is not provided it will be `error` by default. Other available values for severity are `warning` and `note`. Define the severity per rule as shown in the following example.
```json
{
"rules": {
"FlowDescription": {
"severity": "warning"
},
"UnusedVariable": {
"severity": "error"
}
}
}
```
### Specifying an exception
Specifying exceptions can be done by flow, rule and result(s), as shown in the following example.
```json
{
"exceptions": {
"AssignTaskOwner": {
"UnusedVariable": [
"somecount"
]
},
"GetAccounts":{
"UnusedVariable": [
"incvar"
]
}
}
}
```
### Configuring an expression
Some rules have additional attributes to configure, such as the expression, that will overwrite default values. These can be configured in the same way as severity as shown in the following example.
```json
{
"rules": {
"APIVersion":
{
"severity": "error",
"expression": "===58"
},
"FlowName":
{
"severity": "error",
"expression": "[A-Za-z0-9]"
}
}
}
```
### Loading Custom Rules
To load custom rules using the Lightning Flow Scanner Core, you can utilize the `path` attribute within the rules section of your configurations. This attribute allows you to specify the path to your custom rule class, enabling seamless integration of organization-specific rule definitions into the scanner's ruleset.
```json
{
"rules": {
"": {
"path": ""
}
}
}
```
Custom Rules can either leverage our Flow compiler or be completely customized typescript functions.
For more details and examples on custom rules, refer to our [Custom Rule Creation Guide](https://github.com/Lightning-Flow-Scanner/lightning-flow-scanner-core/tree/master/docs/customruleguide.md)
## Development Setup
### Preparing for Changes
1. **Clone Project**: Clone the Lightning Flow Scanner SFDX plugin project from the repository.
2. **Install Dependencies**: Open the directory and run `npm install` or `yarn install` in the terminal to install the necessary dependencies.
3. **Optional: Make changes**: For example, if you want to upgrade the core module using npm, you can use the command: `npm update lightning-flow-scanner-core`
4. **Prepack**: Execute `npm run prepack` to build the plugin locally and prepare for packaging.
5. **Link Plugin**: Link the plugin to your Salesforce DX environment using `sfdx plugins link .`.
### Debugging the Plugin
1. **Linking Core Module**: You may need to clone and link the `lightning-flow-scanner-core` locally to your project. This step is necessary if you're making changes to the core module and want those changes reflected in the plugin. You can link the core module by navigating to its directory and running:
```bash
npm link
```
Then, navigate to the sfdx plugin directory and run:
```bash
npm link lightning-flow-scanner-core
```
1. **Run Plugin**: In the terminal of your example flow project (or any other project intended for scanning), run the following command to start the plugin with debugging enabled:
```bash
NODE_OPTIONS=--inspect-brk /path/to/lightning-flow-scanner-sfdx/bin/run flow:scan
```
2. **Attach Debugger**: Open your local Salesforce DX project in Visual Studio Code, set desired breakpoints, and attach the debugger to the remote session.
For more detailed information, you can refer to the [wiki](https://github.com/salesforcecli/cli/wiki) of the Salesforce CLI repository.