Lightning-Flow-Scanner / lightning-flow-scanner-sfdx

A Salesforce CLI Plugin designed to pinpoint deviations from Industry Best Practices in Salesforce Flows, ensuring standards of business automation excellence.
https://www.npmjs.com/package/lightning-flow-scanner
GNU Affero General Public License v3.0
112 stars 12 forks source link

Add a description to the repository #58

Closed nvuillam closed 1 year ago

nvuillam commented 1 year ago

I think it woud be more efficient that when a user sees the README, he/she directly knows at the first look what the repository is about.

Here is an example of phrase that could quickly explain why it is a very good idea to use flow scanner !


Salesforce Flow Builder is a great tool, allowing trailblazers to implement amazing automations with no-code !

But as it allows to define complex rules and algorithms, if wrongly used it can lead to critical issues in production.

That's when Lightning Flow Scanner comes to the rescue with its set of rules !

Like PMD for Apex, the Flow scanner will analyze your flows and highlight their parts that do not follow the best practices.