feat(documentator): Better block id for Preprocess task (#189)

LastDragon-ru · Sep 25, 2024 · f0164fd · f0164fd
2 parents 6c544c1 + c3afa83
commit f0164fd
Show file tree

Hide file tree

Showing 53 changed files with 457 additions and 365 deletions.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 The set provides best practices to make development more fun and classes/services that I found very useful while working on big extensible applications.
 
 [include:artisan]: <lara-asp-documentator:requirements "{$directory}">
-[//]: # (start: 0f999169cbabc32d4f47c79c31d74f8b4066c685962719bae5df3c63a08ea382)
+[//]: # (start: preprocess/78cfc4c7c7c55577)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 # Requirements
@@ -25,7 +25,7 @@ The set provides best practices to make development more fun and classes/service
 |  | `^8.22.1` |   `3.0.0 ⋯ 0.2.0`   |
 |  | `^8.0` |  `0.1.0`   |
 
-[//]: # (end: 0f999169cbabc32d4f47c79c31d74f8b4066c685962719bae5df3c63a08ea382)
+[//]: # (end: preprocess/78cfc4c7c7c55577)
 
 # Installation
 
@@ -42,7 +42,7 @@ composer require lastdragon-ru/lara-asp-<package>
 |:--:|---------------------------------|
 
 [include:package-list]: ./packages
-[//]: # (start: fed4ec353a970d6253d640feee67d7662b2a28757689a2bd7276fe1136209b8a)
+[//]: # (start: preprocess/aeb862adf9d9852d)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 ## (Laravel) Core
@@ -109,7 +109,7 @@ Independent (from Laravel and Lighthouse) package that allow you to print GraphQ
 
 [Read more](<packages/graphql-printer/README.md>).
 
-[//]: # (end: fed4ec353a970d6253d640feee67d7662b2a28757689a2bd7276fe1136209b8a)
+[//]: # (end: preprocess/aeb862adf9d9852d)
 
 # Upgrading
 
@@ -123,7 +123,7 @@ Please follow [Upgrade Guide](UPGRADE.md).
 4. Enjoy
 
 [include:file]: ./docs/Legend.md
-[//]: # (start: c27a3d72b85555e946885f9f19e2ece38998f1207fbd278bb3058890b864132a)
+[//]: # (start: preprocess/5488d85d082e47fb)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 # Legend
@@ -142,4 +142,4 @@ Please follow [Upgrade Guide](UPGRADE.md).
 |  🆆  | CI    | Running on Windows                                               |
 |  🅼  | CI    | Running on Mac OS X                                              |
 
-[//]: # (end: c27a3d72b85555e946885f9f19e2ece38998f1207fbd278bb3058890b864132a)
+[//]: # (end: preprocess/5488d85d082e47fb)
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -1,7 +1,7 @@
 # Upgrade Guide
 
 [include:file]: ./docs/Shared/Upgrade.md
-[//]: # (start: 4318f49cdbcc8c10dc5745f395acd00ccef31aebde5f9c3f864623ec953d41d2)
+[//]: # (start: preprocess/8aaed7c3a55b57f9)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 ## Instructions
@@ -25,12 +25,12 @@ Please also see [changelog](https://github.com/LastDragon-ru/lara-asp/releases)
 | 🤝 | Backward-compatible change. Please note that despite you can ignore it now, but it will be mandatory in the future. |
 |:--:|:--------------------------------------------------------------------------------------------------------------------|
 
-[//]: # (end: 4318f49cdbcc8c10dc5745f395acd00ccef31aebde5f9c3f864623ec953d41d2)
+[//]: # (end: preprocess/8aaed7c3a55b57f9)
 
 # Packages
 
 [include:package-list]: ./packages ({"template": "upgradable"})
-[//]: # (start: bc74143a7e2bd1ef91a36faf8777246c3cf2a2ea5a08443bc2e3e4364ae9bf07)
+[//]: # (start: preprocess/54260d8bcef12cc3)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 * [(Laravel) Core](<packages/core/UPGRADE.md>)
@@ -45,7 +45,7 @@ Please also see [changelog](https://github.com/LastDragon-ru/lara-asp/releases)
 * [Dev 🐝](<packages/dev/UPGRADE.md>)
 * [GraphQL Printer](<packages/graphql-printer/UPGRADE.md>)
 
-[//]: # (end: bc74143a7e2bd1ef91a36faf8777246c3cf2a2ea5a08443bc2e3e4364ae9bf07)
+[//]: # (end: preprocess/54260d8bcef12cc3)
 
 # Upgrade from v5
 

diff --git a/packages/core/README.md b/packages/core/README.md
@@ -3,7 +3,7 @@
 This package contains useful utilities and classes.
 
 [include:artisan]: <lara-asp-documentator:requirements "{$directory}">
-[//]: # (start: 0f999169cbabc32d4f47c79c31d74f8b4066c685962719bae5df3c63a08ea382)
+[//]: # (start: preprocess/78cfc4c7c7c55577)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 # Requirements
@@ -24,10 +24,10 @@ This package contains useful utilities and classes.
 |  | `^9.0.0` |   `5.0.0-beta.0 ⋯ 0.12.0`   |
 |  | `^8.22.1` |   `3.0.0 ⋯ 0.4.0`   |
 
-[//]: # (end: 0f999169cbabc32d4f47c79c31d74f8b4066c685962719bae5df3c63a08ea382)
+[//]: # (end: preprocess/78cfc4c7c7c55577)
 
 [include:template]: ../../docs/Shared/Installation.md ({"data": {"package": "core"}})
-[//]: # (start: dd385eaf54cf55111091f66c427898395e4860dd8bdf1e980778b9f56bd6ff12)
+[//]: # (start: preprocess/8b571af3629c16d0)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 # Installation
@@ -36,7 +36,7 @@ This package contains useful utilities and classes.
 composer require lastdragon-ru/lara-asp-core
 ```
 
-[//]: # (end: dd385eaf54cf55111091f66c427898395e4860dd8bdf1e980778b9f56bd6ff12)
+[//]: # (end: preprocess/8b571af3629c16d0)
 
 # Usage
 
@@ -47,11 +47,11 @@ Please see the [source code](./src) to find something interesting 😅
 Please follow [Upgrade Guide](UPGRADE.md).
 
 [include:file]: ../../docs/Shared/Contributing.md
-[//]: # (start: fc88f84f187016cb8144e9a024844024492f0c3a5a6f8d128bf69a5814cc8cc5)
+[//]: # (start: preprocess/c4ba75080f5a48b7)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 # Contributing
 
 This package is the part of Awesome Set of Packages for Laravel. Please use the [main repository](https://github.com/LastDragon-ru/lara-asp) to [report issues](https://github.com/LastDragon-ru/lara-asp/issues), send [pull requests](https://github.com/LastDragon-ru/lara-asp/pulls), or [ask questions](https://github.com/LastDragon-ru/lara-asp/discussions).
 
-[//]: # (end: fc88f84f187016cb8144e9a024844024492f0c3a5a6f8d128bf69a5814cc8cc5)
+[//]: # (end: preprocess/c4ba75080f5a48b7)
diff --git a/packages/core/UPGRADE.md b/packages/core/UPGRADE.md
@@ -1,7 +1,7 @@
 # Upgrade Guide
 
 [include:file]: ../../docs/Shared/Upgrade.md
-[//]: # (start: 8e89e65b3785cb5b41f28a4f3c5b7e0db0110d8047852d71cd99b2cdffd8f57c)
+[//]: # (start: preprocess/aa9fc458898c7c1c)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 ## Instructions
@@ -25,35 +25,36 @@ Please also see [changelog](https://github.com/LastDragon-ru/lara-asp/releases)
 | 🤝 | Backward-compatible change. Please note that despite you can ignore it now, but it will be mandatory in the future. |
 |:--:|:--------------------------------------------------------------------------------------------------------------------|
 
-[//]: # (end: 8e89e65b3785cb5b41f28a4f3c5b7e0db0110d8047852d71cd99b2cdffd8f57c)
+[//]: # (end: preprocess/aa9fc458898c7c1c)
 
 # Upgrade from v6
 
 [include:file]: ../../docs/Shared/Upgrade/FromV6.md
-[//]: # (start: 470dd21d18d5886f1873b1247130ac8173ed99258e41418c6bd32162325d628b)
+[//]: # (start: preprocess/9679e76379216855)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 * [ ] PHP 8.1 is not supported anymore. Migrate to the newer version.
 
 * [ ] Direct usages of `Container::getInstances()` were replaced by explicit constructor parameters. You may need to update your code accordingly (#151).
 
-[//]: # (end: 470dd21d18d5886f1873b1247130ac8173ed99258e41418c6bd32162325d628b)
+[//]: # (end: preprocess/9679e76379216855)
 
 * [ ] [`WithRoutes::bootRoutes()`][code-links/141085a29c14a778] requires settings.
 
 # Upgrade from v5
 
 [include:file]: ../../docs/Shared/Upgrade/FromV5.md
-[//]: # (start: 374d3c27b4b7982387512d35047d26f2bce3dd6c7b06bc14e53fdcd74bad8102)
+[//]: # (start: preprocess/2e85dad2b0618274)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 * [ ] Laravel v9 is not supported anymore. Migrate to the newer version.
 
-[//]: # (end: 374d3c27b4b7982387512d35047d26f2bce3dd6c7b06bc14e53fdcd74bad8102)
+[//]: # (end: preprocess/2e85dad2b0618274)
 
 [//]: # (start: code-links)
 [//]: # (warning: Generated automatically. Do not edit.)
 
-[code-links/141085a29c14a778]: src/Provider/WithRoutes.php#L16-L41 "\LastDragon_ru\LaraASP\Core\Provider\WithRoutes::bootRoutes()"
+[code-links/141085a29c14a778]: src/Provider/WithRoutes.php#L16-L41
+    "\LastDragon_ru\LaraASP\Core\Provider\WithRoutes::bootRoutes()"
 
 [//]: # (end: code-links)
diff --git a/packages/dev/README.md b/packages/dev/README.md
@@ -3,7 +3,7 @@
 Various internal tools and helpers to develop the package itself.
 
 [include:artisan]: <lara-asp-documentator:requirements "{$directory}">
-[//]: # (start: 0f999169cbabc32d4f47c79c31d74f8b4066c685962719bae5df3c63a08ea382)
+[//]: # (start: preprocess/78cfc4c7c7c55577)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 # Requirements
@@ -15,10 +15,10 @@ Various internal tools and helpers to develop the package itself.
 |  | `^8.1` |   `6.4.2 ⋯ 6.2.0`   |
 |  PHPStan  | `^1.10` |   `HEAD ⋯ 6.2.0`   |
 
-[//]: # (end: 0f999169cbabc32d4f47c79c31d74f8b4066c685962719bae5df3c63a08ea382)
+[//]: # (end: preprocess/78cfc4c7c7c55577)
 
 [include:template]: ../../docs/Shared/InstallationDev.md ({"data": {"package": "dev"}})
-[//]: # (start: f6d0e1f826b16f75973edcf9d84f497e65dad4d69ccbb30b69167dd9d63995bb)
+[//]: # (start: preprocess/3d3cb65e05620e8c)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 # Installation
@@ -31,7 +31,7 @@ Various internal tools and helpers to develop the package itself.
 composer require --dev lastdragon-ru/lara-asp-dev
 ```
 
-[//]: # (end: f6d0e1f826b16f75973edcf9d84f497e65dad4d69ccbb30b69167dd9d63995bb)
+[//]: # (end: preprocess/3d3cb65e05620e8c)
 
 ## Usage
 
@@ -42,11 +42,11 @@ _In progress_.
 Please follow [Upgrade Guide](UPGRADE.md).
 
 [include:file]: ../../docs/Shared/Contributing.md
-[//]: # (start: fc88f84f187016cb8144e9a024844024492f0c3a5a6f8d128bf69a5814cc8cc5)
+[//]: # (start: preprocess/c4ba75080f5a48b7)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 # Contributing
 
 This package is the part of Awesome Set of Packages for Laravel. Please use the [main repository](https://github.com/LastDragon-ru/lara-asp) to [report issues](https://github.com/LastDragon-ru/lara-asp/issues), send [pull requests](https://github.com/LastDragon-ru/lara-asp/pulls), or [ask questions](https://github.com/LastDragon-ru/lara-asp/discussions).
 
-[//]: # (end: fc88f84f187016cb8144e9a024844024492f0c3a5a6f8d128bf69a5814cc8cc5)
+[//]: # (end: preprocess/c4ba75080f5a48b7)
diff --git a/packages/dev/UPGRADE.md b/packages/dev/UPGRADE.md
@@ -1,7 +1,7 @@
 # Upgrade Guide
 
 [include:file]: ../../docs/Shared/Upgrade.md
-[//]: # (start: 8e89e65b3785cb5b41f28a4f3c5b7e0db0110d8047852d71cd99b2cdffd8f57c)
+[//]: # (start: preprocess/aa9fc458898c7c1c)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 ## Instructions
@@ -25,16 +25,16 @@ Please also see [changelog](https://github.com/LastDragon-ru/lara-asp/releases)
 | 🤝 | Backward-compatible change. Please note that despite you can ignore it now, but it will be mandatory in the future. |
 |:--:|:--------------------------------------------------------------------------------------------------------------------|
 
-[//]: # (end: 8e89e65b3785cb5b41f28a4f3c5b7e0db0110d8047852d71cd99b2cdffd8f57c)
+[//]: # (end: preprocess/aa9fc458898c7c1c)
 
 # Upgrade from v6
 
 [include:file]: ../../docs/Shared/Upgrade/FromV6.md
-[//]: # (start: 470dd21d18d5886f1873b1247130ac8173ed99258e41418c6bd32162325d628b)
+[//]: # (start: preprocess/9679e76379216855)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 * [ ] PHP 8.1 is not supported anymore. Migrate to the newer version.
 
 * [ ] Direct usages of `Container::getInstances()` were replaced by explicit constructor parameters. You may need to update your code accordingly (#151).
 
-[//]: # (end: 470dd21d18d5886f1873b1247130ac8173ed99258e41418c6bd32162325d628b)
+[//]: # (end: preprocess/9679e76379216855)
diff --git a/packages/documentator/README.md b/packages/documentator/README.md
@@ -3,7 +3,7 @@
 This package provides various utilities for documentation generation such as Markdown Preprocessor, Requirements Dumper and more.
 
 [include:artisan]: <lara-asp-documentator:requirements "{$directory}">
-[//]: # (start: 0f999169cbabc32d4f47c79c31d74f8b4066c685962719bae5df3c63a08ea382)
+[//]: # (start: preprocess/78cfc4c7c7c55577)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 # Requirements
@@ -18,10 +18,10 @@ This package provides various utilities for documentation generation such as Mar
 |  | `^10.0.0` |   `6.1.0 ⋯ 5.0.0-beta.1`   |
 |  | `^9.21.0` |   `5.6.0 ⋯ 5.0.0-beta.1`   |
 
-[//]: # (end: 0f999169cbabc32d4f47c79c31d74f8b4066c685962719bae5df3c63a08ea382)
+[//]: # (end: preprocess/78cfc4c7c7c55577)
 
 [include:template]: ../../docs/Shared/Installation.md ({"data": {"package": "documentator"}})
-[//]: # (start: ec326af8e6529977dcb44b67335b70be8b3aefaff2344a491c075d1bbeae58bb)
+[//]: # (start: preprocess/ae875fc29fdefb4f)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 # Installation
@@ -30,12 +30,12 @@ This package provides various utilities for documentation generation such as Mar
 composer require lastdragon-ru/lara-asp-documentator
 ```
 
-[//]: # (end: ec326af8e6529977dcb44b67335b70be8b3aefaff2344a491c075d1bbeae58bb)
+[//]: # (end: preprocess/ae875fc29fdefb4f)
 
 # Commands
 
 [include:document-list]: ./docs/Commands
-[//]: # (start: afb4e2440d52a76ba0a75c90795760817a659138d71c9a463a0e417d9abb178a)
+[//]: # (start: preprocess/820df828d96420b5)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 ## `lara-asp-documentator:commands`
@@ -56,18 +56,18 @@ Generates a table with the required versions of PHP/Laravel/etc in Markdown form
 
 [Read more](<docs/Commands/requirements.md>).
 
-[//]: # (end: afb4e2440d52a76ba0a75c90795760817a659138d71c9a463a0e417d9abb178a)
+[//]: # (end: preprocess/820df828d96420b5)
 
 # Upgrading
 
 Please follow [Upgrade Guide](UPGRADE.md).
 
 [include:file]: ../../docs/Shared/Contributing.md
-[//]: # (start: fc88f84f187016cb8144e9a024844024492f0c3a5a6f8d128bf69a5814cc8cc5)
+[//]: # (start: preprocess/c4ba75080f5a48b7)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 # Contributing
 
 This package is the part of Awesome Set of Packages for Laravel. Please use the [main repository](https://github.com/LastDragon-ru/lara-asp) to [report issues](https://github.com/LastDragon-ru/lara-asp/issues), send [pull requests](https://github.com/LastDragon-ru/lara-asp/pulls), or [ask questions](https://github.com/LastDragon-ru/lara-asp/discussions).
 
-[//]: # (end: fc88f84f187016cb8144e9a024844024492f0c3a5a6f8d128bf69a5814cc8cc5)
+[//]: # (end: preprocess/c4ba75080f5a48b7)
diff --git a/packages/documentator/UPGRADE.md b/packages/documentator/UPGRADE.md
@@ -1,7 +1,7 @@
 # Upgrade Guide
 
 [include:file]: ../../docs/Shared/Upgrade.md
-[//]: # (start: 8e89e65b3785cb5b41f28a4f3c5b7e0db0110d8047852d71cd99b2cdffd8f57c)
+[//]: # (start: preprocess/aa9fc458898c7c1c)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 ## Instructions
@@ -25,19 +25,19 @@ Please also see [changelog](https://github.com/LastDragon-ru/lara-asp/releases)
 | 🤝 | Backward-compatible change. Please note that despite you can ignore it now, but it will be mandatory in the future. |
 |:--:|:--------------------------------------------------------------------------------------------------------------------|
 
-[//]: # (end: 8e89e65b3785cb5b41f28a4f3c5b7e0db0110d8047852d71cd99b2cdffd8f57c)
+[//]: # (end: preprocess/aa9fc458898c7c1c)
 
 # Upgrade from v6
 
 [include:file]: ../../docs/Shared/Upgrade/FromV6.md
-[//]: # (start: 470dd21d18d5886f1873b1247130ac8173ed99258e41418c6bd32162325d628b)
+[//]: # (start: preprocess/9679e76379216855)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 * [ ] PHP 8.1 is not supported anymore. Migrate to the newer version.
 
 * [ ] Direct usages of `Container::getInstances()` were replaced by explicit constructor parameters. You may need to update your code accordingly (#151).
 
-[//]: # (end: 470dd21d18d5886f1873b1247130ac8173ed99258e41418c6bd32162325d628b)
+[//]: # (end: preprocess/9679e76379216855)
 
 * [ ] Migrate to the new contract:
   * [`Instruction`][code-links/6312f45bb1f04802]
@@ -52,12 +52,12 @@ Please also see [changelog](https://github.com/LastDragon-ru/lara-asp/releases)
 # Upgrade from v5
 
 [include:file]: ../../docs/Shared/Upgrade/FromV5.md
-[//]: # (start: 374d3c27b4b7982387512d35047d26f2bce3dd6c7b06bc14e53fdcd74bad8102)
+[//]: # (start: preprocess/2e85dad2b0618274)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 * [ ] Laravel v9 is not supported anymore. Migrate to the newer version.
 
-[//]: # (end: 374d3c27b4b7982387512d35047d26f2bce3dd6c7b06bc14e53fdcd74bad8102)
+[//]: # (end: preprocess/2e85dad2b0618274)
 
 * [ ] Replace `💀\LastDragon_ru\LaraASP\Documentator\Preprocessor\InstructionContract` by `💀\LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\ProcessableInstruction` or `💀\LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\ParameterizableInstruction`.
 
@@ -70,16 +70,22 @@ Please also see [changelog](https://github.com/LastDragon-ru/lara-asp/releases)
 [//]: # (start: code-links)
 [//]: # (warning: Generated automatically. Do not edit.)
 
-[code-links/f4718f92376c3c25]: src/Processor/Contracts/Dependency.php "\LastDragon_ru\LaraASP\Documentator\Processor\Contracts\Dependency"
+[code-links/f4718f92376c3c25]: src/Processor/Contracts/Dependency.php
+    "\LastDragon_ru\LaraASP\Documentator\Processor\Contracts\Dependency"
 
-[code-links/ac42b74d053a366b]: src/Processor/Contracts/Task.php#L18-L39 "\LastDragon_ru\LaraASP\Documentator\Processor\Contracts\Task::__invoke()"
+[code-links/ac42b74d053a366b]: src/Processor/Contracts/Task.php#L18-L39
+    "\LastDragon_ru\LaraASP\Documentator\Processor\Contracts\Task::__invoke()"
 
-[code-links/b5c6ff41fa24071c]: src/Processor/Exceptions/DependencyNotFound.php "\LastDragon_ru\LaraASP\Documentator\Processor\Exceptions\DependencyNotFound"
+[code-links/b5c6ff41fa24071c]: src/Processor/Exceptions/DependencyNotFound.php
+    "\LastDragon_ru\LaraASP\Documentator\Processor\Exceptions\DependencyNotFound"
 
-[code-links/6312f45bb1f04802]: src/Processor/Tasks/Preprocess/Contracts/Instruction.php "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Contracts\Instruction"
+[code-links/6312f45bb1f04802]: src/Processor/Tasks/Preprocess/Contracts/Instruction.php
+    "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Contracts\Instruction"
 
-[code-links/ecd75d864090a13d]: src/Processor/Tasks/Preprocess/Contracts/Parameters.php "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Contracts\Parameters"
+[code-links/ecd75d864090a13d]: src/Processor/Tasks/Preprocess/Contracts/Parameters.php
+    "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Contracts\Parameters"
 
-[code-links/f9077a28b352f84b]: src/Processor/Tasks/Preprocess/Instructions/IncludeExample/Contracts/Runner.php "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Instructions\IncludeExample\Contracts\Runner"
+[code-links/f9077a28b352f84b]: src/Processor/Tasks/Preprocess/Instructions/IncludeExample/Contracts/Runner.php
+    "\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Instructions\IncludeExample\Contracts\Runner"
 
 [//]: # (end: code-links)