Unused Code Cleaner #

A powerful Flutter package to identify and remove unused assets, functions, packages, and files from your project, keeping your codebase clean and optimized with beautiful colored logging.

🚀 Features

• 🖼️ Asset Analysis: Detects unused images, fonts, JSON files, and other assets declared in pubspec.yaml.
• ⚡ Function Analysis: Identifies unused functions and methods using Dart's AST (Abstract Syntax Tree).
• 📦 Package Analysis: Finds unused dependencies listed in pubspec.yaml.
• 📄 File Analysis: Locates unused Dart files not imported anywhere in the project.
• 🎨 Colored Logging: Provides clear, emoji-enhanced, colored console output for easy debugging.
• 🔧 Interactive Mode: Prompts for confirmation before removing unused items.
• 📊 Detailed Reports: Generates comprehensive analysis reports with file sizes and descriptions.
• 🛠 Customizable: Supports exclude patterns, include paths, and configuration via unused_code_cleaner.yaml.
• ✅ Cross-Platform: Works seamlessly with Flutter projects on all platforms.

📦 Installation

Add the package to your dev_dependencies in pubspec.yaml:

dev_dependencies:
  unused_code_cleaner: ^1.0.0

Then, fetch the dependencies:

dart pub get

To use as a command-line tool, activate it globally:

dart pub global activate unused_code_cleaner

🔧 Usage #

Command Line #

Analyze your project for unused items:

unused_code_cleaner

Remove all unused items (interactive mode):

unused_code_cleaner --all

Remove specific types of unused items:

unused_code_cleaner --assets --packages

Enable verbose logging:

unused_code_cleaner --verbose

Exclude specific patterns:

unused_code_cleaner --exclude "**/*.g.dart" --exclude "**/*.freezed.dart"

Specify a custom project path:

unused_code_cleaner --path=/path/to/your/project

Programmatic Usage #

Use the package in your Dart code:

```dart
import 'package:unused_code_cleaner/unused_code_cleaner.dart';

void main() async {
  final cleaner = UnusedCodeCleaner();
  final options = CleanupOptions(
    removeUnusedAssets: true,
    removeUnusedPackages: true,
    verbose: true,
    interactive: true,
    excludePatterns: ['**/*.g.dart', '**/*.freezed.dart'],
  );

  try {
    final result = await cleaner.analyze('.', options);
    print('Found ${result.totalUnusedItems} unused items in ${result.analysisTime.inMilliseconds}ms');
  } catch (e) {
    print('Error: $e');
  }
}

🛠 Advanced Options #

🛠 Configuration File #

Create an unused_code_cleaner.yaml file in your project root for advanced configuration:

```yaml
analysis:
  verbose: true
  interactive: true
  exclude_patterns:
    - "**/*.g.dart"
    - "**/*.freezed.dart"
    - "**/generated/**"
  include_paths:
    - lib/
    - test/

assets:
  enabled: true
  directories:
    - assets/
    - images/
    - fonts/
    - data/

functions:
  enabled: true
  preserve:
    - main
    - build
    - initState

packages:
  enabled: true
  preserve:
    - flutter
    - flutter_test

files:
  enabled: true
  preserve:
    - lib/main.dart
    - test/**

💡 Example Output #

🔍 UNUSED CODE CLEANER - ANALYSIS STARTED
ℹ️ [12:34:56] Found 42 Dart files to analyze
✅ [12:34:56] Project structure validated

📦 ANALYZING ASSETS
ℹ️ [12:34:57] Found 3 unused assets

⚡ ANALYZING FUNCTIONS
ℹ️ [12:34:57] Found 2 unused functions

📦 ANALYZING PACKAGES
ℹ️ [12:34:57] Found 1 unused package

📄 ANALYZING FILES
ℹ️ [12:34:57] Found 1 unused file

📊 ANALYSIS RESULTS
ℹ️ [12:34:57] Analysis completed in 123ms
ℹ️ [12:34:57] Total files scanned: 42
ℹ️ [12:34:57] Total unused items found: 7

Unused Assets (3 items)
┌──────────────────────────────────────────────────┐
│ Name              │ Path                  │ Size │ Description         │
├──────────────────────────────────────────────────┤
│ 🖼️ unused.png     │ assets/unused.png     │ 1.2MB│ Unused asset file   │
│ 🖼️ old.json       │ assets/data/old.json  │ 0.5KB│ Unused asset file   │
│ 🖼️ unused.svg     │ assets/unused.svg     │ 0.8MB│ Unused asset file   │
└──────────────────────────────────────────────────┘

❓ Do you want to remove these assets? (y/N)

📊 Accuracy Testing #

The package was tested against real-world Flutter projects to ensure reliability:

Tests confirmed accurate detection of unused assets, functions, packages, and files, with robust handling of edge cases like generated files and special functions.

🎯 Roadmap #

🚀 Upcoming Features: #

• ✅ Support for automatic function removal using AST manipulation
• ❌ Integration with CI/CD pipelines for automated cleanup
• ❌ Support for additional file types (e.g., TypeScript, Kotlin)
• ❌ Generate detailed HTML/PDF reports
• ❌ VS Code extension for real-time analysis

🤝 Contributing #

We welcome contributions! Please submit issues, feature requests, or pull requests on GitHub. Follow these steps:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/your-feature)
3. Commit your changes (git commit -m "Add your feature")
4. Push to the branch (git push origin feature/your-feature)
5. Open a pull request

📬 Contact #

📩 Need help? Reach out at [[email protected]] or open an issue on GitHub.

📜 License #

📄 This project is licensed under the MIT License.