Merge pull request #1234 from hydephp/code-review-polishes

emmadesilva · web-flow · commit 2b941dbbf060 · 2023-03-07T22:17:01.000+01:00
Final code polishing
diff --git a/_pages/404.blade.php b/_pages/404.blade.php
@@ -48,4 +48,4 @@ class="absolute pin bg-cover bg-no-repeat md:bg-left lg:bg-center">
     </div>
 </div>
 </body>
-</html>
+</html>
diff --git a/_pages/index.blade.php b/_pages/index.blade.php
@@ -83,4 +83,4 @@ class="relative mt-2 text-transparent bg-clip-text bg-gradient-to-br logo-gradie
     </div>
 </main>
 </body>
-</html>
+</html>
diff --git a/app/bootstrap.php b/app/bootstrap.php
@@ -52,7 +52,7 @@
 );
 
 $app->singleton(
-    \Hyde\Foundation\HydeKernel::class, function () {
+    \Hyde\Foundation\HydeKernel::class, function (): \Hyde\Foundation\HydeKernel {
         return \Hyde\Foundation\HydeKernel::getInstance();
     }
 );
diff --git a/packages/framework/config/torchlight.php b/packages/framework/config/torchlight.php
@@ -20,12 +20,13 @@
     // and if so, what (Markdown) text should be used?
     'attribution' => [
         'enabled' => true,
-        'markdown' => '
-<p>
-    <i>
-        Syntax highlighting by <a href="https://torchlight.dev/" rel="noopener nofollow">Torchlight.dev</a>
-    </i>
-</p>',
+        'markdown' => <<<'MARKDOWN'
+        <p>
+            <i>
+                Syntax highlighting by <a href="https://torchlight.dev/" rel="noopener nofollow">Torchlight.dev</a>
+            </i>
+        </p>
+        MARKDOWN
     ],
 
     // The Torchlight client caches highlighted code blocks. Here
diff --git a/packages/framework/resources/views/components/article-excerpt.blade.php b/packages/framework/resources/views/components/article-excerpt.blade.php
@@ -1,7 +1,4 @@
-@php
-    /** @var \Hyde\Pages\MarkdownPost $post */
-@endphp
-
+@php /** @var \Hyde\Pages\MarkdownPost $post */ @endphp
 <article class="mt-4 mb-8" itemscope itemtype="https://schema.org/Article">
     <meta itemprop="identifier" content="{{ $post->identifier }}">
     @if(Hyde::hasSiteUrl())
diff --git a/packages/framework/resources/views/components/docs/documentation-article.blade.php b/packages/framework/resources/views/components/docs/documentation-article.blade.php
@@ -1,7 +1,6 @@
-@props([
-    /** @var \Hyde\Framework\Features\Documentation\SemanticDocumentationArticle $document */
-    'document',
-])
+@php
+    $document = \Hyde\Framework\Features\Documentation\SemanticDocumentationArticle::make($page);
+@endphp
 
 <article id="document" itemscope itemtype="https://schema.org/Article" @class([
         'mx-auto lg:ml-8 prose dark:prose-invert max-w-3xl p-12 md:px-16 max-w-[1000px] min-h-[calc(100vh_-_4rem)]',
diff --git a/packages/framework/resources/views/homepages/welcome.blade.php b/packages/framework/resources/views/homepages/welcome.blade.php
@@ -83,4 +83,4 @@ class="relative mt-2 text-transparent bg-clip-text bg-gradient-to-br logo-gradie
     </div>
 </main>
 </body>
-</html>
+</html>
diff --git a/packages/framework/resources/views/layouts/docs.blade.php b/packages/framework/resources/views/layouts/docs.blade.php
@@ -11,7 +11,7 @@
     @include('hyde::components.docs.sidebar')
 
     <main id="content" class="dark:bg-gray-900 min-h-screen bg-gray-50 md:bg-white absolute top-16 md:top-0 w-screen md:left-64 md:w-[calc(100vw_-_16rem)]">
-        <x-hyde::docs.documentation-article :document="\Hyde\Framework\Features\Documentation\SemanticDocumentationArticle::make($page)"/>
+        @include('hyde::components.docs.documentation-article')
     </main>
 
     <div id="support">
@@ -25,4 +25,4 @@
 
     @include('hyde::layouts.scripts')
 </body>
-</html>
+</html>
diff --git a/packages/framework/resources/views/pages/404.blade.php b/packages/framework/resources/views/pages/404.blade.php
@@ -48,4 +48,4 @@ class="absolute pin bg-cover bg-no-repeat md:bg-left lg:bg-center">
     </div>
 </div>
 </body>
-</html>
+</html>
diff --git a/packages/framework/src/Console/Commands/PublishHomepageCommand.php b/packages/framework/src/Console/Commands/PublishHomepageCommand.php
@@ -4,15 +4,15 @@
 
 namespace Hyde\Console\Commands;
 
-use Hyde\Console\Concerns\AsksToRebuildSite;
+use Hyde\Pages\BladePage;
 use Hyde\Console\Concerns\Command;
+use Hyde\Console\Concerns\AsksToRebuildSite;
 use Hyde\Framework\Services\ViewDiffService;
-use Hyde\Pages\BladePage;
-use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Artisan;
+use Illuminate\Support\Collection;
+use function Hyde\unixsum_file;
 use function array_key_exists;
 use function file_exists;
-use function Hyde\unixsum_file;
 use function str_replace;
 use function strstr;
 
diff --git a/packages/framework/tests/Feature/Services/HydeSmartDocsTest.php b/packages/framework/tests/Feature/Services/HydeSmartDocsTest.php
@@ -189,7 +189,7 @@ public function test_add_dynamic_footer_content_adds_torchlight_attribution_when
     public function test_the_documentation_article_view()
     {
         $rendered = view('hyde::components.docs.documentation-article', [
-            'document' => $this->makeArticle(),
+            'page' => $this->makePage(),
         ])->render();
 
         $this->assertStringContainsString('<h1>Foo</h1>', $rendered);
@@ -203,6 +203,13 @@ protected function makeArticle(string $sourceFileContents = "# Foo\n\nHello worl
         return SemanticDocumentationArticle::make(DocumentationPage::parse('foo'));
     }
 
+    protected function makePage(string $sourceFileContents = "# Foo\n\nHello world."): DocumentationPage
+    {
+        $this->file('_docs/foo.md', $sourceFileContents);
+
+        return DocumentationPage::parse('foo');
+    }
+
     protected function assertEqualsIgnoringNewlinesAndIndentation(string $expected, HtmlString $actual): void
     {
         $this->assertEquals(

-Original file line number
+Diff line change
     </div>
 </div>
 </body>
 -</html>
 +</html>
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@`
`52`	`52`	`);`
`53`	`53`
`54`	`54`	`$app->singleton(`
`55`		`- \Hyde\Foundation\HydeKernel::class, function () {`
	`55`	`+ \Hyde\Foundation\HydeKernel::class, function (): \Hyde\Foundation\HydeKernel {`
`56`	`56`	`return \Hyde\Foundation\HydeKernel::getInstance();`
`57`	`57`	`}`
`58`	`58`	`);`