example/README.md

Function Linter Example 📚 #

This example shows you how to use Function Linter in a real project!

🚀 Try It Yourself #

1. Install dependencies:

   dart pub get
   

2. Create a Dart file (like lib/main.dart) with some messy inline functions:

   import 'package:flutter/material.dart';
   
   class MyWidget extends StatelessWidget {
     @override
     Widget build(BuildContext context) {
       return ElevatedButton(
         onPressed: () {
           // This will get flagged! 🚨
           print('Button pressed');
           showDialog(
             context: context,
             builder: (context) => AlertDialog(title: Text('Hello!')),
           );
         },
         child: Text('Press me'),
       );
     }
   }
   

3. Run analysis:

   dart analyze
   

4. See the magic! You'll get a helpful warning suggesting to extract the function.

✨ What You'll See #

The linter will show warnings like:

Warning: Prefer extracting the callback to a separate widget method.

🔧 Fix It Like This #

class MyWidget extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return ElevatedButton(
      onPressed: _handleButtonPress,  // Much cleaner! ✨
      child: Text('Press me'),
    );
  }

  void _handleButtonPress() {
    print('Button pressed');
    showDialog(
      context: context,
      builder: (context) => AlertDialog(title: Text('Hello!')),
    );
  }
}

🎯 Pro Tips #

• The linter only flags complex inline functions (with multiple statements)
• One-liners like () => print('hello') are totally fine
• Builder functions like ListView.builder() are automatically ignored

Happy coding! 🎉