dead_code_analyzer 1.1.0

A tool to analyze and identify dead/unused code in Dart and Flutter projects.

example/dead_code_analyzer.dart

import 'package:dead_code_analyzer/src/collecter/class_collector.dart';
import 'package:dead_code_analyzer/src/model/class_info.dart';

final ckassTestFile = '''
  // This widget is the home page of your application. It is stateful, meaning
  // that it has a State object (defined below) that contains fields that affect
  // how it looks.

  // This class is the configuration for the state. It holds the values (in this
  // case the title) provided by the parent (in this case the App widget) and
  // used by the build method of the State. Fields in a Widget subclass are
  // always marked "final".
 
  // class CommentedOutClass {
  //   void commentedOutFunction() {
  //     // This function is commented out
  //   }
  //}
  class MyHomePage extends StatefulWidget {
    const MyHomePage({super.key, required this.title});
    final String title;

    @override
    State<MyHomePage> createState() => _MyHomePageState();
  }

  class _MyHomePageState extends State<MyHomePage> {
    int _counter = 0;

    void _incrementCounter() {
      setState(() {
        _counter++;
      });
    }

    @override
    Widget build(BuildContext context) {
      return Scaffold(
        appBar: AppBar(
          title: Text(widget.title),
        ),
        body: Center(
          child: Text('You have pushed the button \$_counter times'),
        ),
        floatingActionButton: FloatingActionButton(
          onPressed: _incrementCounter,
          child: Icon(Icons.add),
        ),
      );
    }
  }
  /* class CommentedClass { 
  void commentedFunction() {
    // This function is commented out
  }
  }*/
''';

void classAnalyzerTest() {
  final lines = ckassTestFile.split('\n');
  final pragmaRegex =
      RegExp(r'''@\s*pragma\s*\(\s*[\'"]vm:entry-point[\'"]\s*\)''');
  Map<String, ClassInfo> classes = {};
  bool insideStateClass = false;

  for (int lineIndex = 0; lineIndex < lines.length; lineIndex++) {
    String line = lines[lineIndex];
    var classMatch = RegExp(
      r'^(?:sealed\s+|abstract\s+|mixin\s+)?class\s+([A-Za-z_][A-Za-z0-9_]*)\s*(?:extends\s+[A-Za-z_][A-Za-z0-9_]*\s*)?(?:implements\s+[A-Za-z_][A-Za-z0-9_]*(?:\s*,\s*[A-Za-z_][A-Za-z0-9_]*)*\s*)?(?:with\s+[A-Za-z_][A-Za-z0-9_]*(?:\s*,\s*[A-Za-z_][A-Za-z0-9_]*)*\s*)?{',
      multiLine: true,
    ).firstMatch(line.replaceFirst(RegExp(r'^\s*//+\s*'), ''));

    classCollector(
      classMatch,
      lineIndex,
      pragmaRegex,
      lines,
      classes,
      'text_class_file.dart',
      insideStateClass,
    );

    // Update insideStateClass
    if (classMatch != null &&
        line
            .replaceFirst(RegExp(r'^\s*//+\s*'), '')
            .contains('extends State<')) {
      insideStateClass = true;
    } else if (insideStateClass && line.trim().contains('}')) {
      insideStateClass = false;
    }
  }

  print('Commented Classes');
  print('------------------------------');
  classes.forEach((name, info) {
    if (info.commentedOut) {
      print(
          ' - $name (in ${info.definedInFile}, internal references: 0, external references: 0, total: 0) []');
    }
  });

  print('\nNon-Commented Classes');
  print('------------------------------');
  classes.forEach((name, info) {
    if (!info.commentedOut) {
      print(
          ' - $name (in ${info.definedInFile}, type: ${info.type}, entryPoint: ${info.isEntryPoint})');
    }
  });

  print('\nNon-Commented State Classes');
  print('------------------------------');
  classes.forEach((name, info) {
    if (info.type == 'state_class') {
      print(
          ' - $name (in ${info.definedInFile}, type: ${info.type}, entryPoint: ${info.isEntryPoint})');
    }
  });
}

void main() {
  classAnalyzerTest();
}