From 47455a894128b5eb62f0b9b18dd6d23aed295e92 Mon Sep 17 00:00:00 2001 From: Mathias Bolt Lesniak Date: Sun, 22 Aug 2021 17:47:05 +0200 Subject: [PATCH] [FEATURE] Add Composer command for rendering documentation (#277) Adds the command `docs:generate` to `composer.json`. --- README.md | 1 + composer.json | 3 +++ 2 files changed, 4 insertions(+) diff --git a/README.md b/README.md index c939d61..cb8d09c 100644 --- a/README.md +++ b/README.md @@ -143,6 +143,7 @@ Composer commands and scripts. |`ci:tests:unit` | run the unit tests | [PHPUnit](https://github.com/sebastianbergmann/phpunit/) | |`ci:ts:lint` | lint the TypoScript files | [TypoScript Lint](https://github.com/martin-helmich/typo3-typoscript-lint) | |`ci:yaml:lint` | lint the YAML files | [yaml-lint](https://github.com/j13k/yaml-lint) | +|`docs:generate` | render documentation | [dockrun_t3rd](https://github.com/t3docs/docker-render-documentation#readme) | |`fix:php` | run all fixes for PHP | the tools listed for the individual checks | |`fix:php:cs` | fix the code style | [PHP Coding Standards Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer) | |`fix:php:sniff` | fix the code style | [PHP_CodeSniffer (PHPCS)](https://github.com/squizlabs/PHP_CodeSniffer) | diff --git a/composer.json b/composer.json index 88d219c..390e91f 100644 --- a/composer.json +++ b/composer.json @@ -112,6 +112,9 @@ "ci:tests:unit": ".Build/vendor/bin/phpunit -c .Build/vendor/nimut/testing-framework/res/Configuration/UnitTests.xml Tests/Unit", "ci:ts:lint": "@php ./tools/typo3-typoscript-lint -c Configuration/TsLint.yml --ansi -n --fail-on-warnings -vvv Configuration/TypoScript", "ci:yaml:lint": "find . ! -path '*.Build/*' ! -path '*Resources/Private/node_modules/*' -name '*.yml' | xargs php ./tools/yaml-lint", + "docs:generate": [ + "docker run --rm t3docs/render-documentation show-shell-commands > tempfile.sh; echo 'dockrun_t3rd makehtml' >> tempfile.sh; bash tempfile.sh; rm tempfile.sh" + ], "fix:php": [ "@fix:php:cs", "@fix:php:sniff"