README

Laravel Trash Cleaner is a lightweight and powerful utility package that helps you keep your Laravel application clean and performant by:

• 🧹 Deleting debug and log files (Clockwork, Debugbar).
• ⚡ Clearing compiled view caches and frontend build directories.
• 🛠️ Optionally rebuilding frontend assets using tools like npm, yarn, or pnpm.

🚀 Installation

Install the package via Composer:

composer require omaralalwi/laravel-trash-cleaner

🔧 Publish Configuration

Optionally, publish the configuration file to customize paths and build settings:

php artisan vendor:publish --tag=laravel-trash-cleaner

🧹 Usage

🔸 Clean Debug Files

Cleans out storage/debugbar and storage/clockwork folders with a progress bar:

php artisan trash:clean

🔸 Clean Asset Folders

Removes frontend-related build caches and compiled view files based on your config:

php artisan trash:clean-assets

🔸 Clean + Rebuild Frontend (Optional)

Use the --build flag to also run your frontend build steps (npm install && npm run build or equivalent):

php artisan trash:clean-assets --build

This is ideal for resetting the build process after switching branches, clearing corrupted caches, or deploying updates.

customize Assets paths & commnds

Note: You can fully customize the asset cleanup paths and build commands in the configuration file. For example, if you're using pnpm instead of the default npm, make sure to update the config key to 'package_manager' => 'pnpm'.

⏰ Scheduling Automatic Cleanup

To automate cleanup using Laravel's scheduler:

1. Enable it in your config:

'schedule' => true,
'frequency' => 'daily',

1. Ensure Laravel's scheduler is running via cron:

* * * * * cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1

🤝 Contributing

Contributions are welcome! Please see CONTRIBUTING for details.

🛡️ Security

If you discover any security vulnerabilities, please contact: omaralwi2010@gmail.com

📄 License

Licensed under the MIT License.

📚 Helpful Open Source Packages

• Lexi Translate simplify managing translations for multilingual Eloquent models with power of morph relationships and caching .

• Gpdf Open Source HTML to PDF converter for PHP & Laravel Applications, supports Arabic content out-of-the-box and other languages..

• laravel Taxify Laravel Taxify provides a set of helper functions and classes to simplify tax (VAT) calculations within Laravel applications.

• laravel Deployer Streamlined Deployment for Laravel and Node.js apps, with Zero-Downtime and various environments and branches.

• laravel Time Craft simple trait and helper functions that allow you, Effortlessly manage date and time queries in Laravel apps.

• Laravel Startkit Laravel Admin Dashboard, Admin Template with Frontend Template, for scalable Laravel projects.