Skip to content
This repository was archived by the owner on Oct 7, 2025. It is now read-only.

Commit 1012591

Browse files
committed
docs(#159): update docs
1 parent 796c24a commit 1012591

File tree

1 file changed

+23
-9
lines changed

1 file changed

+23
-9
lines changed

README.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,26 @@ The `Default Flow Rules` command can be used to view more details on the rules t
2020

2121
The `Calculate Flow Coverage` command calculates Flow Test coverage percentages by running the apex tests in your default connectedOrg.
2222

23-
<!-- commands --><!-- commands -->
24-
25-
<!-- configs --><!-- configs -->
26-
## Settings
27-
Name | Description | Type | Default value |
28-
|--------------|:-----------|--------------|:-----------|
29-
| SpecifyFiles | Specify flow file paths instead of a root directory. | boolean | false |
30-
| NamingConvention | Specify a REGEX expression to use as Flow Naming convention. | string | [A-Za-z0-9]+_[A-Za-z0-9]+ |
31-
| APIVersion | Specify an expression to validate the API version, i.e. '===50'(use at least 50). | string | >50 |
23+
<!-- commands -->
24+
25+
| Command | Title |
26+
| ------------------------------------------------ | ----------------------- |
27+
| `lightningflowscanner.viewDefaultFlowRules` | Default Flow Rules |
28+
| `lightningflowscanner.scanFlows` | Scan Flows |
29+
| `lightningflowscanner.debugView` | Debug Flow Scanner View |
30+
| `lightningflowscanner.fixFlows` | Fix Flows |
31+
| `lightningflowscanner.calculateFlowTestCoverage` | Calculate Flow Coverage |
32+
| `lightningflowscanner.configRules` | Configurate Flow Rules |
33+
34+
<!-- commands -->
35+
36+
<!-- configs -->
37+
38+
| Key | Description | Type | Default |
39+
| --------------------------------------- | --------------------------------------------------------------------------------- | --------- | ----------------------------- |
40+
| `lightningFlowScanner.SpecifyFiles` | Specify flow file paths instead of a root directory. | `boolean` | `false` |
41+
| `lightningFlowScanner.NamingConvention` | Specify a REGEX expression to use as Flow Naming convention. | `string` | `"[A-Za-z0-9]+_[A-Za-z0-9]+"` |
42+
| `lightningFlowScanner.APIVersion` | Specify an expression to validate the API version, i.e. '===50'(use at least 50). | `string` | `">50"` |
43+
| `lightningFlowScanner.Reset` | Reset all configurations on every scan | `boolean` | `false` |
44+
45+
<!-- configs -->

0 commit comments

Comments
 (0)