fix: detect rule prefix from ConfigsToRules and apply to rule doc title #680
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 introduces a utility function
detectPrefixFromConfigsToRules
to infer the rule prefix by analyzing the rule IDs inConfigsToRules
, instead of relying onpackage.json.name
.Motivation
Currently, there's no single agreed-upon source for determining a plugin's rule prefix. It's unclear whether the most reliable approach is:
configs[configName].plugins
configs[configName].rules
So, as a first step, I've made a minimal change that applies this prefix detection only to the rule documentation title.
Future Scope
Depending on how the discussion evolves, I’m open to applying this logic more broadly across the codebase (e.g. for rule links, config listings, etc.).
If this approach is misaligned with expectations or future direction, I’m also totally fine with closing this PR.
Notes
plugin.rules
with rule IDs inConfigsToRules
.Looking forward to your feedback!