Bundle the per-rule configurations/overrides #389
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.
What problem are you trying to solve?
We have per-rule enable/disable, per-rule arguments, and per-rule severity/category overrides, all spread across three different objects that are initialized separately, passed separately, and used separately.
We will be adding more.
What is your solution?
This PR bundles those objects together so only one object needs to be initialized, and only one object needs to be passed to the 'analyze' function.
Since the
analyze
function takes one file name and a list of rules, we can avoid parsing the filename more than once. To that end, theRuleConfigProvider
has aconfig_for_file
function that generates aRuleConfig
scoped to a particular file, with the file name all parsed up nicely. This is the object that is passed to theanalyze
function.The
RuleConfig
then has functions to get argument values, severity, enable/disable status, etc., for any rule and for the file it was created for.Alternatives considered
What the reviewer should know