avoid_returning_widgets

[jesperu7]

Description:
The avoid_returning_widgets rule would ensure that widgets are not returned from functions. Instead, widgets should be created within the build method or in dedicated widget classes. This practice enhances code readability, maintainability, and performance. By enforcing this rule, we can encourage developers to structure their Flutter applications in a more modular and understandable manner.

Rationale:

Maintainability: Keeping widget creation within the build method or dedicated widget classes makes the code easier to maintain.
Performance: Proper widget creation helps optimize performance by ensuring that the widget tree is managed efficiently.
Clarity: Improves the readability and clarity of the code, making it easier for developers to understand and work with.

Example:

Bad:

Widget createButton() {
  return ElevatedButton(
    onPressed: () {},
    child: Text('Press Me'),
  );
}

Good:

class CustomButton extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return ElevatedButton(
      onPressed: () {},
      child: Text('Press Me'),
    );
  }
}

[bwilkerson]

@goderbauer

[goderbauer]

This seems to be a duplicate of #58303. There's some discussion there and what I said there is still accurate.

[NatoBoram]

It's also still addressed in the proposal