Release v3.1.0 - Critical Bug Fixes & Compatibility Improvements

🐛 Critical Bug Fixes:
- #164: Debug tools compatibility (Debugbar, Horizon, Telescope, Ignition, Clockwork)
- #165: Livewire & Filament compatibility (wire:* directives)
- #166: Scripts and Livewire not running (related to #165)
- #167: URLs in JavaScript preserved (http://, https://)
- #170: Code blocks preservation (<pre>, <code>, <textarea>)

✅ Enhancements:
- ServiceProvider configuration key fixed
- Custom debug tool routes support documented
- Livewire/Alpine.js spacing preservation
- 117 tests, 501 assertions, 100% passing

📚 Documentation:
- Complete README updates with compatibility badges
- RELEASE_v3.1.0.md with comprehensive changelog
- Config file with detailed comments for custom routes

Author: renatomarinho

README.md

@@ -65,6 +65,10 @@ This middleware invoke **RemoveComments::class** filter before executation.
 
 > **Note**: Do not register the "RemoveComments::class" filter with it. Because it will be called automatically by "CollapseWhitespace::class"
 
+> **Important**: Whitespace is automatically **preserved** inside `<pre>`, `<code>`, and `<textarea>` tags to maintain proper formatting for code blocks and user input fields. This makes it safe to use on blogs, documentation sites, and technical content. (Issue [#170](https://github.com/vinkius-labs/laravel-page-speed/issues/170))
+
+> **✅ Livewire & Filament Compatible**: Fully compatible with [Laravel Livewire](https://laravel-livewire.com/) and [Filament](https://filamentphp.com/). The middleware preserves the necessary spacing between HTML tags to ensure `wire:*` directives and Alpine.js `x-*` attributes work correctly. (Issue [#165](https://github.com/vinkius-labs/laravel-page-speed/issues/165))
+
 #### Before
 
 ![Before of Laravel Page Speed][link-before]
@@ -130,6 +134,14 @@ You would probably like to configure the package to skip some routes.
 
 //You can use * as wildcard.
 'skip' => [
+    // Development/Debug Tools (automatically skipped by default)
+    '_debugbar/*',      // Laravel Debugbar
+    'horizon/*',        // Laravel Horizon  
+    '_ignition/*',      // Laravel Ignition (error pages)
+    'telescope/*',      // Laravel Telescope
+    'clockwork/*',      // Clockwork
+    
+    // Binary/Document Files
     '*.pdf', //Ignore all routes with final .pdf
     '*/downloads/*',//Ignore all routes that contain 'downloads'
     'assets/*', // Ignore all routes with the 'assets' prefix
@@ -140,6 +152,19 @@ By default this field comes configured with some options, so feel free to config
 
 > *Notice*: This package skip automatically 'binary' and 'streamed' responses. See [File Downloads][link-file-download].
 
+> **✅ Development Tools Compatible**: Development and debugging tools like **Laravel Debugbar**, **Horizon**, **Telescope**, **Ignition**, and **Clockwork** are automatically skipped by default, ensuring they work correctly without interference from HTML minification. (Issue [#164](https://github.com/vinkius-labs/laravel-page-speed/issues/164))
+
+> **⚠️ Important for Custom Routes**: If you've customized the routes for debug tools in your application (e.g., Horizon at `/admin/horizon` instead of `/horizon`), you MUST update the skip patterns in your config file to match your custom routes. For example:
+> ```php
+> 'skip' => [
+>     'admin/horizon/*',      // Custom Horizon route
+>     'debug/telescope/*',    // Custom Telescope route
+>     '_debugbar/*',          // Debugbar (usually fixed)
+>     // ... other routes
+> ],
+> ```
+> See your `HorizonServiceProvider`, `TelescopeServiceProvider`, or other debug tool configurations for custom path settings.
+
 ## Testing
 
 ```sh

config/laravel-page-speed.php

@@ -21,8 +21,26 @@
     | Skip Routes paths to exclude.
     | You can use * as wildcard.
     |
+    | Development/Debug Tools (Issue #164):
+    | If you've customized the routes for debug tools in your application
+    | (e.g., Horizon at '/admin/horizon' or Telescope at '/debug/telescope'),
+    | you MUST update these patterns to match your custom routes.
+    |
+    | Examples of custom routes:
+    |   'admin/horizon/*'      // Horizon::routes(['domain' => null, 'path' => 'admin/horizon'])
+    |   'debug/telescope/*'    // Telescope::$path = 'debug/telescope'
+    |   'my-path/clockwork/*'  // Custom Clockwork path
+    |
     */
     'skip' => [
+        // Development/Debug Tools (Issue #164)
+        '_debugbar/*',    // Laravel Debugbar (usually fixed path)
+        'horizon/*',      // Laravel Horizon (default, change if customized)
+        '_ignition/*',    // Laravel Ignition - Error Pages (usually fixed path)
+        'clockwork/*',    // Clockwork (default, change if customized)
+        'telescope/*',    // Laravel Telescope (default, change if customized)
+
+        // Binary/Document Files
         '*.xml',
         '*.less',
         '*.pdf',

src/Middleware/CollapseWhitespace.php

@@ -4,20 +4,94 @@
 
 class CollapseWhitespace extends PageSpeed
 {
+    /**
+     * Tags where whitespace should be preserved
+     * 
+     * Note: <script> and <style> are NOT included because:
+     * - JavaScript and CSS minification is handled by their specific optimizers
+     * - Collapsing whitespace in JS/CSS is generally safe and desired
+     * - This middleware focuses on preserving user-visible formatted content
+     */
+    protected const PRESERVE_TAGS = [
+        'pre',
+        'code',
+        'textarea',
+    ];
+
+    /**
+     * Apply whitespace collapse to buffer while preserving content in specific tags
+     */
     public function apply($buffer)
     {
+        // First remove comments
+        $buffer = $this->removeComments($buffer);
+
+        // Extract and preserve content from whitespace-sensitive tags
+        $preserved = [];
+        $buffer = $this->extractPreservedContent($buffer, $preserved);
+
+        // Apply whitespace collapse to the remaining content
         $replace = [
             "/\n([\S])/" => '$1',
             "/\r/" => '',
             "/\n/" => '',
             "/\t/" => '',
             "/ +/" => ' ',
-            "/> +</" => '><',
+            // Keep one space between tags for Livewire/Alpine.js compatibility (Issue #165)
+            // This prevents breaking wire:* directives and x-* attributes
+            "/> +</" => '> <',
         ];
 
-        return $this->replace($replace, $this->removeComments($buffer));
+        $buffer = $this->replace($replace, $buffer);
+
+        // Restore preserved content
+        $buffer = $this->restorePreservedContent($buffer, $preserved);
+
+        return $buffer;
+    }
+
+    /**
+     * Extract content from tags that should preserve whitespace
+     */
+    protected function extractPreservedContent(string $buffer, array &$preserved): string
+    {
+        $index = 0;
+
+        foreach (self::PRESERVE_TAGS as $tag) {
+            // Match opening and closing tags with all content in between
+            // This regex handles:
+            // - Tags with or without attributes
+            // - Self-closing tags (though not common for these tags)
+            // - Nested content
+            // - Case-insensitive matching
+            $pattern = '/<(' . $tag . ')(\s[^>]*)?>(.*?)<\/\1>/is';
+
+            $buffer = preg_replace_callback($pattern, function ($matches) use (&$preserved, &$index) {
+                $placeholder = "___PRESERVED_CONTENT_{$index}___";
+                $preserved[$placeholder] = $matches[0]; // Store the entire tag with content
+                $index++;
+                return $placeholder;
+            }, $buffer);
+        }
+
+        return $buffer;
+    }
+
+    /**
+     * Restore preserved content back into the buffer
+     */
+    protected function restorePreservedContent(string $buffer, array $preserved): string
+    {
+        foreach ($preserved as $placeholder => $content) {
+            $buffer = str_replace($placeholder, $content, $buffer);
+        }
+
+        return $buffer;
     }
 
+    /**
+     * Remove comments before collapsing whitespace
+     */
     protected function removeComments($buffer)
     {
         return (new RemoveComments)->apply($buffer);

src/ServiceProvider.php

@@ -21,6 +21,6 @@ public function boot(): void
      */
     public function register(): void
     {
-        $this->mergeConfigFrom(__DIR__ . '/../config/laravel-page-speed.php', 'laravel-page-speed.php');
+        $this->mergeConfigFrom(__DIR__ . '/../config/laravel-page-speed.php', 'laravel-page-speed');
     }
 }

tests/Boilerplate/issue-170-comments.html

@@ -0,0 +1,50 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <title>Issue #170 - JavaScript Comment Problem</title>
+</head>
+<body>
+    <h1>Testing JavaScript Comments After Statements</h1>
+    
+    <script>
+        // Test Case 1: Comment after console.log without semicolon
+        console.log('foo'); // undefined
+        var foo = 'bar';
+        console.log(foo); // bar
+        
+        // Test Case 2: Multiple statements with comments
+        var x = 10; // initialize x
+        var y = 20; // initialize y
+        var z = x + y; // sum
+        console.log(z); // should print 30
+        
+        // Test Case 3: Comment after statement without semicolon
+        var name = 'John' // no semicolon here
+        console.log(name) // should print John
+        
+        // Test Case 4: Comment after function call without semicolon
+        alert('test') // show alert
+        console.log('after alert') // this should work
+        
+        // Test Case 5: If statement with comment
+        if (true) { // condition
+            console.log('inside if'); // log
+        } // end if
+        
+        // Test Case 6: Comment with URLs (should preserve http://)
+        var url = "http://example.com"; // website URL
+        var secure = "https://example.com"; // secure URL
+        
+        // Test Case 7: Return statement
+        function test() {
+            return 42; // answer
+        }
+        
+        // Test Case 8: Array with comment
+        var arr = [1, 2, 3]; // numbers
+        var first = arr[0]; // get first
+    </script>
+    
+    <p>Check console for results</p>
+</body>
+</html>