Refactor rule loading so we can correctly load markdown help files #2362
Conversation
This file contains 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
cognifloyd
approved these changes
Aug 30, 2022
We now load the markdown help using lazy loading so we no longer need to manually load the documentation files when we load the rules. This also allows us to add markdown documentation for the internal rules, which are not loaded using the normal loader.
As we observed that our old loading was failing to correctly identify the filename from which each rule originated, we reworked to use a more standard import_module() approach. This is fixing a bug we observed with loading the markdown help file for some of the internal rules.
ssbarnea
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
We now load the markdown help using lazy loading so we no longer need to manually load the documentation files when we load the rules.
This also allows us to add markdown documentation for the internal rules, which are not loaded using the normal loader.