Release Notes - 3.10

Version 3.10 Improved Error Handling:

• Implements compiler traversal in the unconnected elemens rule, supporting custom flow elements.
• Adds error message to the result details in case a flow is scanned unsuccessfully.

https://github.com/Lightning-Flow-Scanner/lightning-flow-scanner-core/releases/tag/3.10

Version 3.9 of the Core Module now includes 2 New Default Rules:

Release Note: Custom Rule Creation

We're excited to announce implement core 2.30 and with it, the ability to create custom rules! With this new feature, users can now define and enforce organization-specific standards and best practices tailored to their unique requirements by leveraging our compiler or creating completely customized typescript functions.

Key Features:

• Custom Rule Interface: Define custom rules that adhere to the IRuleDefinition interface, specifying properties such as name, label, description, supported types, and more.
• Flexible Rule Configuration: Configure custom rules alongside default rules using the rules section of the scanner's configurations, allowing for fine-grained control over rule enforcement.
• Exception Handling: Specify exceptions at the flow, rule, or result level to exclude specific scenarios from rule enforcement, providing flexibility in rule application.

Getting Started with Custom Rule Creation:

1. Rule Structure: Define a custom rule class following the structure outlined in the Custom Rule Interface section of our documentation.
2. Implement Execute Method: Implement the execute method within your custom rule class to perform the desired logic for rule enforcement.
3. Adhere to Interface: Ensure your custom rule class adheres to the IRuleDefinition interface, defining required properties and methods for a rule definition.
4. Configure Rules: To load custom rules using the Lightning Flow Scanner Core, you can utilize the path attribute within the rules section of your configurations. This attribute allows you to specify the path to your custom rule class.

{ "rules": { "<RuleName>": { "path": "<Path>" } } }

By leveraging the path attribute, you can easily incorporate custom rule definitions into the Lightning Flow Scanner Core, tailoring rule enforcement to your organization's specific requirements.

For more details and examples, refer to our Custom Rule Creation Guide

Thanks to @nvuillam's contribution, we bring to you:

• Severity in flow errors details
• Summary of number of issues by severity

Handles an issue with the handling of Flows that have multiple loops

This brings some small improvements:

• Bugfix for supporting scheduled flows in our compiler by @junners
• Improves error handling for incorrect rule configurations

1. DMLStatementInLoop Rule:

   • The rule has undergone refinement to enhance accuracy in identifying DML statements within loops.
   • The traversal logic has been improved to account for nested loops, ensuring precise detection of DML statements within these structures.
   • To enhance maintainability, the rule has been split into a separate class.

2. SOQLQueryInLoop Rule:

   • Introducing a new rule, SOQLQueryInLoop, which identifies instances of SOQL queries executed inside loops. This addition promotes best practices and aids in optimizing code for governor limits.

3. Flow Compiler Class:

   • A new class, the Flow Compiler, has been introduced to elevate the capabilities of our rule-checking process. This addition allows for more sophisticated and uniform analyses of Salesforce flows.

https://github.com/Lightning-Flow-Scanner/lightning-flow-scanner-core/releases/tag/2.26

What's Changed

• Fix wrong exitCode when errors are found by @nvuillam in #72

Full Changelog: 2.11...v2.12.0

Fixes the following bugs:

• False positive 'FlowDescription' rule
• False positive 'MissingNullHandler' rule

some bugs have been fixed in 2.9 regarding including node modules in the scope of the scan and also the issues in the human output