Better file loading experience

Author: aarondfrancis

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+## 0.5.1 - 2021-09-06
+
+### Changed
+- When loading content from files using the `<<< path/to/file.php` convention, you can now wrap it in a comment e.g. `// <<<path/to.file.php`.
+
 ## 0.5.0 - 2021-09-06
 
 ### Changed

src/BaseExtension.php

@@ -147,7 +147,7 @@ protected function getContent($node)
         $content = $this->getLiteralContent($node);
 
         // Check for our file loading convention.
-        if (!Str::startsWith($content, '<<<')) {
+        if (!Str::contains($content, '<<<')) {
             return $content;
         }
 
@@ -158,6 +158,9 @@ protected function getContent($node)
             return $content;
         }
 
+        // Blow off the end of comments that require closing tags, e.g. <!-- -->
+        $file = head(explode(' ', $file));
+
         return Torchlight::processFileContents($file) ?: $content;
     }
 

tests/BaseRendererTest.php

@@ -140,6 +140,52 @@ public function can_load_file()
         });
     }
 
+    /** @test */
+    public function can_load_file_with_comment()
+    {
+        config()->set('torchlight.snippet_directories', [
+            __DIR__
+        ]);
+
+        $markdown = <<<'EOT'
+``` 
+// <<< Support/file1.php
+```
+EOT;
+
+        Http::fake();
+
+        $this->render($markdown);
+
+        Http::assertSent(function ($request) {
+            return $request['blocks'][0]['code'] === '// this is file 1';
+        });
+    }
+
+
+    /** @test */
+    public function can_load_file_with_two_part_comment()
+    {
+        config()->set('torchlight.snippet_directories', [
+            __DIR__
+        ]);
+
+        $markdown = <<<'EOT'
+``` 
+<!-- <<< Support/file1.php -->
+```
+EOT;
+
+        Http::fake();
+
+        $this->render($markdown);
+
+        Http::assertSent(function ($request) {
+            return $request['blocks'][0]['code'] === '// this is file 1';
+        });
+    }
+
+
     /** @test */
     public function non_existent_file_just_stays()
     {