fix(documentator): HTML entities encoding for include:document-list…

… and `include:package-list`
LastDragon-ru · Oct 19, 2023 · 0d2bd41 · 0d2bd41
1 parent 1db945b
commit 0d2bd41
Show file tree

Hide file tree

Showing 13 changed files with 45 additions and 45 deletions.
diff --git a/README.md b/README.md
@@ -66,7 +66,7 @@ This package provides a customizable wrapper around [Intl](https://www.php.net/m
 
 ## GraphQL Extensions for Lighthouse
 
-This package provides highly powerful `@searchBy` and `@sortBy`  directives for [lighthouse-php](https://lighthouse-php.com/). The `@searchBy` directive provides basic conditions like `=`, `&gt;`, `&lt;`, etc, relations, `not (&lt;condition&gt;)`, enums, and custom operators support. All are strictly typed so you no need to use `Mixed` type anymore. The `@sortBy` is not only about standard sorting by columns but also allows use relations. 😎
+This package provides highly powerful `@searchBy` and `@sortBy`  directives for [lighthouse-php](https://lighthouse-php.com/). The `@searchBy` directive provides basic conditions like `=`, `>`, `<`, etc, relations, `not (<condition>)`, enums, and custom operators support. All are strictly typed so you no need to use `Mixed` type anymore. The `@sortBy` is not only about standard sorting by columns but also allows use relations. 😎
 
 [Read more](<packages/graphql/README.md>).
 

diff --git a/packages/documentator/defaults/views/document-list/markdown.blade.php b/packages/documentator/defaults/views/document-list/markdown.blade.php
@@ -5,10 +5,10 @@
 
 ?>
 @foreach ($documents as $document)
-## {{ $document['title'] }}
+## {!! $document['title'] !!}
 @if($document['summary'])
 
-{{ $document['summary'] }}
+{!! $document['summary'] !!}
 @endif
 
 [Read more](<{{ $document['path'] }}>).

diff --git a/packages/documentator/defaults/views/package-list/markdown.blade.php b/packages/documentator/defaults/views/package-list/markdown.blade.php
@@ -5,10 +5,10 @@
 
 ?>
 @foreach ($packages as $package)
-## {{ $package['title'] }}
+## {!! $package['title'] !!}
 @if($package['summary'])
 
-{{ $package['summary'] }}
+{!! $package['summary'] !!}
 @endif
 
 [Read more](<{{ $package['path'] }}>).

diff --git a/...ocumentator/src/Preprocessor/Instructions/IncludeDocumentListTest/Document A.md b/...ocumentator/src/Preprocessor/Instructions/IncludeDocumentListTest/Document A.md
@@ -1,5 +1,5 @@
 # Document A
 
-Summary text.
+Summary text with special characters `<`, `>`, `&`.
 
 Another text.
diff --git a/...ocumentator/src/Preprocessor/Instructions/IncludeDocumentListTest/Document B.md b/...ocumentator/src/Preprocessor/Instructions/IncludeDocumentListTest/Document B.md
@@ -1,4 +1,4 @@
-# Document B
+# `<` Document B `>`
 
 Summary text.
 

diff --git a/...tator/src/Preprocessor/Instructions/IncludeDocumentListTest~AnotherDirectory.md b/...tator/src/Preprocessor/Instructions/IncludeDocumentListTest~AnotherDirectory.md
@@ -8,11 +8,11 @@ Document summary.
 
 ## Document A
 
-Summary text.
+Summary text with special characters `<`, `>`, `&`.
 
 [Read more](<IncludeDocumentListTest/Document A.md>).
 
-## Document B
+## `<` Document B `>`
 
 Summary text.
 

diff --git a/...mentator/src/Preprocessor/Instructions/IncludeDocumentListTest~SameDirectory.md b/...mentator/src/Preprocessor/Instructions/IncludeDocumentListTest~SameDirectory.md
@@ -2,11 +2,11 @@
 
 ## Document A
 
-Summary text.
+Summary text with special characters `<`, `>`, `&`.
 
 [Read more](<Document A.md>).
 
-## Document B
+## `<` Document B `>`
 
 Summary text.
 

diff --git a/packages/documentator/src/Preprocessor/Instructions/IncludePackageListTest.md b/packages/documentator/src/Preprocessor/Instructions/IncludePackageListTest.md
@@ -1,11 +1,11 @@
 <!-- markdownlint-disable -->
 
-## The Package
+## The Package with custom readme
 
-Summary text.
+[Read more](<packages/package custom readme/CUSTOM.md>).
 
-[Read more](<packages/package/README.md>).
+## The `<` Package `>`
 
-## The Package with custom readme
+Summary text with special characters `<`, `>`, `&`.
 
-[Read more](<packages/package custom readme/CUSTOM.md>).
+[Read more](<packages/package/README.md>).
diff --git a/...src/Preprocessor/Instructions/IncludePackageListTest/packages/package/README.md b/...src/Preprocessor/Instructions/IncludePackageListTest/packages/package/README.md
@@ -1,3 +1,3 @@
-# The Package
+# The `<` Package `>`
 
-Summary text.
+Summary text with special characters `<`, `>`, `&`.
diff --git a/packages/graphql-printer/README.md b/packages/graphql-printer/README.md
@@ -84,6 +84,13 @@ type A
 The `$printer->export($type)` is:
 
 ```graphql
+type A
+@a
+{
+    b: [B!]
+    id: ID!
+}
+
 directive @a
 on
     | OBJECT
@@ -92,13 +99,6 @@ directive @b
 on
     | OBJECT
 
-type A
-@a
-{
-    b: [B!]
-    id: ID!
-}
-
 type B
 @b
 {

diff --git a/packages/graphql/README.md b/packages/graphql/README.md
@@ -476,8 +476,8 @@ This package is the part of Awesome Set of Packages for Laravel. Please use the
 
 [pkg:graphql#@searchBy]: https://github.com/LastDragon-ru/lara-asp/tree/main/packages/graphql/docs/Directives/@searchBy.md
 
-[pkg:graphql#@sortBy]:   https://github.com/LastDragon-ru/lara-asp/tree/main/packages/graphql/docs/Directives/@sortBy.md
+[pkg:graphql#@sortBy]: https://github.com/LastDragon-ru/lara-asp/tree/main/packages/graphql/docs/Directives/@sortBy.md
 
-[pkg:graphql-printer]:   https://github.com/LastDragon-ru/lara-asp/tree/main/packages/graphql-printer
+[pkg:graphql-printer]: https://github.com/LastDragon-ru/lara-asp/tree/main/packages/graphql-printer
 
 [//]: # (end: d8baa2418c8dbf3ba09f9b223885c4326bee3e69a2dc0873e243f0d34e002a85)
diff --git a/packages/graphql/docs/Directives/@stream.md b/packages/graphql/docs/Directives/@stream.md
@@ -17,33 +17,33 @@ by an offset or a cursor.
 """
 directive @stream(
     """
-    Overrides default builder. Useful if the standard detection
-    algorithm doesn't fit/work. By default, the directive will use
-    the field and its type to determine the Builder to query.
+    Overrides default searchable status.
     """
-    builder: StreamBuilder
+    searchable: Boolean
 
     """
-    Overrides default unique key. Useful if the standard detection
-    algorithm doesn't fit/work. By default, the directive will use
-    the name of field with `ID!` type.
+    Overrides default sortable status.
     """
-    key: String
+    sortable: Boolean
 
     """
-    Overrides default limit.
+    Overrides default builder. Useful if the standard detection
+    algorithm doesn't fit/work. By default, the directive will use
+    the field and its type to determine the Builder to query.
     """
-    limit: Int
+    builder: StreamBuilder
 
     """
-    Overrides default searchable status.
+    Overrides default limit.
     """
-    searchable: Boolean
+    limit: Int
 
     """
-    Overrides default sortable status.
+    Overrides default unique key. Useful if the standard detection
+    algorithm doesn't fit/work. By default, the directive will use
+    the name of field with `ID!` type.
     """
-    sortable: Boolean
+    key: String
 )
 on
     | FIELD_DEFINITION
@@ -181,6 +181,6 @@ Keep in mind:
 
 [pkg:graphql#@searchBy]: https://github.com/LastDragon-ru/lara-asp/tree/main/packages/graphql/docs/Directives/@searchBy.md
 
-[pkg:graphql#@sortBy]:   https://github.com/LastDragon-ru/lara-asp/tree/main/packages/graphql/docs/Directives/@sortBy.md
+[pkg:graphql#@sortBy]: https://github.com/LastDragon-ru/lara-asp/tree/main/packages/graphql/docs/Directives/@sortBy.md
 
 [//]: # (end: a170145c7adc0561ead408b0ea3a4b46e2e8f45ebc2744984ceb8c1b49822cd1)
diff --git a/packages/serializer/README.md b/packages/serializer/README.md
@@ -70,13 +70,13 @@ The `$serialized` is:
 The `$deserialized` is:
 
 ```plain
-User {#810
+User {#814
   +id: 1
   +name: "User"
-  +created: Illuminate\Support\Carbon @1693125044 {#808
+  +created: Illuminate\Support\Carbon @1693125044 {#812
     #endOfTime: false
     #startOfTime: false
-    #constructedObjectId: "00000000000003280000000000000000"
+    #constructedObjectId: "000000000000032c0000000000000000"
     #localMonthsOverflow: null
     #localYearsOverflow: null
     #localStrictModeEnabled: null