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

Support navigation from diagnostic names in analysis_options.yaml to their documentation pages #48902

Open
bwilkerson opened this issue Apr 27, 2022 · 2 comments
Labels
analyzer-analysis-options area-analyzer Use area-analyzer for Dart analyzer issues, including the analysis server and code completion. P3 A lower priority bug or feature request type-enhancement A request for a change that isn't a bug

Comments

@bwilkerson
Copy link
Member

The analysis_options.yaml file allows diagnostics to be mentioned. We should allow navigation from the name of a diagnostic to the documentation page for the diagnostic.

@bwilkerson bwilkerson added area-analyzer Use area-analyzer for Dart analyzer issues, including the analysis server and code completion. P3 A lower priority bug or feature request analyzer-analysis-options labels Apr 27, 2022
@asashour
Copy link
Contributor

Would this be handled in analysis.navigation or analysis.errors, or something new, and what about LSP?

I am trying to understand: analysis.navigation returns AnalysisNavigationParams with targets and files, but what is need is something like AnalysisError with the url and location. However, it is not actually an "Error".

@bwilkerson
Copy link
Member Author

In the legacy protocol we'd likely want to add this support to both the analysis.navigation request and the analysis.navigation notification. I don't know whether adding support to either of these would actually work in IntelliJ, though, because the protocol assumes a file path and doesn't really support URLs. It's likely that we'd need to add a new protocol (or extend the current protocol), and that would require support in the plugin. I suspect that we won't put that kind of effort into it.

For LSP, I suspect that we'd want to support this using textDocument/documentLink. That protocol already supports URLs and appears to be made for exactly this kind of thing.

@srawlins srawlins added the type-enhancement A request for a change that isn't a bug label Mar 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
analyzer-analysis-options area-analyzer Use area-analyzer for Dart analyzer issues, including the analysis server and code completion. P3 A lower priority bug or feature request type-enhancement A request for a change that isn't a bug
Projects
None yet
Development

No branches or pull requests

3 participants