fix: avoid returning widgets by solid-illiaaihistov · Pull Request #371 · solid-software/solid_lints

solid-illiaaihistov · 2026-08-31T12:44:15Z

Summary by CodeRabbit

New Features
- Added ignored_types configuration support for suppressing selected lint diagnostics.
- Supports ignored types provided as a list, map, or single value.
- Expanded “avoid returning widgets” handling for inherited and provider-based widget types.
Bug Fixes
- Improved detection of ignored types across declared and expression return types.
Documentation
- Added configuration examples for ignored widget types.
Tests
- Added coverage for parsing and ignored-type lint behavior.

… handling across lint rules

coderabbitai · 2026-08-31T12:45:00Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Team

Run ID: fb383d49-eb00-4870-8396-727d3016af6d

📥 Commits

Reviewing files that changed from the base of the PR and between 4ee8098 and 3e0132c.

📒 Files selected for processing (4)

lib/src/common/parameters/ignored_types_list_parameter.dart
lib/src/lints/avoid_returning_widgets/models/avoid_returning_widgets_parameters.dart
lib/src/lints/avoid_returning_widgets/visitors/avoid_returning_widgets_visitor.dart
lib/src/utils/node_utils.dart

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

📝 Walkthrough

Walkthrough

The change adds a shared ignored-type parameter model, integrates it into three lint rules, and updates avoid-returning-widgets to inspect declared and single-expression return types. Documentation and tests cover supported configuration formats and widget-return filtering.

Changes

Ignored type configuration

Layer / File(s)	Summary
Shared ignored-type parameter model `lib/src/common/parameters/ignored_types_list_parameter.dart`, `test/src/common/parameters/parameters_parsing_test.dart`	Adds `IgnoredTypesListParameter` with multi-format JSON parsing, null-safe type checks, Equatable value semantics, and parsing tests.
Lint parameter and visitor integration `lib/src/lints/avoid_late_keyword/...`, `lib/src/lints/avoid_non_null_assertion/...`	Updates both lint parameter models and visitors to use `IgnoredTypesListParameter.shouldIgnore`.
Returning-widgets filtering and validation `lib/src/lints/avoid_returning_widgets/...`, `lib/src/utils/node_utils.dart`, `lib/src/utils/types_utils.dart`, `test/src/lints/avoid_returning_widgets/...`	Adds ignored-type configuration to avoid-returning-widgets, evaluates declared and single-expression return types, replaces widget classification usage, removes obsolete helpers, and adds documentation and behavior tests.

Estimated code review effort: 3 (Moderate) | ~25 minutes

Merge Risk: ⚪ Minimal · up to 3e013

This change only adjusts which widget-return diagnostics a static analysis rule reports and does not affect runtime behavior, permissions, data, or deployment; no actionable merge-blocking risk remains beyond normal checks and review.

Sequence Diagram(s)

sequenceDiagram
  participant Declaration
  participant AvoidReturningWidgetsVisitor
  participant IgnoredTypesListParameter
  participant isWidgetOrSubclass
  Declaration->>AvoidReturningWidgetsVisitor: Visit declaration
  AvoidReturningWidgetsVisitor->>isWidgetOrSubclass: Check return type
  isWidgetOrSubclass-->>AvoidReturningWidgetsVisitor: Return widget classification
  AvoidReturningWidgetsVisitor->>IgnoredTypesListParameter: Check declared and expression types
  IgnoredTypesListParameter-->>AvoidReturningWidgetsVisitor: Return ignore decision
  AvoidReturningWidgetsVisitor-->>Declaration: Emit or suppress diagnostic

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly identifies the main change: fixing the avoid-returning-widgets lint rule. It is concise and related to the pull request changes.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (4 skipped: 4 unsupported.)

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

danylo-safonov-solid · 2026-08-31T16:39:57Z

-bool isWidgetType(DartType type) =>
-    isWidgetOrSubclass(type) &&
-    !(_isMultiProvider(type) || _isSubclassOfInheritedProvider(type));
+bool isWidgetType(DartType type) => isWidgetOrSubclass(type);


Suggested change

bool isWidgetType(DartType type) => isWidgetOrSubclass(type);

I'm not sure if we need both? the only difference is the name and parameter type, but I don't feel like it's reflected in the name change or needed?

and if we use the null accepting one, we can do

if (!isWidgetOrSubclass(returnType)) return;

instead of

if (returnType == null) return; if (!isWidgetType(returnType)) return;

danylo-safonov-solid · 2026-08-31T16:41:54Z

