Download the PHP package marekmiklusek/auditor without Composer
On this page you can find all versions of the php package marekmiklusek/auditor. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download marekmiklusek/auditor
More information about marekmiklusek/auditor
Files in marekmiklusek/auditor
Package auditor
Short Description A package that provides auditing for: dd(), dump(), // FIXME:, // TODO:, and more...
License MIT
Informations about the package auditor
๐ Laravel Auditor
A Laravel package that helps you audit your codebase for debugging statements and task-related comments that should not make it to production, such as:
- ๐ฅ
dd()
debug statements - ๐ฎ
dump()
debug statements - โ
// TODO:
comments - ๐ ๏ธ
// FIXME:
comments
๐ Requirements
- PHP 8.3 or higher
- Laravel 12.17 or higher
๐ฅ Installation
You can install the package via Composer:
๐ Usage
๐ Audit Your Code
Run the following command to scan your codebase for debugging statements and task-related comments:
This will scan the following directories for PHP and Blade files:
- ๐ app
- ๐ config
- ๐ database
- ๐ resources
- ๐ routes
- ๐ tests
The command will display a list of all found issues with their file paths, line numbers, and content.
๐ง Fixing Issues
You can automatically remove the detected issues using the --fix
option:
๐ Example Output
When running the audit command, you'll see output similar to this:
After fixing:
๐ก Why Use This Package?
- ๐ก๏ธ Code Quality: Prevent debugging code from accidentally being deployed to production
- ๐ Task-Related comments: Keep track of TODOs and FIXMEs comments in your codebase
- ๐ฆ Pre-Deployment Check: Run as part of your CI/CD pipeline to ensure clean code
- ๐งน Simple Cleanup: Easily remove all debugging statements with a single command
๐ค Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
๐ License
The MIT License (MIT). Please see License File for more information.