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

[process/docs] update lint rule codegen script and lint writing docs #59696

Open
pq opened this issue Dec 11, 2024 · 2 comments
Open

[process/docs] update lint rule codegen script and lint writing docs #59696

pq opened this issue Dec 11, 2024 · 2 comments
Assignees
Labels
analyzer-linter Issues with the analyzer's support for the linter package area-analyzer Use area-analyzer for Dart analyzer issues, including the analysis server and code completion. P2 A bug or feature request we're likely to work on type-documentation A request to add or improve documentation

Comments

@pq
Copy link
Member

pq commented Dec 11, 2024

The "mechanics" part of writing-lints.md is out of date and tool/rule.dart produces invalid results.

@parlough is your refactoring at a stable enough place that we can update docs and supporting scripts?

@pq pq added area-analyzer Use area-analyzer for Dart analyzer issues, including the analysis server and code completion. type-documentation A request to add or improve documentation analyzer-linter Issues with the analyzer's support for the linter package P2 A bug or feature request we're likely to work on labels Dec 11, 2024
@parlough
Copy link
Member

parlough commented Dec 11, 2024

@parlough is your refactoring at a stable enough place that we can update docs and supporting scripts?

If https://dart-review.googlesource.com/c/sdk/+/397380 or something similar lands, that should be the last major change. It's ready for review if you have some thoughts on it.

I'd be happy to update both of these, whether or not that change lands.

@pq
Copy link
Member Author

pq commented Dec 11, 2024

Cool. Thanks! Sorry to be so slow in that PR BTW. I'll add some comments shortly.

@parlough parlough self-assigned this Dec 12, 2024
copybara-service bot pushed a commit that referenced this issue Dec 12, 2024
Contributes to #59696 by updating the writing lint docs for the current process.
I left updating the bootstrapping tool for a separate CL to keep this easier to review.

Based on what direction we go for the messages.yaml file, this doc will continue to change and hopefully get simpler.

Change-Id: I706e9438fbd6acdba41dd7198ad3b5afd5acbe4e
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/400420
Commit-Queue: Phil Quitslund <[email protected]>
Commit-Queue: Brian Wilkerson <[email protected]>
Reviewed-by: Phil Quitslund <[email protected]>
Reviewed-by: Brian Wilkerson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
analyzer-linter Issues with the analyzer's support for the linter package area-analyzer Use area-analyzer for Dart analyzer issues, including the analysis server and code completion. P2 A bug or feature request we're likely to work on type-documentation A request to add or improve documentation
Projects
None yet
Development

No branches or pull requests

2 participants