@flow-scanner/lightning-flow-scanner-core 6.10.0 → 6.10.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -25
- package/package.json +1 -1
- /package/{assets → docs}/media/banner.png +0 -0
package/README.md
CHANGED
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
|
|
25
25
|
<p align="center">
|
|
26
26
|
<a href="https://github.com/Flow-Scanner">
|
|
27
|
-
<img src="https://raw.githubusercontent.com/Flow-Scanner/Lightning-Flow-Scanner/main/
|
|
27
|
+
<img src="https://raw.githubusercontent.com/Flow-Scanner/Lightning-Flow-Scanner/main/docs/media/banner.png" alt="Lightning Flow Scanner" width="43%" />
|
|
28
28
|
</a>
|
|
29
29
|
</p>
|
|
30
30
|
|
|
@@ -227,11 +227,9 @@ Some rules have additional attributes to configure, such as the expression, that
|
|
|
227
227
|
{
|
|
228
228
|
"rules": {
|
|
229
229
|
"APIVersion": {
|
|
230
|
-
"severity": "error",
|
|
231
230
|
"expression": "===58" // comparison operator
|
|
232
231
|
},
|
|
233
232
|
"FlowName": {
|
|
234
|
-
"severity": "note",
|
|
235
233
|
"expression": "[A-Za-z0-9]" // regular expression
|
|
236
234
|
}
|
|
237
235
|
}
|
|
@@ -247,10 +245,8 @@ Specifying exceptions allows you to exclude specific scenarios from rule enforce
|
|
|
247
245
|
"exceptions": {
|
|
248
246
|
"<FlowName>": {
|
|
249
247
|
"<RuleName>": [
|
|
250
|
-
// Suppress a
|
|
251
|
-
"
|
|
252
|
-
// Suppress ALL results of rule:
|
|
253
|
-
"*",
|
|
248
|
+
"<ResultName>", // Suppress a result
|
|
249
|
+
"*", // Wildcard to suppress all results
|
|
254
250
|
...
|
|
255
251
|
]
|
|
256
252
|
},
|
|
@@ -265,8 +261,8 @@ _Example_
|
|
|
265
261
|
{
|
|
266
262
|
"exceptions": {
|
|
267
263
|
"MyFlow": {
|
|
268
|
-
"MissingNullHandler": ["*"],
|
|
269
264
|
"HardcodedId": ["Old_Lookup_1"]
|
|
265
|
+
"MissingNullHandler": ["*"],
|
|
270
266
|
}
|
|
271
267
|
}
|
|
272
268
|
}
|
|
@@ -288,15 +284,7 @@ New rules are introduced in Beta mode before being added to the default ruleset.
|
|
|
288
284
|
By default, Lightning Flow Scanner runs **all** default rules and merges any custom configurations you provide. This means you can override specific rules without having to list every rule to be executed. If instead, you want to run **only** the rules you explicitly specify, use `"ruleMode": "isolated"`:
|
|
289
285
|
```json
|
|
290
286
|
{
|
|
291
|
-
"ruleMode": "isolated"
|
|
292
|
-
"rules": {
|
|
293
|
-
"FlowName": {
|
|
294
|
-
"severity": "error"
|
|
295
|
-
},
|
|
296
|
-
"HardcodedId": {
|
|
297
|
-
"severity": "error"
|
|
298
|
-
}
|
|
299
|
-
}
|
|
287
|
+
"ruleMode": "isolated"
|
|
300
288
|
}
|
|
301
289
|
```
|
|
302
290
|
|
|
@@ -310,7 +298,7 @@ By default, Lightning Flow Scanner runs **all** default rules and merges any cus
|
|
|
310
298
|
| **[Salesforce CLI Plugin](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/cli/README.md)** | Local development, scratch orgs, CI/CD | `sf plugins install lightning-flow-scanner` |
|
|
311
299
|
| **[VS Code Extension](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/vsx/README.md)** | Real-time scanning inside VS Code | `code --install-extension ForceConfigControl.lightning-flow-scanner-vsx` |
|
|
312
300
|
| **[Salesforce App (Managed Package)](https://github.com/Flow-Scanner/lightning-flow-scanner-app)** | Run scans directly inside a Salesforce org | `sf package install --package 04tgK0000007M73QAE` |
|
|
313
|
-
| **[Core Library](https://github.com/Flow-Scanner/lightning-flow-scanner/
|
|
301
|
+
| **[Core Library](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/core)** (Node.js + Browser) | Custom tools, scripts, extensions, web apps | `npm install -g @flow-scanner/lightning-flow-scanner-core` |
|
|
314
302
|
|
|
315
303
|
**Privacy:** Zero user data collected. All processing is client-side. → See our [Security Policy](https://github.com/Flow-Scanner/lightning-flow-scanner?tab=security-ov-file).
|
|
316
304
|
|
|
@@ -319,8 +307,8 @@ Ready-to-use CI/CD templates and a **native GitHub Action**.
|
|
|
319
307
|
|
|
320
308
|
| Platform | Template Type | Link |
|
|
321
309
|
|----------------|-----------------------------------|------|
|
|
322
|
-
| Azure DevOps | Full Project Scan | [`azure-pipelines-flow-FullScan.yml`](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/docs/
|
|
323
|
-
| Azure DevOps | Change-Based Scan | [`azure-pipelines-flow-changedFiles.yml`](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/docs/
|
|
310
|
+
| [Azure DevOps](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/docs/azure-templates.md) | Full Project Scan | [`azure-pipelines-flow-FullScan.yml`](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/docs/templates/azure-devops/azure-pipelines-flow-FullScan.yml) |
|
|
311
|
+
| [Azure DevOps](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/docs/azure-templates.md) | Change-Based Scan | [`azure-pipelines-flow-changedFiles.yml`](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/docs/templates/azure-devops/azure-pipelines-flow-changedFiles.yml) |
|
|
324
312
|
| **[GitHub Action](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/action/README.md)** | Native PR checks | [GitHub Marketplace](https://github.com/marketplace/actions/run-flow-scanner) |
|
|
325
313
|
| **[Copado Plugin](https://github.com/Flow-Scanner/lightning-flow-scanner-copado)** | Copado CI/CD pipelines | [Copado Marketplace](https://success.copado.com/s/listing-detail?language=en_US&recordId=a54P7000003G3gBIAS) |
|
|
326
314
|
|
|
@@ -337,7 +325,7 @@ GitHub Action Snippet:
|
|
|
337
325
|
sarif_file: ${{ steps.flowscanner.outputs.sarifPath }}
|
|
338
326
|
```
|
|
339
327
|
|
|
340
|
-
To see the full example, see [`scan-flows.yml`](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/docs/
|
|
328
|
+
To see the full example, see [`scan-flows.yml`](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/docs/templates/github-action/scan-flows.yml).
|
|
341
329
|
|
|
342
330
|
## Quick Start
|
|
343
331
|
|
|
@@ -385,7 +373,7 @@ const results = scan(
|
|
|
385
373
|
|
|
386
374
|
## Development
|
|
387
375
|
|
|
388
|
-
> This project optionally uses [Volta](https://volta.sh) to guarantee the exact same Node.js and tool versions for every contributor.
|
|
376
|
+
> This project optionally uses [Volta](https://volta.sh) to guarantee the exact same Node.js and tool versions for every contributor.
|
|
389
377
|
>
|
|
390
378
|
> MacOs/Linux:
|
|
391
379
|
> ```sh
|
|
@@ -450,10 +438,10 @@ const results = scan(
|
|
|
450
438
|
6. Deploy Demo Flows (Optional):
|
|
451
439
|
|
|
452
440
|
```bash
|
|
453
|
-
cd
|
|
441
|
+
cd example-flows && sf project deploy start
|
|
454
442
|
```
|
|
455
443
|
|
|
456
|
-
Navigate to the [Demo Readme](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/
|
|
444
|
+
Navigate to the [Demo Readme](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/example-flows/README.md) for full details
|
|
457
445
|
|
|
458
446
|
7. Create a standalone UMD Module(Optional):
|
|
459
447
|
|
|
@@ -462,4 +450,4 @@ const results = scan(
|
|
|
462
450
|
```
|
|
463
451
|
This creates UMD at `dist/lightning-flow-scanner-core.umd.js`.
|
|
464
452
|
|
|
465
|
-
|
|
453
|
+
**Want to help improve Lightning Flow Scanner? See our [Contributing Guidelines](https://github.com/Flow-Scanner/lightning-flow-scanner?tab=contributing-ov-file)**
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@flow-scanner/lightning-flow-scanner-core",
|
|
3
3
|
"description": "A lightweight engine for Flow metadata in Node.js, and browser environments. Assess and enhance Salesforce Flow automations for best practices, security, governor limits, and performance issues.",
|
|
4
|
-
"version": "6.10.
|
|
4
|
+
"version": "6.10.1",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"exports": {
|
|
7
7
|
".": {
|
|
File without changes
|