Skip to content

[analysis] Migrate verifyTabooDocumentation to flutter_analyzer_plugin - #191125

Merged
auto-submit[bot] merged 4 commits into
flutter:masterfrom
bkonyi:migrate_taboo_documentation_rule
Aug 14, 2026
Merged

auto-submit[bot] merged 4 commits into
flutter:masterfrom
bkonyi:migrate_taboo_documentation_rule

Conversation

@bkonyi

@bkonyi bkonyi commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

Migrates verifyTabooDocumentation from dev/bots/analyze.dart to an AST-based AnalysisRule (TabooDocumentation) in dev/flutter_analyzer_plugin.

Changes

  • Implements TabooDocumentation in dev/flutter_analyzer_plugin/lib/src/rules/taboo_documentation.dart.
  • Adds unit tests in dev/flutter_analyzer_plugin/test/taboo_documentation_test.dart.
  • Registers TabooDocumentation in dev/flutter_analyzer_plugin/lib/main.dart.
  • Removes verifyTabooDocumentation and 'taboo' from dev/bots/analyze.dart and dev/bots/test/analyze_test.dart.

@flutter-dashboard flutter-dashboard Bot added the CICD Run CI/CD label Aug 14, 2026
@bkonyi
bkonyi force-pushed the migrate_taboo_documentation_rule branch from 5b04531 to 6fd188c Compare August 14, 2026 16:36

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
bkonyi force-pushed the migrate_taboo_documentation_rule branch from 6fd188c to 233a18e Compare August 14, 2026 16:37
@bkonyi
bkonyi requested a review from srawlins August 14, 2026 20:58
TabooDocumentation() : super(name: code.name, description: ruleDescription);

static const String ruleDescription =
"Avoid taboo words ('simply', 'note:', 'note that') in documentation comments.";

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to crib some of these rules.

@bkonyi bkonyi added the autosubmit Merge PR when tree becomes green via auto submit App label Aug 14, 2026
@auto-submit
auto-submit Bot added this pull request to the merge queue Aug 14, 2026
Merged via the queue into flutter:master with commit eae0716 Aug 14, 2026
22 checks passed
@flutter-dashboard flutter-dashboard Bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Aug 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CICD Run CI/CD

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants