Merge pull request #37 from wvdongen/main

freekmurze · web-flow · commit 66bedb58376b · 2025-05-09T13:31:49.000+02:00
Add config option to exclude sections
diff --git a/README.md b/README.md
@@ -90,7 +90,18 @@ return [
          */
         'includes' => [
 
-        ]
+        ],
+        
+        /**
+         * Add sections you don't want to be affected by the package here.
+         * These sections will not have HTML comments added around @yield directives
+         * For example:
+         *  'header',
+         *  'message',
+         */
+        'sections' => [
+
+        ],
     ]
 ];
 ```
@@ -103,6 +114,10 @@ After the package is installed, you'll immediately see that HTML comments are in
 Sometimes you might not want to have an HTML comment being wrapped around an include. For example when you use a partial to add some CSS to a page.
 In these cases you can add views to the `excludes.includes` array in the config file.
 
+## Excluding sections
+Sometimes you might not want HTML comments wrapping around `@yield` directives. For example when they're used within HTML attributes or meta tags.
+In these cases you can add sections to the `excludes.sections` array in the config file.
+
 ### Using your own Blade Commenters
 
 You can easily extend the package to add more comments. In the `blade_commenters` key of the `blade_commenters` config file, you can add your own `BladeCommenter`. A `BladeCommenter` is any class that implements the following interface:
diff --git a/config/blade-comments.php b/config/blade-comments.php
@@ -52,5 +52,16 @@
         'includes' => [
 
         ],
+
+        /**
+         * Add sections you don't want to be affected by the package here.
+         * These sections will not have HTML comments added around @yield directives
+         * For example:
+         *  'header',
+         *  'message',
+         */
+        'sections' => [
+
+        ],
     ],
 ];
diff --git a/src/Commenters/BladeCommenters/SectionCommenter.php b/src/Commenters/BladeCommenters/SectionCommenter.php
@@ -6,7 +6,16 @@ class SectionCommenter implements BladeCommenterWithCallback
 {
     public function pattern(): string
     {
-        return "/@yield(\((?:[^)(]+|(?1))*+\))(?![^<>]*<\/title>)/";
+        $excludes = config('blade-comments.excludes.sections', []);
+
+        if (count($excludes)) {
+            $excludesRegex = '(?!\s*[\'"](?:' . implode('|', $excludes) . ')[\'"])';
+            $regex = "/@yield(\({$excludesRegex}(?:[^)(]+|(?1))*+\))(?![^<>]*<\/title>)/";
+        } else {
+            $regex = "/@yield(\((?:[^)(]+|(?1))*+\))(?![^<>]*<\/title>)/";
+        }
+
+        return $regex;
     }
 
     public function replacementCallback(array $matches): string
diff --git a/tests/PrecompilerTests/BladeExtendsTest.php b/tests/PrecompilerTests/BladeExtendsTest.php
@@ -7,3 +7,19 @@
 
     assertMatchesHtmlSnapshot($renderedView);
 });
+
+it('should filter excluded sections', function () {
+    config(['blade-comments.excludes.sections' => ['excluded-section']]);
+    $renderedView = view('extends.page')->render();
+
+    assertMatchesHtmlSnapshot($renderedView);
+    expect($renderedView)->not->toContain('<!-- Start section: excluded-section -->');
+});
+
+it('will add comments for extends with invalid excluded sections', function () {
+    config(['blade-comments.excludes.sections' => ['exclude-section-that-does-not-exist']]);
+    $renderedView = view('extends.page')->render();
+
+    assertMatchesHtmlSnapshot($renderedView);
+    expect($renderedView)->toContain('<!-- Start section: excluded-section -->');
+});
diff --git a/tests/TestSupport/views/extends/layout.blade.php b/tests/TestSupport/views/extends/layout.blade.php
@@ -5,5 +5,6 @@
 <body>
     <h1>@yield('title', config('app.name'))</h1>
     @yield('content')
+    @yield('excluded-section')
 </body>
 </html>
diff --git a/tests/TestSupport/views/extends/page.blade.php b/tests/TestSupport/views/extends/page.blade.php
@@ -2,3 +2,6 @@
 @section('content')
     This is the content
 @endsection
+@section('excluded-section')
+    Depending on the config, this section should not be wrapped with a comment.
+@endsection
diff --git a/tests/__snapshots__/BladeExtendsTest__it_should_filter_excluded_sections__1.html b/tests/__snapshots__/BladeExtendsTest__it_should_filter_excluded_sections__1.html
@@ -0,0 +1,13 @@
+<!-- View extends: extends.layout --><html>
+<head>
+    <title>Laravel</title>
+</head>
+<body>
+    <h1>
+<!-- Start section: title -->Laravel<!-- End section: title -->
+</h1>
+    <!-- Start section: content -->    This is the content
+<!-- End section: content -->
+        Depending on the config, this section should not be wrapped with a comment.
+</body>
+</html>
diff --git a/tests/__snapshots__/BladeExtendsTest__it_will_add_comments_for_extends__1.html b/tests/__snapshots__/BladeExtendsTest__it_will_add_comments_for_extends__1.html
@@ -8,5 +8,7 @@ <h1>
 </h1>
     <!-- Start section: content -->    This is the content
 <!-- End section: content -->
+    <!-- Start section: excluded-section -->    Depending on the config, this section should not be wrapped with a comment.
+<!-- End section: excluded-section -->
 </body>
 </html>
diff --git a/tests/__snapshots__/BladeExtendsTest__it_will_add_comments_for_extends_with_invalid_excluded_sections__1.html b/tests/__snapshots__/BladeExtendsTest__it_will_add_comments_for_extends_with_invalid_excluded_sections__1.html
@@ -0,0 +1,14 @@
+<!-- View extends: extends.layout --><html>
+<head>
+    <title>Laravel</title>
+</head>
+<body>
+    <h1>
+<!-- Start section: title -->Laravel<!-- End section: title -->
+</h1>
+    <!-- Start section: content -->    This is the content
+<!-- End section: content -->
+    <!-- Start section: excluded-section -->    Depending on the config, this section should not be wrapped with a comment.
+<!-- End section: excluded-section -->
+</body>
+</html>
diff --git a/tests/__snapshots__/BladeIncludeTest__it_should_filter_blacklisted_includeIfs__1.html b/tests/__snapshots__/BladeIncludeTest__it_should_filter_blacklisted_includeIfs__1.html
diff --git a/tests/__snapshots__/BladeIncludeTest__it_should_filter_blacklisted_includeUnless__1.html b/tests/__snapshots__/BladeIncludeTest__it_should_filter_blacklisted_includeUnless__1.html
diff --git a/tests/__snapshots__/BladeIncludeTest__it_should_filter_blacklisted_includeWhens__1.html b/tests/__snapshots__/BladeIncludeTest__it_should_filter_blacklisted_includeWhens__1.html
diff --git a/tests/__snapshots__/BladeIncludeTest__it_should_filter_blacklisted_includes__1.html b/tests/__snapshots__/BladeIncludeTest__it_should_filter_blacklisted_includes__1.html

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,16 @@ class SectionCommenter implements BladeCommenterWithCallback`
`6`	`6`	`{`
`7`	`7`	`public function pattern(): string`
`8`	`8`	`{`
`9`		`- return "/@yield(\((?:[^)(]+\|(?1))+\))(?![^<>]<\/title>)/";`
	`9`	`+ $excludes = config('blade-comments.excludes.sections', []);`
	`10`	`+`
	`11`	`+ if (count($excludes)) {`
	`12`	`+ $excludesRegex = '(?!\s*[\'"](?:' . implode('\|', $excludes) . ')[\'"])';`
	`13`	`+ $regex = "/@yield(\({$excludesRegex}(?:[^)(]+\|(?1))+\))(?![^<>]<\/title>)/";`
	`14`	`+ } else {`
	`15`	`+ $regex = "/@yield(\((?:[^)(]+\|(?1))+\))(?![^<>]<\/title>)/";`
	`16`	`+ }`
	`17`	`+`
	`18`	`+ return $regex;`
`10`	`19`	`}`
`11`	`20`
`12`	`21`	`public function replacementCallback(array $matches): string`