Skip to content

Commit 70eac2c

Browse files
committed
swap sections in rm
1 parent 606e7d4 commit 70eac2c

File tree

1 file changed

+23
-21
lines changed

1 file changed

+23
-21
lines changed

readme.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
<p align="center">Scans for unsafe contexts, hardcoded IDs, and other issues to optimize your Flows.</p>
77

88
- [Default Rules](#default-rules)
9-
- [Core Functions](#core-functions)
109
- [Configurations](#configurations)
1110
- [Rule Configuration](#rule-configuration)
1211
- [Exception Configuration](#exception-configuration)
12+
- [Core Functions](#core-functions)
1313
- [Development Setup](#development-setup)
1414

1515
---
@@ -116,26 +116,6 @@ _[UnusedVariable](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tr
116116

117117
---
118118

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-
139119
## Configurations
140120

141121
### Rule Configuration
@@ -181,6 +161,28 @@ Specifying exceptions allows you to exclude specific scenarios from rule enforce
181161
- **ResultName:**
182162
- The specific result or condition within the rule for which exceptions are specified.
183163

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+
184186
## Development Setup
185187

186188
> This project optionally uses [Volta](https://volta.sh) to manage Node.js versions. Install Volta with:

0 commit comments

Comments
 (0)