Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

No RuboCop doc links for extensions #2022

Closed
Earlopain opened this issue May 8, 2024 · 1 comment
Closed

No RuboCop doc links for extensions #2022

Earlopain opened this issue May 8, 2024 · 1 comment
Assignees
Labels
bug Something isn't working

Comments

@Earlopain
Copy link
Contributor

Description

Here is how it looks like for buildin cops:
image

RuboCop Rails (and all other extensions):
image

This may be an upstream issue rubocop/rubocop#12884

However I think it makes sense to report this here as well since I don't think there are many consumers of this API in the first place.

Context

documentation_url will only return a result for base RuboCop cops. Per the methods documentation, extensions are encouraged to implement this themselves but none I know of do, including all the official ones.

https://github.com/rubocop/rubocop/blob/7f9595aa3ca3524f888b1464c4eeb7e15aabfc22/lib/rubocop/cop/base.rb#L63-L69

rubocop --show-docs-url Rails/Exit prints the correct result, however it relies on private API.

@Earlopain Earlopain added the bug Something isn't working label May 8, 2024
@andyw8
Copy link
Contributor

andyw8 commented May 10, 2024

👋 Thanks for the report, and for creating the issue upstream. I don't think there's really anything we can do within ruby-lsp for this currently. Once rubocop/rubocop#12884 is resolved, this should start to work. If not, feel free to re-open.

@andyw8 andyw8 closed this as not planned Won't fix, can't repro, duplicate, stale May 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants