Skip to content

Commit f932e9d

Browse files
committed
docs: update important note for LFS
1 parent d1f5e77 commit f932e9d

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/customruleguide.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@ The Lightning Flow Scanner (LFS) core provides two primary capabilities: `parse`
99

1010
Rules in LFS are implemented as classes that conform to the `IRuleDefinition` interface, ensuring each rule exposes the required properties and methods for the scanner to recognize and execute them.
1111

12+
> **Important:** Custom rules are recognized by the Lightning Flow Scanner only if your rule configuration in the flow-scanner config file specifies a valid `path` to the rule implementation. Ensure that each custom rule entry includes the `path` property pointing to the JavaScript file that exports your rule class.
13+
```yml
14+
rules:
15+
MyCustomRuleToBeScanned:
16+
path: # Relative or absolute path to js file
17+
severity: error
18+
```
19+
1220
> **Note:** The `IRuleDefinition` interface is being replaced by the `AdvancedRule` base class. This transition allows backward compatibility, simplifies rule development and enables exception handling at the flow scan process level. Additionally, the introduction of `AdvancedSuppression` allows individual rules to define custom suppression logic, providing more granular control over rule enforcement.
1321

1422
## Rule Structure

0 commit comments

Comments
 (0)