Skip to content

Add open docs functionality to lints #60185

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

Closed
FMorschel opened this issue Feb 20, 2025 · 5 comments
Closed

Add open docs functionality to lints #60185

FMorschel opened this issue Feb 20, 2025 · 5 comments
Labels
area-devexp For issues related to the analysis server, IDE support, linter, `dart fix`, and diagnostic messages. devexp-server Issues related to some aspect of the analysis server devexp-ux P2 A bug or feature request we're likely to work on type-enhancement A request for a change that isn't a bug

Comments

@FMorschel
Copy link
Contributor

FMorschel commented Feb 20, 2025

Similarly to Dart-Code/Dart-Code#2785 (adds this functionality to pub packages) and related to the work at #57034, I'd say it would be great if lints had the same functionality to open the docs for them from inside the IDEs.

I'd like to take a look at the work done for Dart-Code/Dart-Code#2785 (at a31be9b) and implement this feature.

CC: @pq @DanTup

@FMorschel
Copy link
Contributor Author

@bwilkerson wrote Dart-Code/Dart-Code#5405 (comment):

[...]
The change that Parker, Phil, Marya and I have been working toward is to rework some of the documentation for the lints so that

1. there is a page that helps the user understand which lints they might want to enable based on the kinds of problems they want to catch (to improve discoverability),

2. each lint has a description of what the rule does and when a user might want to enable it (to help users understand whether they want to enable the lint), and

3. when a rule produces a diagnostic it has a link to documentation about the diagnostic on https://dart.dev/tools/diagnostic-messages (to help users understand how to fix the problem).

The third step is partially done and ongoing, but the other two steps we're still laying the groundwork for.
[...]

Only because it might be helpful to have informed here too.

@pq
Copy link
Member

pq commented Feb 20, 2025

I would absolutely love to see better integration of linter docs in the IDE. Thanks for taking an interest in this!

@pq pq added area-devexp For issues related to the analysis server, IDE support, linter, `dart fix`, and diagnostic messages. devexp-ux devexp-server Issues related to some aspect of the analysis server P2 A bug or feature request we're likely to work on type-enhancement A request for a change that isn't a bug labels Feb 20, 2025
@FMorschel
Copy link
Contributor Author

@FMorschel
Copy link
Contributor Author

Ping @bwilkerson for taking a look at the CL. Thanks!

@FMorschel
Copy link
Contributor Author

Hey @bwilkerson and @pq, I've done all requests commented on the CL. Can I get reviews for this please? Thanks a lot!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-devexp For issues related to the analysis server, IDE support, linter, `dart fix`, and diagnostic messages. devexp-server Issues related to some aspect of the analysis server devexp-ux P2 A bug or feature request we're likely to work on type-enhancement A request for a change that isn't a bug
Projects
None yet
Development

No branches or pull requests

2 participants