refactor(documentator)!: Preprocessor switched to the Processor (#…

…164)
LastDragon-ru · May 26, 2024 · 700577c · 700577c
2 parents 9478b44 + f09fa83
commit 700577c
Show file tree

Hide file tree

Showing 101 changed files with 1,354 additions and 1,019 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:exec]: <./dev/artisan lara-asp-documentator:requirements>
-[//]: # (start: 5a6479e01ca04242d936b5543af76210a1af5db5468e2f480f167a2a046b62db)
+[//]: # (start: cf085248b2284f354e6966f146d7c1c32821f3031a0316e73df3a80e038e704f)
 [//]: # (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: 5a6479e01ca04242d936b5543af76210a1af5db5468e2f480f167a2a046b62db)
+[//]: # (end: cf085248b2284f354e6966f146d7c1c32821f3031a0316e73df3a80e038e704f)
 
 # Installation
 
@@ -42,7 +42,7 @@ composer require lastdragon-ru/lara-asp-<package>
 |:--:|---------------------------------|
 
 [include:package-list]: ./packages
-[//]: # (start: df3ee6374fabefbdeb79b26164b3f2ef88f6ed94646bb5d44751ea6da758de19)
+[//]: # (start: 2d5a58effc8f1949a8d20851019e2cefc9eeb2ea45725bf2b8147fee917f0b0c)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 ## (Laravel) Core
@@ -109,17 +109,17 @@ Independent (from Laravel and Lighthouse) package that allow you to print GraphQ
 
 [Read more](<packages/graphql-printer/README.md>).
 
-[//]: # (end: df3ee6374fabefbdeb79b26164b3f2ef88f6ed94646bb5d44751ea6da758de19)
+[//]: # (end: 2d5a58effc8f1949a8d20851019e2cefc9eeb2ea45725bf2b8147fee917f0b0c)
 
 [include:file]: ./docs/Shared/Upgrading.md
-[//]: # (start: cdb14a15bab8920d27c60204790e96bf814a9d780f6a55d5e93422db9bf56f64)
+[//]: # (start: cbfccea895cb6cddbed8d1e403e510b43171341972c83ab9373a1bc25f6c2e65)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 # Upgrading
 
 Please follow [Upgrade Guide](UPGRADE.md).
 
-[//]: # (end: cdb14a15bab8920d27c60204790e96bf814a9d780f6a55d5e93422db9bf56f64)
+[//]: # (end: cbfccea895cb6cddbed8d1e403e510b43171341972c83ab9373a1bc25f6c2e65)
 
 # Development
 
@@ -129,7 +129,7 @@ Please follow [Upgrade Guide](UPGRADE.md).
 4. Enjoy
 
 [include:file]: ./docs/Legend.md
-[//]: # (start: 68b5a2c9955bc3698c6033103ab34e32d67edfcff7b726f187662b5ce2e15a67)
+[//]: # (start: 9a1322b3ab69b4443131311847c0af0cf6f86c6024c1436b67733d42ba3e2e4a)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 # Legend
@@ -148,4 +148,4 @@ Please follow [Upgrade Guide](UPGRADE.md).
 |  🆆  | CI    | Running on Windows                                               |
 |  🅼  | CI    | Running on Mac OS X                                              |
 
-[//]: # (end: 68b5a2c9955bc3698c6033103ab34e32d67edfcff7b726f187662b5ce2e15a67)
+[//]: # (end: 9a1322b3ab69b4443131311847c0af0cf6f86c6024c1436b67733d42ba3e2e4a)
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -1,7 +1,7 @@
 # Upgrade Guide
 
 [include:file]: ./docs/Shared/Upgrade.md
-[//]: # (start: 556e36b93ca9f82e94056295c197aa9a4c8c042054927a9bf08dd9140ad872b8)
+[//]: # (start: c437867d96b216fb0f421c0c5b19b29eea42439b286bc4bc8f0f551f1fe2d9c2)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 ## Instructions
@@ -25,7 +25,7 @@ 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: 556e36b93ca9f82e94056295c197aa9a4c8c042054927a9bf08dd9140ad872b8)
+[//]: # (end: c437867d96b216fb0f421c0c5b19b29eea42439b286bc4bc8f0f551f1fe2d9c2)
 
 # Packages
 

diff --git a/monorepo-builder.php b/monorepo-builder.php
@@ -4,5 +4,5 @@
 
 return static function (MBConfig $config): void {
     $config->packageDirectories([__DIR__.'/packages']);
-    $config->packageDirectoriesExcludes(['dev']);
+    $config->packageDirectoriesExcludes(['dev', 'src']);
 };
diff --git a/packages/core/README.md b/packages/core/README.md
@@ -3,7 +3,7 @@
 This package contains useful utilities and classes.
 
 [include:exec]: <../../dev/artisan lara-asp-documentator:requirements>
-[//]: # (start: 196f435a1c8bc8d5966e42b9fd090d5ccc17c75206e617d7f8369cd9328846ea)
+[//]: # (start: 0c754acbee0a8071717d81a4c18765bb2d605f138e08492b868c0e3f27e481ed)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 # Requirements
@@ -24,7 +24,7 @@ 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: 196f435a1c8bc8d5966e42b9fd090d5ccc17c75206e617d7f8369cd9328846ea)
+[//]: # (end: 0c754acbee0a8071717d81a4c18765bb2d605f138e08492b868c0e3f27e481ed)
 
 [include:template]: ../../docs/Shared/Installation.md ({"data": {"package": "core"}})
 [//]: # (start: 701034cd4b15ff1d0ee9742e3d839f3a0c70ba66d75ff6c56f712d2f69e254ae)
@@ -43,21 +43,21 @@ composer require lastdragon-ru/lara-asp-core
 Please see the [source code](./src) to find something interesting 😅
 
 [include:file]: ../../docs/Shared/Upgrading.md
-[//]: # (start: 3c3826915e1d570b3982fdc6acf484950f0add7bb09d71c8c99b4a0e0fc5b43a)
+[//]: # (start: 5f4a27dda34e5e151a62fe3459daf4bb3b85705d38810060e71fcadc25669c0f)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 # Upgrading
 
 Please follow [Upgrade Guide](UPGRADE.md).
 
-[//]: # (end: 3c3826915e1d570b3982fdc6acf484950f0add7bb09d71c8c99b4a0e0fc5b43a)
+[//]: # (end: 5f4a27dda34e5e151a62fe3459daf4bb3b85705d38810060e71fcadc25669c0f)
 
 [include:file]: ../../docs/Shared/Contributing.md
-[//]: # (start: 6b81b030ae74b2d149ec76cbec1b053da8da4e0ac4fd865f560548f3ead955e8)
+[//]: # (start: 3f7cfa48046722fb9d277c71e074ff8406787772f90d17405b7554a4464cbfee)
 [//]: # (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: 6b81b030ae74b2d149ec76cbec1b053da8da4e0ac4fd865f560548f3ead955e8)
+[//]: # (end: 3f7cfa48046722fb9d277c71e074ff8406787772f90d17405b7554a4464cbfee)
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: 5af9759519da3fa710fb21785e61682fda687a6ebdfb6f0dde4ed03162cb031d)
+[//]: # (start: 3fcf292b870e49aabe885c416dfaf6c6c66d4571e87d3d3975d9cfe34ea6c9fe)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 ## Instructions
@@ -25,26 +25,26 @@ 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: 5af9759519da3fa710fb21785e61682fda687a6ebdfb6f0dde4ed03162cb031d)
+[//]: # (end: 3fcf292b870e49aabe885c416dfaf6c6c66d4571e87d3d3975d9cfe34ea6c9fe)
 
 # Upgrade from v6
 
 [include:file]: ../../docs/Shared/Upgrade/FromV6.md
-[//]: # (start: 8dae6cc48a78a268dcc7b747e512f85b410c9a9392ffac0734f4b17d390f1883)
+[//]: # (start: b0b74ef74f156294a37f3ec42299e221e5e693f3b42297f5cfa79cab99b1df7e)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 * [ ] Direct usages of `Container::getInstances()` were replaced by explicit constructor parameters. You may need to update your code accordingly (#151).
 
-[//]: # (end: 8dae6cc48a78a268dcc7b747e512f85b410c9a9392ffac0734f4b17d390f1883)
+[//]: # (end: b0b74ef74f156294a37f3ec42299e221e5e693f3b42297f5cfa79cab99b1df7e)
 
 * [ ] `\LastDragon_ru\LaraASP\Core\Provider\WithRoutes::bootRoutes()` requires settings.
 
 # Upgrade from v5
 
 [include:file]: ../../docs/Shared/Upgrade/FromV5.md
-[//]: # (start: 599c87007f162e34f4fd0c7874d4fcf8676e5d8c761d27a9456b284c7d1d12f2)
+[//]: # (start: 6367638a165291d78965aaeae9ab03b304b0a420eb3f5ad9af0424296cc609ea)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 * [ ] Laravel v9 is not supported anymore. Migrate to the newer version.
 
-[//]: # (end: 599c87007f162e34f4fd0c7874d4fcf8676e5d8c761d27a9456b284c7d1d12f2)
+[//]: # (end: 6367638a165291d78965aaeae9ab03b304b0a420eb3f5ad9af0424296cc609ea)
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:exec]: <../../dev/artisan lara-asp-documentator:requirements>
-[//]: # (start: 196f435a1c8bc8d5966e42b9fd090d5ccc17c75206e617d7f8369cd9328846ea)
+[//]: # (start: 0c754acbee0a8071717d81a4c18765bb2d605f138e08492b868c0e3f27e481ed)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 # Requirements
@@ -15,7 +15,7 @@ Various internal tools and helpers to develop the package itself.
 |  | `^8.1` |   `HEAD ⋯ 6.2.0`   |
 |  PHPStan  | `^1.10` |   `HEAD ⋯ 6.2.0`   |
 
-[//]: # (end: 196f435a1c8bc8d5966e42b9fd090d5ccc17c75206e617d7f8369cd9328846ea)
+[//]: # (end: 0c754acbee0a8071717d81a4c18765bb2d605f138e08492b868c0e3f27e481ed)
 
 [include:template]: ../../docs/Shared/InstallationDev.md ({"data": {"package": "dev"}})
 [//]: # (start: e7fd13bb6d43bcc48d9fe51411b607bee0e47ccbcb1b788889f59b733865e0f1)
@@ -38,21 +38,21 @@ composer require --dev lastdragon-ru/lara-asp-dev
 _In progress_.
 
 [include:file]: ../../docs/Shared/Upgrading.md
-[//]: # (start: 3c3826915e1d570b3982fdc6acf484950f0add7bb09d71c8c99b4a0e0fc5b43a)
+[//]: # (start: 5f4a27dda34e5e151a62fe3459daf4bb3b85705d38810060e71fcadc25669c0f)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 # Upgrading
 
 Please follow [Upgrade Guide](UPGRADE.md).
 
-[//]: # (end: 3c3826915e1d570b3982fdc6acf484950f0add7bb09d71c8c99b4a0e0fc5b43a)
+[//]: # (end: 5f4a27dda34e5e151a62fe3459daf4bb3b85705d38810060e71fcadc25669c0f)
 
 [include:file]: ../../docs/Shared/Contributing.md
-[//]: # (start: 6b81b030ae74b2d149ec76cbec1b053da8da4e0ac4fd865f560548f3ead955e8)
+[//]: # (start: 3f7cfa48046722fb9d277c71e074ff8406787772f90d17405b7554a4464cbfee)
 [//]: # (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: 6b81b030ae74b2d149ec76cbec1b053da8da4e0ac4fd865f560548f3ead955e8)
+[//]: # (end: 3f7cfa48046722fb9d277c71e074ff8406787772f90d17405b7554a4464cbfee)
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: 5af9759519da3fa710fb21785e61682fda687a6ebdfb6f0dde4ed03162cb031d)
+[//]: # (start: 3fcf292b870e49aabe885c416dfaf6c6c66d4571e87d3d3975d9cfe34ea6c9fe)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 ## Instructions
@@ -25,4 +25,4 @@ 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: 5af9759519da3fa710fb21785e61682fda687a6ebdfb6f0dde4ed03162cb031d)
+[//]: # (end: 3fcf292b870e49aabe885c416dfaf6c6c66d4571e87d3d3975d9cfe34ea6c9fe)
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:exec]: <../../dev/artisan lara-asp-documentator:requirements>
-[//]: # (start: 196f435a1c8bc8d5966e42b9fd090d5ccc17c75206e617d7f8369cd9328846ea)
+[//]: # (start: 0c754acbee0a8071717d81a4c18765bb2d605f138e08492b868c0e3f27e481ed)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 # Requirements
@@ -18,7 +18,7 @@ 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: 196f435a1c8bc8d5966e42b9fd090d5ccc17c75206e617d7f8369cd9328846ea)
+[//]: # (end: 0c754acbee0a8071717d81a4c18765bb2d605f138e08492b868c0e3f27e481ed)
 
 [include:template]: ../../docs/Shared/Installation.md ({"data": {"package": "documentator"}})
 [//]: # (start: d830b5dad8950e88a29e14aa443ca509cfa19889b5c3792b00691760fb8618bb)
@@ -35,7 +35,7 @@ composer require lastdragon-ru/lara-asp-documentator
 # Commands
 
 [include:document-list]: ./docs/Commands
-[//]: # (start: 3183e17484393f086cbec523de70a97446749151d781d55ef8f480075e5c75b9)
+[//]: # (start: bf4572c5a716c01f9df13bb1bfb0e1a6d9c62b3f19f5467f152a12da3f5d92ad)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 ## `lara-asp-documentator:commands`
@@ -56,24 +56,24 @@ Generates a table with the required versions of PHP/Laravel/etc in Markdown form
 
 [Read more](<docs/Commands/requirements.md>).
 
-[//]: # (end: 3183e17484393f086cbec523de70a97446749151d781d55ef8f480075e5c75b9)
+[//]: # (end: bf4572c5a716c01f9df13bb1bfb0e1a6d9c62b3f19f5467f152a12da3f5d92ad)
 
 [include:file]: ../../docs/Shared/Upgrading.md
-[//]: # (start: 3c3826915e1d570b3982fdc6acf484950f0add7bb09d71c8c99b4a0e0fc5b43a)
+[//]: # (start: 5f4a27dda34e5e151a62fe3459daf4bb3b85705d38810060e71fcadc25669c0f)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 # Upgrading
 
 Please follow [Upgrade Guide](UPGRADE.md).
 
-[//]: # (end: 3c3826915e1d570b3982fdc6acf484950f0add7bb09d71c8c99b4a0e0fc5b43a)
+[//]: # (end: 5f4a27dda34e5e151a62fe3459daf4bb3b85705d38810060e71fcadc25669c0f)
 
 [include:file]: ../../docs/Shared/Contributing.md
-[//]: # (start: 6b81b030ae74b2d149ec76cbec1b053da8da4e0ac4fd865f560548f3ead955e8)
+[//]: # (start: 3f7cfa48046722fb9d277c71e074ff8406787772f90d17405b7554a4464cbfee)
 [//]: # (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: 6b81b030ae74b2d149ec76cbec1b053da8da4e0ac4fd865f560548f3ead955e8)
+[//]: # (end: 3f7cfa48046722fb9d277c71e074ff8406787772f90d17405b7554a4464cbfee)
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: 5af9759519da3fa710fb21785e61682fda687a6ebdfb6f0dde4ed03162cb031d)
+[//]: # (start: 3fcf292b870e49aabe885c416dfaf6c6c66d4571e87d3d3975d9cfe34ea6c9fe)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 ## Instructions
@@ -25,29 +25,31 @@ 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: 5af9759519da3fa710fb21785e61682fda687a6ebdfb6f0dde4ed03162cb031d)
+[//]: # (end: 3fcf292b870e49aabe885c416dfaf6c6c66d4571e87d3d3975d9cfe34ea6c9fe)
 
 # Upgrade from v6
 
 [include:file]: ../../docs/Shared/Upgrade/FromV6.md
-[//]: # (start: 8dae6cc48a78a268dcc7b747e512f85b410c9a9392ffac0734f4b17d390f1883)
+[//]: # (start: b0b74ef74f156294a37f3ec42299e221e5e693f3b42297f5cfa79cab99b1df7e)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 * [ ] Direct usages of `Container::getInstances()` were replaced by explicit constructor parameters. You may need to update your code accordingly (#151).
 
-[//]: # (end: 8dae6cc48a78a268dcc7b747e512f85b410c9a9392ffac0734f4b17d390f1883)
+[//]: # (end: b0b74ef74f156294a37f3ec42299e221e5e693f3b42297f5cfa79cab99b1df7e)
 
-* [ ] Migrate to the new contract `\LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\Instruction`.
+* [ ] Migrate to the new contract:
+  * `\LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\Instruction`
+  * `\LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\Resolver`.
 
 # Upgrade from v5
 
 [include:file]: ../../docs/Shared/Upgrade/FromV5.md
-[//]: # (start: 599c87007f162e34f4fd0c7874d4fcf8676e5d8c761d27a9456b284c7d1d12f2)
+[//]: # (start: 6367638a165291d78965aaeae9ab03b304b0a420eb3f5ad9af0424296cc609ea)
 [//]: # (warning: Generated automatically. Do not edit.)
 
 * [ ] Laravel v9 is not supported anymore. Migrate to the newer version.
 
-[//]: # (end: 599c87007f162e34f4fd0c7874d4fcf8676e5d8c761d27a9456b284c7d1d12f2)
+[//]: # (end: 6367638a165291d78965aaeae9ab03b304b0a420eb3f5ad9af0424296cc609ea)
 
 * [ ] Replace `LastDragon_ru\LaraASP\Documentator\Preprocessor\InstructionContract` by `LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\ProcessableInstruction` or `LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\ParameterizableInstruction`.
 

diff --git a/packages/documentator/composer.json b/packages/documentator/composer.json
@@ -34,6 +34,7 @@
     "symfony/polyfill-php83": "^1.28",
     "symfony/serializer": "^6.3.3|^7.0.0",
     "lastdragon-ru/lara-asp-core": "self.version",
+    "lastdragon-ru/lara-asp-formatter": "self.version",
     "lastdragon-ru/lara-asp-graphql-printer": "self.version",
     "lastdragon-ru/lara-asp-serializer": "self.version"
   },