+      ignored_types:
+        - MultiProvider
+        - InheritedProvider
+        - InheritedTheme


I'm not sure if we want to make these default

…onfiguration options

danylo-safonov-solid · 2026-09-01T12:42:56Z

+  @override
+  bool operator ==(Object other) =>
+      identical(this, other) ||
+      other is IgnoredTypesListParameter &&
+          const SetEquality<String>().equals(
+            other.ignoredTypes,
+            ignoredTypes,
+          );
+
+  @override
+  int get hashCode => const SetEquality<String>().hash(ignoredTypes);


we can use Equatable for this

Suggested change

@override

bool operator ==(Object other) =>

identical(this, other) ||

other is IgnoredTypesListParameter &&

const SetEquality<String>().equals(

other.ignoredTypes,

ignoredTypes,

);

@override

int get hashCode => const SetEquality<String>().hash(ignoredTypes);

danylo-safonov-solid · 2026-09-01T13:47:39Z

+        _parameters.ignoredTypes.shouldIgnore(returnType) ||
+        _parameters.ignoredTypes.shouldIgnore(
+          node.singleReturnExpression?.staticType,
+        ) ||
+        _parameters.exclude.shouldIgnore(node);


Suggested change

_parameters.ignoredTypes.shouldIgnore(returnType) ||

_parameters.ignoredTypes.shouldIgnore(

node.singleReturnExpression?.staticType,

) ||

_parameters.exclude.shouldIgnore(node);

_parameters.shouldIgnore(node)

I'd rather extract this to AvoidReturningWidgetsParameters

ignoredTypes.shouldIgnoreAny([ node.returnType, node.singleReturnExpression?.staticType, ]) || exclude.shouldIgnore(node); } extension on Declaration { DartType? get returnType => switch (this) { MethodDeclaration(:final declaredFragment?) => declaredFragment.element.returnType, FunctionDeclaration(:final declaredFragment?) => declaredFragment.element.returnType, _ => null, }; }

and

bool shouldIgnoreAny(List<DartType?> types) => types.any(shouldIgnore);

Also we probably can join all of the if (...) return;s into a single one

Done! Thank you!

danylo-safonov-solid · 2026-09-01T13:48:49Z

  bool _isOverridden(Declaration node) {
-    if (node is MethodDeclaration &&
-        node.metadata.any((m) => m.name.name == 'override')) {
+    if (node is MethodDeclaration && isOverride(node.metadata)) {


this can be moved into the switch - MethodDeclaration() when isOverride(...) => true

…fy equality checks

…meter model and node utility extension

feat: introduce IgnoredTypesListParameter for consistent ignored type…

7b1abbb

… handling across lint rules

danylo-safonov-solid suggested changes Aug 31, 2026

View reviewed changes

refactor: simplify avoid_returning_widgets visitor logic and remove c…

4ee8098

…onfiguration options

danylo-safonov-solid suggested changes Sep 1, 2026

View reviewed changes

Illia Aihistov added 2 commits September 1, 2026 17:47

refactor: implement Equatable for IgnoredTypesListParameter to simpli…

e5b13ed

…fy equality checks

refactor: consolidate avoid_returning_widgets visitor logic into para…

3e0132c

…meter model and node utility extension

danylo-safonov-solid approved these changes Sep 1, 2026

View reviewed changes

Navigation Menu

Uh oh!

fix: avoid returning widgets - #371

fix: avoid returning widgets#371
solid-illiaaihistov wants to merge 4 commits into
solid-software:masterfrom
solid-illiaaihistov:fix-avoid-returning-widgets

solid-illiaaihistov commented Aug 31, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Aug 31, 2026 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Uh oh!

danylo-safonov-solid Aug 31, 2026

Uh oh!

solid-illiaaihistov Sep 1, 2026

Uh oh!

danylo-safonov-solid Aug 31, 2026

Uh oh!

solid-illiaaihistov Sep 1, 2026

Uh oh!

danylo-safonov-solid Sep 1, 2026

Uh oh!

solid-illiaaihistov Sep 1, 2026

Uh oh!

danylo-safonov-solid Sep 1, 2026

Uh oh!

solid-illiaaihistov Sep 1, 2026

Uh oh!

danylo-safonov-solid Sep 1, 2026

Uh oh!

solid-illiaaihistov Sep 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

solid-illiaaihistov commented Aug 31, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Aug 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

solid-illiaaihistov commented Aug 31, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Aug 31, 2026 •

edited

Loading