restructure README optional features

made Writer constructor props readonly

Author: onlime

README.md

@@ -67,7 +67,20 @@ It reports a lot of metadata like total query count, total execution time, origi
 
 5. Make sure on live server you will set logging SQL queries to false in your `.env` file: `SQL_REPORTER_QUERIES_ENABLED=false`. This package is recommended to be used only for development to not impact production application performance.
 
-## `QueryLogWritten` event
+## Optional
+
+### GeoIP support
+
+For optional GeoIP support (adding country information to client IP in log headers), you may install [stevebauman/location](https://github.com/stevebauman/location) in your project:
+
+```bash
+$ composer require stevebauman/location
+$ php artisan vendor:publish --provider="Stevebauman\Location\LocationServiceProvider"
+```
+
+It will be auto-detected, no configuration needed for this. If you wish to use a different driver than the default [IpApi](https://ip-api.com/), e.g. `MaxMind` make sure you correctly configure it according to the docs: [Available Drivers](https://github.com/stevebauman/location#available-drivers)
+
+### `QueryLogWritten` event
 
 This package fires a `QueryLogWritten` event after the log file has been written. You may use this event to further debug or analyze the logged queries in your application. The queries are filtered by the `SQL_REPORTER_QUERIES_REPORT_PATTERN` setting, which comes with a sensible default to exclude `SELECT` queries and some default tables like `sessions`, `jobs`, `bans`, `logins`. If you don't want to filter any queries, you may leave this setting empty.
 
@@ -83,16 +96,7 @@ Writer::shouldReportQuery(function (SqlQuery $query) {
 });
 ```
 
-## Optional
-
-For optional GeoIP support (adding country information to client IP in log headers), you may install [stevebauman/location](https://github.com/stevebauman/location) in your project:
-
-```bash
-$ composer require stevebauman/location
-$ php artisan vendor:publish --provider="Stevebauman\Location\LocationServiceProvider"
-```
-
-It will be auto-detected, no configuration needed for this. If you wish to use a different driver than the default [IpApi](https://ip-api.com/), e.g. `MaxMind` make sure you correctly configure it according to the docs: [Available Drivers](https://github.com/stevebauman/location#available-drivers)
+With the `SqlQuery` object, you have access to both `$rawQuery` and the (unprepared) `$query`/`$bindings`. The filter possibilities by providing a callback to `Writer::shouldReportQuery()` are endless!
 
 ## Development
 
@@ -103,10 +107,10 @@ $ git clone https://github.com/onlime/laravel-sql-reporter.git
 $ cd laravel-sql-reporter
 $ composer install
 
-# run unit tests
-$ vendor/bin/phpunit
+# run both Feature and Unit tests
+$ vendor/bin/pest
 # run unit tests with coverage report
-$ XDEBUG_MODE=coverage vendor/bin/phpunit
+$ vendor/bin/pest --coverage
 ```
 
 ## FAQ
@@ -168,8 +172,8 @@ All changes are listed in [CHANGELOG](CHANGELOG.md)
 
 ## Caveats
 
-- If your application crashes, this package will not log any queries, as logging is only triggered at the end. As alternative, you could use [mnabialek/laravel-sql-logger](https://github.com/mnabialek/laravel-sql-logger) which triggers sql logging on each query execution.
-- It's currently not possible to log slow queries into a separate logfile. I wanted to keep that package simpel.
+- If your application crashes, this package will not log any queries, as logging is only triggered at the end of the request cycle. As alternative, you could use [mnabialek/laravel-sql-logger](https://github.com/mnabialek/laravel-sql-logger) which triggers sql logging on each query execution.
+- It's currently not possible to log slow queries into a separate logfile. I wanted to keep that package simple.
 
 ## TODO
 

src/Providers/SqlReporterServiceProvider.php

@@ -17,7 +17,7 @@ class SqlReporterServiceProvider extends ServiceProvider
     /**
      * {@inheritdoc}
      */
-    public function register()
+    public function register(): void
     {
         $this->config = $this->app->make(Config::class);
 
@@ -31,7 +31,7 @@ public function register()
     /**
      * {@inheritdoc}
      */
-    public function boot()
+    public function boot(): void
     {
         $this->publishes([
             $this->configFileLocation() => config_path('sql-reporter.php'),

src/Writer.php

@@ -29,9 +29,9 @@ class Writer
     private static ?Closure $shouldReportQuery = null;
 
     public function __construct(
-        private Formatter $formatter,
-        private Config $config,
-        private FileName $fileName
+        private readonly Formatter $formatter,
+        private readonly Config $config,
+        private readonly FileName $fileName
     ) {
     }