dart-lang / lints

Official Dart lint rules; the core and recommended set of lints suggested by the Dart team.
https://pub.dev/packages/lints
BSD 3-Clause "New" or "Revised" License
118 stars 30 forks source link

add `unintended_html_in_doc_comment` to core #208

Closed devoncarew closed 1 month ago

devoncarew commented 1 month ago

cc @kevmoo @lrhn @kallentu


Contribution guidelines:
- See our [contributor guide](https://github.com/dart-lang/.github/blob/main/CONTRIBUTING.md) for general expectations for PRs. - Larger or significant changes should be discussed in an issue before creating a PR. - Contributions to our repos should follow the [Dart style guide](https://dart.dev/guides/language/effective-dart) and use `dart format`. - Most changes should add an entry to the changelog and may need to [rev the pubspec package version](https://github.com/dart-lang/sdk/blob/main/docs/External-Package-Maintenance.md#making-a-change). - Changes to packages require [corresponding tests](https://github.com/dart-lang/.github/blob/main/CONTRIBUTING.md#Testing). Note that many Dart repos have a weekly cadence for reviewing PRs - please allow for some latency before initial review feedback.
natebosch commented 1 month ago

We should be careful with this one because of the false positives. We might want to bump the min SDK constraint to an SDK version where we know this lint has no false positives.

devoncarew commented 1 month ago

We should be careful with this one because of the false positives. We might want to bump the min SDK constraint to an SDK version where we know this lint has no false positives.

Yes, good point. unintended_html_in_doc_comment exists in 3.5 but triggers on some false positives. The not-yet-released 3.6 sdk has the fixes. Thinking through this:

natebosch commented 1 month ago
  • then be able to rev to the latest major version of this package, but would see slightly more lints when running on 3.6 vs 3.5. This may not be an issue? It would be similar to the sdk introducing a new diagnostic

Yeah I think that would probably be OK, the only risk is failing CI. I think the "false negative" of not having the lint at all is better than the false positives.