Skip to content

v3.4: Rule Configuration Wizard

Latest

Choose a tag to compare

@RubenHalman RubenHalman released this 08 Aug 14:33

Lightning Flow Scanner App —

Configure rules the way that suits you — the new wizard, a config file, or inline edits — then save it to the org so everyone gets it. The Setup tab now verifies itself.

✨ Configure Rules wizard

The in-app counterpart of the VS Code extension's Configure Scanner command.

  • Four steps:
    1. Mode — merged or isolated, plus a beta-rules opt-in
    2. Rules — searchable multi-select with descriptions and Beta badges
    3. Options — thresholds and expressions; core defaults shown as placeholders, empty keeps the default
    4. Review
  • Applying re-scans open results.
  • Produces the same .flow-scanner.json as everything else, so the wizard, import and inline edits can't drift apart.

📄 Import a config file

Load config reads .flow-scanner.json and .flow-scanner.yml — the same files the CLI reads and the VS Code extension writes.

  • Per-rule settings: severity, enabled, expression, threshold, message and messageUrl
  • Top-level settings: threshold, categories, exceptions and ignoreFlows
  • Rule keys work as ids (excessive-cyclomatic-complexity) or legacy names (CyclomaticComplexity)
  • ruleMode: "isolated" runs only the rules the file names
  • Parse errors report the line

✏️ Edit rule options inline

  • Rules with configurable options — the naming expression, complexity threshold — now have an editor in the Options column.
  • Press Enter or click away to apply and re-scan.
  • Generated from the core's rule metadata, so new configurable rules appear on their own.

☁️ Save to the org

Configuration no longer dies with the browser session. Save to Org stores the current configuration in the new Flow_Scanner_Saved_Config__mdt custom metadata type, and it loads automatically for every user.

  • Requires Customize Application. Deploys via the Metadata API, 10–30 seconds.
  • Layers, in order: core defaults → ScanRuleConfiguration__mdt → saved org configuration → the user's session edits.
  • It's custom metadata, so it moves between environments with your other deployments.

📤 Export and reset

  • Export downloads the current configuration as .flow-scanner.json, ready for the CLI and VS Code. Isolated mode exports only active rules; merged marks disabled ones with enabled: false.
  • Reset returns to core defaults plus custom metadata overrides. Previously that needed a page reload.

✅ Setup tab verifies itself

  • Five numbered steps in the order you do them: permission set → certificate → External Client App → pre-authorize users → Consumer Key.
  • Steps 3 and 4 complete themselves. The JWT connection test runs when the tab opens and after each Consumer Key save. A successful token exchange proves the app and its policies are right. If authorization breaks later, the checklist shows it instead of a stale checkmark.
  • OAuth errors say how to fix them: missing pre-authorization (invalid_app_access), missing refresh_token scope, wrong Consumer Key (invalid_client_id), certificate mismatch (invalid_grant).
  • Open Installation Guide links to the guide, restructured to match. Pre-authorizing users is now documented as required — it never was optional, the JWT Bearer Flow has no consent screen.

🔧 Other improvements

  • ScanRuleConfiguration__mdt Rule Name accepts rule ids (invalid-naming-convention) as well as legacy names (FlowName).
  • Severity is validated: Error, Warning and Note apply, anything else is ignored. Info is no longer valid.
  • The Configuration toolbar wraps on narrow screens instead of running off the edge.