Fix Reek installation issue when Yard is installed #1784
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
As per troessner#1627, Yard can't process Reek because `docs/yarn_plugin.rb` is missing. It's not included in the Gem, so this PR adds it to correct this error. This was reported upstream in lsegal/yard#1462, but it seems that it either wasn't, or people were happy enough with the workaround (touching the missing file in the Gem's installed location). The workaround doesn't work when using `asdf`/`mise` with [default Gems](https://mise.jdx.dev/lang/ruby.html#default-gems). If Yard's automatic documentation is enabled (`yard config --gem-install-yri`) then the Ruby build fails.
|
Thanks @typhoon2099! Pity that the reporter closed #1627 since touching random files in gem installations is hardly a fix 😞. |
|
I can confirm that this fixes the problem. |
|
Thanks, @typhoon2099! |
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.
As per #1627, Yard can't process Reek because
docs/yarn_plugin.rbis missing. It's not included in the Gem, so this PR adds it to correct this error.This was reported upstream in
lsegal/yard#1462, but it seems that it either wasn't, or people were happy enough with the workaround (touching the missing file in the Gem's installed location). The workaround doesn't work when using
asdf/misewith defaultGems. If Yard's automatic documentation is enabled (
yard config --gem-install-yri) then the Ruby build fails.