This repository was archived by the owner on Dec 1, 2025. It is now read-only.
Rule missing metadata description #314
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…bles) #215 New Rule Implementation - MissingMetadataDescription Checks for every flow's element if has a property description filled
Introduces a sample flow XML and a Jest test to validate the MissingMetadataDescription rule. Also adds debug logging to the rule implementation for easier troubleshooting.
Descriptions were added to actionCalls, recordCreates, and variables in several flow .flow-meta.xml files to improve metadata completeness. The rule logic in MissingMetadataDescription.ts was updated to better filter elements missing descriptions, excluding 'start' subtype and suppressed elements.
…m/smartinello1/lightning-flow-scanner-core into rule-missing-metadata-description
Update rule implementation with new version of the framework based on: https://github.com/Flow-Scanner/lightning-flow-scanner-core/blob/main/docs/write-a-rule.md
RubenHalman
approved these changes
Nov 26, 2025
Member
RubenHalman
left a comment
RubenHalman
left a comment
There was a problem hiding this comment.
Thank you for this awesome addition! Really happy to merge this. Just one quick question: would you like to add a small mention of the new rule (or an example) to the README before we ship it?
Also, small note: I’ll initially land this in the beta rule store. That’s on me: the contribution docs were pointing at the wrong directory.
Merging now – thanks again! 🚀
RubenHalman
pushed a commit
that referenced
this pull request
Nov 26, 2025
This PR is based on issue #215 and provided by @smartinello1 Implemented a new rule for missing description on all elements in flows excluding: - Start Element - Element with subtype equals to metadata
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is based on issue Flow-Scanner/lightning-flow-scanner#241
Implemented a new rule for missing description on all elements in flows excluding: