Skip to content

Commit 7eaf9e6

Browse files
committed
implements threshold on sarif
1 parent 9087eca commit 7eaf9e6

File tree

6 files changed

+185
-112
lines changed

6 files changed

+185
-112
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
Since 2021, the _Lightning Flow Scanner_ has grown from its roots as VS Code tool to empower Salesforce Developers across six free and open-source platforms—from developer tools to native Salesforce App—delivering a unified experience for robust static analysis of Flows. Our dedicated community has shared their expertise to deepen understanding of Flow optimization. Your support can amplify our impact. Here’s how you can contribute:
22

3-
- ⭐ Starring the project to show your support
4-
- 📢 Sharing our work with your network
5-
- 💬 Sharing feedback to help us improve
6-
- 💻 Contributing code to drive innovation
3+
- ⭐ Star your favorite platforms
4+
- 📢 Share our work with your network
5+
- 💬 Provide feedback to help us improve
6+
- 💻 Contribute code to drive innovation
7+
- 🤝 [Become a member](https://register.lightningflowscanner.org/) and help sustain the project
78

89
Want to help improve Lightning Flow Scanner? See our [Contributing Guidelines](https://github.com/Flow-Scanner/lightning-flow-scanner-core/blob/main/CONTRIBUTING.md).

README.md

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -32,23 +32,16 @@ sf flow:scan [options]
3232

3333
Customize the scan behavior using the following options:
3434

35-
```sh-session
36-
-c, --config <path> set a path to the configuration file.
37-
38-
-d, --directory <C:\..\force-app\main\default\flows> set a directory to scan.
39-
40-
-f, --failon set a threshold level for failure by error
41-
42-
-p, --files <C:\..\flow1.flow, C:\..\flow2.flow> set a space-separated list of flow paths to scan.
43-
44-
-s, --sarif get SARIF output to the stdout directly
45-
46-
-z, --betamode a runtime toggle to enable beta rules(experimental)
47-
48-
--json set output format as json.
49-
50-
--loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level.
51-
```
35+
| Flag | Alias | Description | Example |
36+
|---------------------|-------|-----------------------------------------------------------------------------|----------------------------------------------|
37+
| `--config` | `-c` | Path to the configuration file | `-c ./lfs.config.json` |
38+
| `--directory` | `-d` | Directory to scan recursively | `-d ./force-app/main/default/flows` |
39+
| `--threshold` | `-f` | Fail the run on errors of this level or higher (`error`\|`warn`\|`info`) | `--threshold warn` |
40+
| `--files` | `-p` | Space-separated list of specific flow files to scan | `-p "flow1.flow-meta.xml" "flows/flow2.flow-meta.xml"` |
41+
| `--sarif` | `-s` | Output results in SARIF format to stdout | `--sarif > results.sarif` |
42+
| `--betamode` | `-z` | Enable experimental beta rules | `--betamode` |
43+
| `--json` | | Output results as pretty-printed JSON | `--json` |
44+
| `--loglevel` | | Logging verbosity<br/>`trace` \| `debug` \| `info` \| `warn` \| `error` \| `fatal` <br/>[default: `warn`] | `--loglevel debug` |
5245

5346
**Privacy:** Zero user data collected. All processing is client-side. → See Data Handling in our [Security Policy](https://github.com/Flow-Scanner/lightning-flow-scanner-cli?tab=security-ov-file).
5447

package-lock.json

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

package.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
"nyc": "17.1.0",
3535
"oclif": "4.22.5",
3636
"prettier": "3.6.2",
37+
"rimraf": "^6.1.0",
3738
"sinon": "21.0.0",
3839
"ts-node": "10.9.2",
3940
"typescript": "5.8.3"
@@ -66,10 +67,11 @@
6667
},
6768
"repository": "https://github.com/Flow-Scanner/lightning-flow-scanner-cli.git",
6869
"scripts": {
69-
"build": "rm -rf lib && tsc -b && oclif manifest && oclif readme",
70+
"build": "rimraf lib && tsc -b && oclif manifest && oclif readme",
7071
"prepack": "npm run build",
7172
"test": "mocha -r ts-node/register test/**/*.test.ts",
72-
"lfs:link": "npm link lightning-flow-scanner-core && npm pack && sf plugins link"
73+
"lfs:link": "npm link lightning-flow-scanner-core && npm pack && sf plugins link",
74+
"clean": "rimraf lib"
7375
},
7476
"type": "module",
7577
"keywords": [

0 commit comments

Comments
 (0)