Fix linters

romanzipp · Jul 9, 2024 · 88ebaf6 · 88ebaf6
1 parent 9607730
commit 88ebaf6
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 6 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -45,7 +45,7 @@ See the [Schema.org integration docs](/schema-org.html) for more information.
 | `seo()->charset()`                    | `<meta charset="utf-8" />`                                   |
 | `seo()->viewport()`                   | `<meta name="viewport" content="width=device-width, ..." />` |
 | `seo()->csrfToken()`                  | `<meta name="csrf-token" content="..." />`                   |
-| `seo()->jsonLd([...])`                | `<script type="application/ld+json">...</scrit>`             |
+| `seo()->ldJson([...])`                | `<script type="application/ld+json">...</scrit>`             |
 | **Adding Structs**                    |                                                              |
 | `seo()->add(...)`                     | `<meta name="foo" />`                                        |
 | `seo()->addMany([...])`               | `<meta name="foo" />`                                        |

diff --git a/docs/structs.md b/docs/structs.md
@@ -335,7 +335,7 @@ seo()->add(
 ### JSON-LD
 
 ```php
-seo()->jsonLd(array $data, bool $pretty = false);
+seo()->ldJson(array $data, bool $pretty = false);
 ```
 
 <details>

diff --git a/src/Services/Traits/ShorthandSetterTrait.php b/src/Services/Traits/ShorthandSetterTrait.php
@@ -251,12 +251,12 @@ public function csrfToken(string $token = null): self
      *
      * @see https://developers.google.com/search/docs/appearance/structured-data/intro-structured-data
      *
-     * @param array $structuredData
+     * @param array<string, array|string> $structuredData
      * @param bool $pretty
      *
-     * @return \romanzipp\Seo\Services\Traits\ShorthandSetterTrait|\romanzipp\Seo\Services\SeoService
+     * @return $this
      */
-    public function jsonLd(array $structuredData, bool $pretty = false): self
+    public function ldJson(array $structuredData, bool $pretty = false): self
     {
         return $this->add(
             LinkedData::make()->data($structuredData, $pretty)

diff --git a/src/Structs/LinkedData.php b/src/Structs/LinkedData.php
@@ -14,6 +14,12 @@ protected function tag(): string
         return 'script';
     }
 
+    /**
+     * @param array<string, array|string> $structuredData
+     * @param bool $pretty
+     *
+     * @return $this
+     */
     public function data(array $structuredData, bool $pretty = false): self
     {
         $this->body(

diff --git a/tests/ShorthandSettersTest.php b/tests/ShorthandSettersTest.php
@@ -155,7 +155,7 @@ public function testCanonicalSetter()
 
     public function testLinkedDataSetter()
     {
-        seo()->jsonLd(['@context' => 'https://schema.org/']);
+        seo()->ldJson(['@context' => 'https://schema.org/']);
 
         $contents = seo()->render()->toArray();
 

diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -37,6 +37,7 @@ public static function assertMatchesRegularExpressionCustom(string $pattern, str
         // If parent has method assertMatchesRegularExpression, call it
         if (method_exists(BaseTestCase::class, 'assertMatchesRegularExpression')) {
             parent::assertMatchesRegularExpression($pattern, $string, $message);
+
             return;
         }
-Original file line number
+Diff line change
@@ Expand Up @@
             // If parent has method assertMatchesRegularExpression, call it
             if (method_exists(BaseTestCase::class, 'assertMatchesRegularExpression')) {
                 parent::assertMatchesRegularExpression($pattern, $string, $message);
                 return;
             }
@@ Expand Down @@