Repository navigation
[analysis] Migrate verifyTabooDocumentation to flutter_analyzer_plugin - #191125
Merged
auto-submit[bot] merged 4 commits intoAug 14, 2026
Merged
Conversation
bkonyi
force-pushed
the
migrate_taboo_documentation_rule
branch
from
August 14, 2026 16:36
5b04531 to
6fd188c
Compare
Contributor
There was a problem hiding this comment.
Code Review
This pull request migrates the taboo documentation check from a custom script in dev/bots/analyze.dart to a formal analyzer plugin rule TabooDocumentation within dev/flutter_analyzer_plugin. Feedback focuses on correcting the regular expression _tabooPattern to ensure it properly matches comments containing 'Note:' followed by a space, as the current word boundary configuration fails on non-word characters like colons. An update to the corresponding test cases is also recommended to reflect this fix.
bkonyi
force-pushed
the
migrate_taboo_documentation_rule
branch
from
August 14, 2026 16:37
6fd188c to
233a18e
Compare
srawlins
approved these changes
Aug 14, 2026
| TabooDocumentation() : super(name: code.name, description: ruleDescription); | ||
|
|
||
| static const String ruleDescription = | ||
| "Avoid taboo words ('simply', 'note:', 'note that') in documentation comments."; |
Contributor
There was a problem hiding this comment.
We need to crib some of these rules.
This was referenced Aug 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Migrates
verifyTabooDocumentationfromdev/bots/analyze.dartto an AST-basedAnalysisRule(TabooDocumentation) indev/flutter_analyzer_plugin.Changes
TabooDocumentationindev/flutter_analyzer_plugin/lib/src/rules/taboo_documentation.dart.dev/flutter_analyzer_plugin/test/taboo_documentation_test.dart.TabooDocumentationindev/flutter_analyzer_plugin/lib/main.dart.verifyTabooDocumentationand'taboo'fromdev/bots/analyze.dartanddev/bots/test/analyze_test.dart.