README

A Composer plugin that analyzes Laravel applications and removes unused dependencies from the vendor folder. This package is designed to run automatically as a pre-autoload-dump script to keep your vendor directory clean and reduce deployment size.

Features

Automatic Analysis: Scans your Laravel application files to detect used classes and namespaces
Smart Detection: Uses PHP Parser to analyze PHP files and extract usage patterns
Configurable: Customize which directories to scan and which packages to exclude
Safe Operation: Supports dry-run mode to preview changes before applying them
Laravel Optimized: Specifically designed for Laravel applications with sensible defaults

Installation

As a Composer Plugin

Install the package:

composer require kytoonlabs/composer-cleanup --dev

The plugin will automatically register and run during composer dump-autoload

Manual Installation

Clone this repository:

git clone https://github.com/your-username/composer-cleanup.git
cd composer-cleanup

Install dependencies:

composer install

Run the cleanup script:

php bin/cleanup.php

Usage

Automatic Mode (Recommended)

The plugin runs automatically when you execute:

composer dump-autoload

Manual Mode

You can also run the cleanup manually:

composer cleanup

Configuration

Create a composer-cleanup.json file in your project root to customize the behavior:

{
  "scan_directories": [
    "app",
    "config",
    "database",
    "resources",
    "routes",
    "tests"
  ],
  "exclude_directories": [
    "vendor",
    "node_modules",
    "storage",
    "bootstrap/cache"
  ],
  "exclude_packages": [
    "laravel/framework",
    "laravel/tinker",
    "laravel/sanctum",
    "laravel/telescope",
    "laravel/horizon",
    "laravel/nova"
  ],
  "exclude_package_types": ["composer-plugin", "metapackage"],
  "dry_run": false,
  "verbose": false
}

Configuration Options

scan_directories: Directories to scan for PHP files (relative to project root)
exclude_directories: Directories to exclude from scanning
exclude_packages: Package names to never remove (supports partial matches)
exclude_package_types: Package types to never remove
dry_run: If true, shows what would be removed without actually removing
verbose: If true, shows detailed error messages during parsing

How It Works

File Scanning: The plugin scans all PHP files in your Laravel application directories
AST Analysis: Uses PHP Parser to create an Abstract Syntax Tree and extract:
- use statements (imported namespaces)
- new expressions (instantiated classes)
- Static method calls
- Class constant access
Package Analysis: Examines each installed package's autoload configuration
Usage Detection: Determines if a package's classes are actually used in your code
Cleanup: Removes packages that are not referenced in your application

Safety Features

Dry Run Mode: Test the cleanup without actually removing files
Exclusion Lists: Protect important packages from being removed
Laravel Framework Protection: Automatically excludes Laravel core packages
Plugin Protection: Never removes Composer plugins
Verbose Logging: Detailed output for debugging

Example Output

Starting Laravel vendor cleanup...
Analyzing Laravel application for used classes...
Found 3 potentially unused packages:
  - monolog/monolog
  - symfony/console
  - guzzlehttp/guzzle
Removed unused package: monolog/monolog
Removed unused package: symfony/console
Removed unused package: guzzlehttp/guzzle
Vendor cleanup completed successfully!

Development

Running Tests

composer test

Building

composer install

Contributing

Fork the repository
Create a feature branch
Make your changes
Add tests
Submit a pull request

License

This package is open-sourced software licensed under the Apache 2.0 license.

Disclaimer

This tool analyzes static code and may not detect all dynamic usage patterns. Always test your application thoroughly after running the cleanup, especially in production environments. Consider using dry-run mode first to review what would be removed.

kytoonlabs / composer-cleanup

Maintainers

Details