mirror of
https://github.com/flutter/flutter.git
synced 2025-06-03 00:51:18 +00:00
77ba015769
Enables the `comment_references` and `unintended_html_in_doc_comment` lints in `packages/flutter_tool`, then fixes each of the triggering cases. This PR is test exempt due to only affecting documentation comments. ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing. [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
15 lines
610 B
YAML
15 lines
610 B
YAML
include: ../analysis_options.yaml
|
|
|
|
linter:
|
|
rules:
|
|
avoid_catches_without_on_clauses: true
|
|
avoid_catching_errors: false # TODO(ianh): we should refactor the tool codebase to avoid relying on this so much
|
|
comment_references: true
|
|
library_private_types_in_public_api: false # Tool does not have any public API.
|
|
no_runtimeType_toString: false # We use runtimeType for debugging in the tool.
|
|
only_throw_errors: true
|
|
prefer_relative_imports: true
|
|
public_member_api_docs: false # Tool does not have any public API.
|
|
unawaited_futures: true
|
|
unintended_html_in_doc_comment: true
|