Laravel Vendor Cleanup

Laravel Vendor Cleanup stats

Downloads
763
Stars
9
Open Issues
3
Forks
0

View on GitHub →

Laravel commands to detect and clean up unchanged vendor-published files (configs, migrations, views, lang files)

Laravel Vendor Cleanup

Detect and clean up unchanged vendor-published files in your Laravel application.

image

This package provides Artisan commands to compare published vendor files (configs, migrations, views, lang files) with their originals in the vendor directory. Find out which files you've modified, which are identical to vendor (cruft), and which files are orphaned from removed packages.

Features

  • 🔍 Smart Comparison - Automatically strips PHP comments and optionally normalizes whitespace
  • 📊 Diff Percentages - See exactly how different your files are from vendor originals
  • 🎨 Color-Coded Output - Green/yellow/magenta/red based on difference percentage
  • 🗑️ Safe Cleanup - Optionally delete unchanged files with confirmation
  • 🏷️ Orphan Detection - Find files from uninstalled packages
  • 📦 Handles Timestamps - Smart migration filename matching (strips timestamps)
  • 🔧 Stub Support - Detects both .php and .php.stub vendor files

Installation

composer require leek/laravel-vendor-cleanup --dev

The package will auto-register via Laravel's package discovery.

Usage

Config Files

Compare published config files with vendor originals:

php artisan vendor-cleanup:config

With options:

# Delete unchanged config files after confirmation
php artisan vendor-cleanup:config --delete
 
# Normalize whitespace in addition to stripping comments
php artisan vendor-cleanup:config --normalize

Migration Files

Compare published migrations with vendor originals (handles timestamped filenames):

php artisan vendor-cleanup:migration

Lang Files

Compare published language files (supports nested directories and JSON files):

php artisan vendor-cleanup:lang

View Files

Compare published view files in resources/views/vendor/:

php artisan vendor-cleanup:view

Output Categories

Each command categorizes files into four groups:

MODIFIED (color-coded by % different)

Files you've customized, sorted by difference percentage:

  • 🟢 Green (< 5%) - Very minor changes
  • 🟡 Yellow (< 15%) - Small changes
  • 🟣 Magenta (< 30%) - Moderate changes
  • 🔴 Red (≥ 30%) - Significant changes

UNCHANGED

Files identical to vendor - potential candidates for deletion to reduce cruft.

ORPHANED

Files with no vendor counterpart - either from removed packages or your own application-specific files.

MISSING

Vendor files not yet published locally - available if you need them.

How It Works

  1. Finds all vendor files matching the file type (configs, migrations, etc.)
  2. Strips PHP comments from both vendor and local files for comparison
  3. Optionally normalizes whitespace with --normalize flag
  4. Compares files using SHA256 hashing and similarity algorithms
  5. Categorizes results and displays with color-coded diff percentages

For migrations, the command intelligently strips timestamps from filenames before matching (e.g., 2024_01_15_123456_create_jobs_table.php matches create_jobs_table.php).

Options

All commands support these options:

  • --delete - Interactively delete unchanged files after showing results
  • --normalize - Also normalize whitespace and line endings (comments are always ignored)

Why Use This?

  • Reduce Cruft - Delete unchanged published files and rely on vendor defaults
  • Track Customizations - Quickly see which vendor files you've modified
  • Find Orphans - Identify leftover files from removed packages
  • Upgrade Confidence - Know exactly what you've changed before upgrading packages

Example Output

MODIFIED
+----------------------+------------+
| File | Difference |
+----------------------+------------+
| config/services.php | 65.3% |
| config/app.php | 38% |
| config/database.php | 9.8% |
+----------------------+------------+
 
UNCHANGED (matches vendor)
+------------------------+--------------------+
| File | File |
+------------------------+--------------------+
| config/filesystems.php | config/mail.php |
| config/cache.php | config/session.php |
+------------------------+--------------------+
 
ORPHANED (no vendor counterpart)
+---------------------------+------------------------------+
| File | File |
+---------------------------+------------------------------+
| config/custom-package.php | config/old-dependency.php |
+---------------------------+------------------------------+
 
MISSING (not published locally)
+------------------------------------+-------------------------------------+
| File | File |
+------------------------------------+-------------------------------------+
| vendor/package/config/optional.php | vendor/another/config/settings.php |
+------------------------------------+-------------------------------------+
 
Done.

Requirements

  • PHP 8.2+
  • Laravel 11.x or 12.x

License

MIT

leek photo

Web Application Architect and Developer with a passion for helping businesses make sense of web-based technology and its numerous applications.

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.


Leek Laravel Vendor Cleanup Related Articles

Laravel Introduces Official AI Documentation image

Laravel Introduces Official AI Documentation

Read article
Creating Multi-Stage Docker Builds for Laravel image

Creating Multi-Stage Docker Builds for Laravel

Read article
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Multi-tenant Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit
Tighten logo

Tighten

We help companies turn great ideas into amazing apps, products, and services.

Tighten
Harpoon: Next generation time tracking and invoicing logo

Harpoon: Next generation time tracking and invoicing

The next generation time-tracking and billing software that helps your agency plan and forecast a profitable future.

Harpoon: Next generation time tracking and invoicing
Typesense Search logo

Typesense Search

Typesense is an open source, blazing-fast search engine, optimized for helping you build delightful search experiences for your sites and apps. Natively integrated with Laravel Scout.

Typesense Search
PhpStorm logo

PhpStorm

The go-to PHP IDE with extensive out-of-the-box support for Laravel and its ecosystem.

PhpStorm
Securing Laravel logo

Securing Laravel

The essential security resource for Laravel devs, covering everything you need to keep your apps secure. Sign up to receive weekly security tips and monthly in depth articles, diving deep into security concepts you need to know!

Securing Laravel