|
6 | 6 | <p align="center">Scans for unsafe contexts, hardcoded IDs, and other issues to optimize your Flows.</p> |
7 | 7 |
|
8 | 8 | - [Default Rules](#default-rules) |
9 | | -- [Core Functions](#core-functions) |
10 | 9 | - [Configurations](#configurations) |
11 | 10 | - [Rule Configuration](#rule-configuration) |
12 | 11 | - [Exception Configuration](#exception-configuration) |
| 12 | +- [Core Functions](#core-functions) |
13 | 13 | - [Development Setup](#development-setup) |
14 | 14 |
|
15 | 15 | --- |
@@ -116,26 +116,6 @@ _[UnusedVariable](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tr |
116 | 116 |
|
117 | 117 | --- |
118 | 118 |
|
119 | | -## Core Functions |
120 | | - |
121 | | -### [`getRules(ruleNames?: string[]): IRuleDefinition[]`](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/libs/GetRuleDefinitions.ts) |
122 | | - |
123 | | -_Retrieves rule definitions used in the scanner._ |
124 | | - |
125 | | -### [`parse(selectedUris: any): Promise<ParsedFlow[]>`](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/libs/ParseFlows.ts) |
126 | | - |
127 | | -_Parses metadata from selected Flow files._ |
128 | | - |
129 | | -### [`scan(parsedFlows: ParsedFlow[], ruleOptions?: IRulesConfig): ScanResult[]`](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/libs/ScanFlows.ts) |
130 | | - |
131 | | -_Runs rules against parsed flows and returns scan results._ |
132 | | - |
133 | | -### [`fix(results: ScanResult[]): ScanResult[]`](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/libs/FixFlows.ts) |
134 | | - |
135 | | -_Attempts to apply automatic fixes where available._ |
136 | | - |
137 | | ---- |
138 | | - |
139 | 119 | ## Configurations |
140 | 120 |
|
141 | 121 | ### Rule Configuration |
@@ -181,6 +161,28 @@ Specifying exceptions allows you to exclude specific scenarios from rule enforce |
181 | 161 | - **ResultName:** |
182 | 162 | - The specific result or condition within the rule for which exceptions are specified. |
183 | 163 |
|
| 164 | +--- |
| 165 | + |
| 166 | +## Core Functions |
| 167 | + |
| 168 | +### [`getRules(ruleNames?: string[]): IRuleDefinition[]`](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/libs/GetRuleDefinitions.ts) |
| 169 | + |
| 170 | +_Retrieves rule definitions used in the scanner._ |
| 171 | + |
| 172 | +### [`parse(selectedUris: any): Promise<ParsedFlow[]>`](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/libs/ParseFlows.ts) |
| 173 | + |
| 174 | +_Parses metadata from selected Flow files._ |
| 175 | + |
| 176 | +### [`scan(parsedFlows: ParsedFlow[], ruleOptions?: IRulesConfig): ScanResult[]`](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/libs/ScanFlows.ts) |
| 177 | + |
| 178 | +_Runs rules against parsed flows and returns scan results._ |
| 179 | + |
| 180 | +### [`fix(results: ScanResult[]): ScanResult[]`](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/libs/FixFlows.ts) |
| 181 | + |
| 182 | +_Attempts to apply automatic fixes where available._ |
| 183 | + |
| 184 | +--- |
| 185 | + |
184 | 186 | ## Development Setup |
185 | 187 |
|
186 | 188 | > This project optionally uses [Volta](https://volta.sh) to manage Node.js versions. Install Volta with: |
|
0 commit comments