mirror of
https://github.com/FriendsOfTYPO3/tea.git
synced 2024-11-10 00:56:12 +01:00
Daniel Siepmann
1462282da6
A new composer package "spaze/phpstan-disallowed-calls" is added. This one is a PHPStan extension which will check for forbidden calls. Those calls need to be defined per project. We use this to prevent debugging and other none good practices from showing up in our code base. We include the pre defined rules from the package. Those can be argued and adjusted once we hit them. Resolves: #1158
233 lines
8.3 KiB
JSON
233 lines
8.3 KiB
JSON
{
|
|
"name": "ttn/tea",
|
|
"description": "TYPO3 example extension for unit testing and best practices",
|
|
"license": "GPL-2.0-or-later",
|
|
"type": "typo3-cms-extension",
|
|
"keywords": [
|
|
"typo3",
|
|
"example",
|
|
"extension",
|
|
"tdd",
|
|
"phpunit",
|
|
"unit testing",
|
|
"best practices"
|
|
],
|
|
"authors": [
|
|
{
|
|
"name": "Oliver Klee",
|
|
"email": "typo3-coding@oliverklee.de",
|
|
"homepage": "https://www.oliverklee.de",
|
|
"role": "maintainer"
|
|
},
|
|
{
|
|
"name": "Daniel Siepmann",
|
|
"email": "coding@daniel-siepmann.de",
|
|
"homepage": "https://daniel-siepmann.de/",
|
|
"role": "maintainer"
|
|
},
|
|
{
|
|
"name": "Łukasz Uznański",
|
|
"email": "lukaszuznanski94@gmail.com",
|
|
"homepage": "https://uznanski.pl/",
|
|
"role": "maintainer"
|
|
}
|
|
],
|
|
"homepage": "https://extensions.typo3.org/extension/tea/",
|
|
"support": {
|
|
"issues": "https://github.com/FriendsOfTYPO3/tea/issues",
|
|
"source": "https://github.com/FriendsOfTYPO3/tea",
|
|
"docs": "https://docs.typo3.org/p/ttn/tea/main/en-us/"
|
|
},
|
|
"require": {
|
|
"php": "~7.4.0 || ~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0",
|
|
"psr/http-message": "^1.0.1",
|
|
"typo3/cms-core": "^11.5.4 || ^12.4",
|
|
"typo3/cms-extbase": "^11.5.4 || ^12.4",
|
|
"typo3/cms-fluid": "^11.5.4 || ^12.4",
|
|
"typo3/cms-frontend": "^11.5.4 || ^12.4"
|
|
},
|
|
"require-dev": {
|
|
"ergebnis/composer-normalize": "^2.42.0",
|
|
"friendsofphp/php-cs-fixer": "^3.49.0",
|
|
"helmich/typo3-typoscript-lint": "^3.1.0",
|
|
"php-coveralls/php-coveralls": "^2.7.0",
|
|
"phpstan/extension-installer": "^1.3.1",
|
|
"phpstan/phpstan": "^1.10.57",
|
|
"phpstan/phpstan-phpunit": "^1.3.15",
|
|
"phpstan/phpstan-strict-rules": "^1.5.2",
|
|
"phpunit/phpunit": "^9.6.16",
|
|
"saschaegerer/phpstan-typo3": "^1.10.0",
|
|
"seld/jsonlint": "^1.10.1",
|
|
"spaze/phpstan-disallowed-calls": "^3.1",
|
|
"squizlabs/php_codesniffer": "^3.8.1",
|
|
"symfony/console": "^5.4 || ^6.4 || ^7.0",
|
|
"symfony/translation": "^5.4 || ^6.4 || ^7.0",
|
|
"symfony/yaml": "^5.4 || ^6.4 || ^7.0",
|
|
"tomasvotruba/cognitive-complexity": "^0.2.3",
|
|
"tomasvotruba/type-coverage": "^0.2.1",
|
|
"typo3/cms-fluid-styled-content": "^11.5.4 || ^12.4.0",
|
|
"typo3/coding-standards": "^0.6.1",
|
|
"typo3/testing-framework": "^7.0.4"
|
|
},
|
|
"replace": {
|
|
"typo3-ter/tea": "self.version"
|
|
},
|
|
"conflict": {
|
|
"typo3/class-alias-loader": "< 1.1.0"
|
|
},
|
|
"prefer-stable": true,
|
|
"autoload": {
|
|
"psr-4": {
|
|
"TTN\\Tea\\": "Classes/"
|
|
}
|
|
},
|
|
"autoload-dev": {
|
|
"psr-4": {
|
|
"TTN\\Tea\\Tests\\": "Tests/"
|
|
}
|
|
},
|
|
"config": {
|
|
"allow-plugins": {
|
|
"ergebnis/composer-normalize": true,
|
|
"phpstan/extension-installer": true,
|
|
"sbuerk/typo3-cmscomposerinstallers-testingframework-bridge": true,
|
|
"typo3/class-alias-loader": true,
|
|
"typo3/cms-composer-installers": true
|
|
},
|
|
"bin-dir": ".Build/bin",
|
|
"preferred-install": {
|
|
"*": "dist"
|
|
},
|
|
"sort-packages": true,
|
|
"vendor-dir": ".Build/vendor"
|
|
},
|
|
"extra": {
|
|
"branch-alias": {
|
|
"dev-main": "4.0.x-dev"
|
|
},
|
|
"typo3/cms": {
|
|
"extension-key": "tea",
|
|
"web-dir": ".Build/public"
|
|
}
|
|
},
|
|
"scripts": {
|
|
"ci:composer:normalize": "@composer normalize --no-check-lock --dry-run",
|
|
"ci:composer:psr-verify": "@composer dumpautoload --optimize --strict-psr --no-plugins",
|
|
"ci:coverage": [
|
|
"@ci:coverage:unit",
|
|
"@ci:coverage:functional"
|
|
],
|
|
"ci:coverage:functional": [
|
|
"@ci:tests:create-directories",
|
|
"@coverage:create-directories",
|
|
".Build/bin/phpunit -c ./Configuration/FunctionalTests.xml --whitelist Classes --coverage-php=.Build/coverage/functional.cov Tests/Functional"
|
|
],
|
|
"ci:coverage:merge": [
|
|
"@coverage:create-directories",
|
|
"@php tools/phpcov merge --clover=./.Build/logs/clover.xml ./.Build/coverage/"
|
|
],
|
|
"ci:coverage:unit": [
|
|
"@coverage:create-directories",
|
|
".Build/bin/phpunit -c ./Configuration/UnitTests.xml --whitelist Classes --coverage-php=.Build/coverage/unit.cov Tests/Unit"
|
|
],
|
|
"ci:json:lint": "find . ! -path '*/.cache/*' ! -path '*/.Build/*' ! -path '*/node_modules/*' -name '*.json' | xargs -r php .Build/bin/jsonlint -q",
|
|
"ci:php": [
|
|
"@ci:php:cs-fixer",
|
|
"@ci:php:lint",
|
|
"@ci:php:sniff",
|
|
"@ci:php:stan"
|
|
],
|
|
"ci:php:cs-fixer": "php-cs-fixer fix --config .php-cs-fixer.php -v --dry-run --diff",
|
|
"ci:php:lint": "find .*.php *.php Classes Configuration Tests -name '*.php' -print0 | xargs -r -0 -n 1 -P 4 php -l",
|
|
"ci:php:sniff": "phpcs Classes Configuration Tests",
|
|
"ci:php:stan": "phpstan --no-progress",
|
|
"ci:static": [
|
|
"@ci:composer:normalize",
|
|
"@ci:json:lint",
|
|
"@ci:php:cs-fixer",
|
|
"@ci:php:lint",
|
|
"@ci:php:sniff",
|
|
"@ci:php:stan",
|
|
"@ci:ts:lint",
|
|
"@ci:yaml:lint"
|
|
],
|
|
"ci:tests:create-directories": "mkdir -p .Build/public/typo3temp/var/tests",
|
|
"ci:tests:functional": [
|
|
"@ci:tests:create-directories",
|
|
"find 'Tests/Functional' -wholename '*Test.php' | parallel --gnu 'echo; echo \"Running functional test suite {}\"; .Build/bin/phpunit -c ./Configuration/FunctionalTests.xml {}';"
|
|
],
|
|
"ci:tests:unit": ".Build/bin/phpunit -c ./Configuration/UnitTests.xml Tests/Unit",
|
|
"ci:ts:lint": "typoscript-lint -c Configuration/TsLint.yml --ansi -n --fail-on-warnings -vvv Configuration/TypoScript",
|
|
"ci:xliff:lint": "php Build/bin/console lint:xliff Resources/Private/Language",
|
|
"ci:yaml:lint": "find . ! -path '*.Build/*' ! -path '*node_modules/*' -regextype egrep -regex '.*.ya?ml$' | xargs -r php ./.Build/bin/yaml-lint",
|
|
"coverage:create-directories": "mkdir -p .Build/logs .Build/coverage",
|
|
"docs:generate": [
|
|
"@docs:generate:pullimage",
|
|
"docker run --rm ghcr.io/t3docs/render-documentation show-shell-commands > tempfile.sh; echo 'dockrun_t3rd makehtml' >> tempfile.sh; bash tempfile.sh; rm tempfile.sh"
|
|
],
|
|
"docs:generate:pullimage": [
|
|
"docker pull ghcr.io/t3docs/render-documentation",
|
|
"docker tag ghcr.io/t3docs/render-documentation t3docs/render-documentation"
|
|
],
|
|
"fix:composer:normalize": "@composer normalize --no-check-lock",
|
|
"fix:php": [
|
|
"@fix:php:cs",
|
|
"@fix:php:sniff"
|
|
],
|
|
"fix:php:cs": "php-cs-fixer fix --config .php-cs-fixer.php",
|
|
"fix:php:sniff": "phpcbf Classes Configuration Tests",
|
|
"phpstan:baseline": ".Build/bin/phpstan --generate-baseline --allow-empty-baseline",
|
|
"prepare-release": [
|
|
"rm -rf .Build",
|
|
"rm -rf .ddev",
|
|
"rm -rf .github",
|
|
"rm -rf .gitlab",
|
|
"rm -rf Build",
|
|
"rm -rf Tests",
|
|
"rm -rf tools",
|
|
"rm .editorconfig",
|
|
"rm .eslintignore",
|
|
"rm .eslintrc.json",
|
|
"rm .gitattributes",
|
|
"rm .gitignore",
|
|
"rm .php-cs-fixer.php",
|
|
"rm .prettierrc.js",
|
|
"rm Configuration/FunctionalTests.xml",
|
|
"rm Configuration/UnitTests.xml",
|
|
"rm package.json",
|
|
"rm phive.xml",
|
|
"rm phpcs.xml",
|
|
"rm phpstan-baseline.neon",
|
|
"rm phpstan.neon",
|
|
"rm stylelint.config.js"
|
|
]
|
|
},
|
|
"scripts-descriptions": {
|
|
"ci:composer:normalize": "Checks the composer.json.",
|
|
"ci:composer:psr-verify": "Verifies PSR-4 namespace correctness.",
|
|
"ci:coverage:functional": "Generates the code coverage report for functional tests.",
|
|
"ci:coverage:merge": "Merges the code coverage reports for unit and functional tests.",
|
|
"ci:coverage:unit": "Generates the code coverage report for unit tests.",
|
|
"ci:json:lint": "Lints the JSON files.",
|
|
"ci:php": "Runs all static checks for the PHP files.",
|
|
"ci:php:cs-fixer": "Checks the code style with the PHP Coding Standards Fixer (PHP-CS-Fixer).",
|
|
"ci:php:lint": "Lints the PHP files for syntax errors.",
|
|
"ci:php:sniff": "Checks the code style with PHP_CodeSniffer (PHPCS).",
|
|
"ci:php:stan": "Checks the PHP types using PHPStan.",
|
|
"ci:static": "Runs all static code checks (syntax, style, types).",
|
|
"ci:tests:create-directories": "Creates the directories required to smoothely run the functional tests.",
|
|
"ci:tests:functional": "Runs the functional tests.",
|
|
"ci:tests:unit": "Runs the unit tests.",
|
|
"ci:ts:lint": "Lints the TypoScript files.",
|
|
"ci:xliff:lint": "Lints the XLIFF files.",
|
|
"ci:yaml:lint": "Lints the YAML files.",
|
|
"coverage:create-directories": "Creates the directories needed for recording and merging the code coverage reports.",
|
|
"docs:generate": "Renders the extension ReST documentation.",
|
|
"fix:composer:normalize": "Normalizes composer.json file content.",
|
|
"fix:php": "Runs all fixers for the PHP code.",
|
|
"fix:php:cs": "Fixes the code style with PHP-CS-Fixer.",
|
|
"fix:php:sniff": "Fixes the code style with PHP_CodeSniffer.",
|
|
"phpstan:baseline": "Updates the PHPStan baseline file to match the code.",
|
|
"prepare-release": "Removes development-only files in preparation of a TER release."
|
|
}
|
|
}
|