Show doc urls for extension cops #2076
Merged
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
andyw8
reviewed
May 21, 2024
Earlopain
force-pushed
the
rubocop-doc-urls
branch
from
97e289e
to
987c3d9
Compare
vinistock
added
enhancement
Earlopain
force-pushed
the
rubocop-doc-urls
branch
2 times, most recently
from
243f43e
to
f2d7002
Compare
vinistock
reviewed
May 27, 2024
6 tasks
RuboCop 1.64 added support for passing in a config, which will then construct the correct url for non-buildin departments that have `DocumentationBaseURL` set.
Earlopain
force-pushed
the
rubocop-doc-urls
branch
from
f2d7002
to
ef7332e
Compare
vinistock
approved these changes
Jun 3, 2024
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.
Requires #2075 and a new RuboCop release.
Motivation
#2022
Implementation
rubocop/rubocop#12907 added what was needed to make this work. Doc urls are dependant on
DocumentationBaseURLfrom the config, which a class method simply doesn't have access to.So, pass in the config we have from the runner to construct these. Check the method params to stay compatible with both old and new versions.
Automated Tests
Yup
Manual Tests
Open some test file and add a new test case with the following:
Hover over the diagnostic and check out the hyperlink:
Old RuboCop versions will continue to not show these links.