Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/scripts/generate-readme.js
Original file line number Diff line number Diff line change
Expand Up @@ -169,13 +169,13 @@ function buildSystemRulesContent(rules) {

System rules detect issues that are normally prevented by the Flow Builder UI. These rules are valuable when Flow XML files are edited directly by AI tools, scripts, or other automated processes.

## Disabling System Rules
## Enabling System Rules

System rules are enabled by default. To disable them for performance optimization:
System rules are disabled by default. To opt in:

\`\`\`yaml
# .flow-scanner.yml
systemRules: false
systemRules: true
\`\`\`

Or programmatically:
Expand All @@ -184,7 +184,7 @@ Or programmatically:
import { scan } from '@flow-scanner/lightning-flow-scanner-core';

const results = scan(parsedFlows, {
systemRules: false${hasBetaRules ? ',\n betaMode: true // Required for beta system rules' : ''}
systemRules: true${hasBetaRules ? ',\n betaMode: true // Required for beta system rules' : ''}
});
\`\`\`

Expand Down
Loading
Loading