use chubbyphp-dev-helper

Author: Dominik Zogg

.php_cs

@@ -1,39 +1,21 @@
 <?php
 
+declare(strict_types=1);
+
 $finder = PhpCsFixer\Finder::create()
     ->files()
     ->name('*.php')
     ->in(__DIR__ . '/src')
     ->in(__DIR__ . '/tests')
 ;
 
+/** @var array $config */
+$config = require __DIR__ . '/vendor/chubbyphp/chubbyphp-dev-helper/phpcs.php';
+
 return PhpCsFixer\Config::create()
-    ->setIndent("    ")
-    ->setLineEnding("\n")
-    ->setRules([
-        '@DoctrineAnnotation' => true,
-        '@PhpCsFixer' => true,
-        '@Symfony' => true,
-        'array_syntax' => ['syntax' => 'short'],
-        'declare_strict_types' => true,
-        'dir_constant' => true,
-        'final_class' => true,
-        'is_null' => true,
-        'linebreak_after_opening_tag' => true,
-        'list_syntax' => ['syntax' => 'short'],
-        'method_chaining_indentation' => false,
-        'no_php4_constructor' => true,
-        'ordered_interfaces' => true,
-        'php_unit_dedicate_assert_internal_type' => true,
-        'php_unit_dedicate_assert' => true,
-        'php_unit_expectation' => true,
-        'php_unit_mock' => true,
-        'php_unit_namespaced' => true,
-        'php_unit_no_expectation_annotation' => true,
-        'single_line_throw' => false,
-        'ternary_to_null_coalescing' => true,
-        'void_return' => true,
-    ])
-    ->setRiskyAllowed(true)
+    ->setIndent($config['indent'])
+    ->setLineEnding($config['lineEnding'])
+    ->setRules($config['rules'])
+    ->setRiskyAllowed($config['riskyAllowed'])
     ->setFinder($finder)
 ;

composer.json

@@ -20,11 +20,10 @@
     },
     "require-dev": {
         "chubbyphp/chubbyphp-container": "^1.0",
+        "chubbyphp/chubbyphp-dev-helper": "dev-master",
         "chubbyphp/chubbyphp-mock": "^1.4.2",
-        "friendsofphp/php-cs-fixer": "^2.16.1",
         "infection/infection": "^0.15",
         "mavimo/phpstan-junit": "^0.3",
-        "nunomaduro/phpinsights": "^1.11.1",
         "php-coveralls/php-coveralls": "^2.2",
         "phploc/phploc": "^5.0",
         "phpstan/extension-installer": "^1.0.3",
@@ -60,7 +59,7 @@
         ],
         "test:cs": "mkdir -p build && vendor/bin/php-cs-fixer fix --dry-run --stop-on-violation --cache-file=build/phpcs.cache",
         "test:infection": "vendor/bin/infection --threads=$(nproc) --min-msi=100 --verbose --coverage=build/phpunit",
-        "test:insights": "mkdir -p build && bash -c 'vendor/bin/phpinsights analyse -v --no-interaction --min-quality=94 --disable-security-check | tee build/phpinsights.log; if [ ${PIPESTATUS[0]} -ne \"0\" ]; then exit 1; fi'",
+        "test:insights": "mkdir -p build && bash -c 'vendor/bin/phpinsights analyse -v --no-interaction --min-quality=95 --disable-security-check | tee build/phpinsights.log; if [ ${PIPESTATUS[0]} -ne \"0\" ]; then exit 1; fi'",
         "test:integration": "vendor/bin/phpunit --testsuite=Integration --cache-result-file=build/phpunit/result.cache",
         "test:lint": "mkdir -p build && find src tests -name '*.php' -print0 | xargs -0 -n1 -P$(nproc) php -l | tee build/phplint.log",
         "test:loc": "mkdir -p build && vendor/bin/phploc src --verbose | tee build/phploc.log",

phpinsights.php

@@ -2,60 +2,7 @@
 
 declare(strict_types=1);
 
-use NunoMaduro\PhpInsights\Domain\Insights\CyclomaticComplexityIsHigh;
-use NunoMaduro\PhpInsights\Domain\Sniffs\ForbiddenSetterSniff;
-use ObjectCalisthenics\Sniffs\Files\FunctionLengthSniff;
-use ObjectCalisthenics\Sniffs\Metrics\MaxNestingLevelSniff;
-use ObjectCalisthenics\Sniffs\Metrics\MethodPerClassLimitSniff;
-use PHP_CodeSniffer\Standards\Generic\Sniffs\Arrays\ArrayIndentSniff;
-use PHP_CodeSniffer\Standards\Generic\Sniffs\CodeAnalysis\UselessOverridingMethodSniff;
-use PHP_CodeSniffer\Standards\Generic\Sniffs\Files\LineLengthSniff;
-use PHP_CodeSniffer\Standards\Generic\Sniffs\Formatting\SpaceAfterNotSniff;
-use PHP_CodeSniffer\Standards\Generic\Sniffs\Strings\UnnecessaryStringConcatSniff;
-use SlevomatCodingStandard\Sniffs\Classes\SuperfluousAbstractClassNamingSniff;
-use SlevomatCodingStandard\Sniffs\Classes\SuperfluousExceptionNamingSniff;
-use SlevomatCodingStandard\Sniffs\Classes\SuperfluousInterfaceNamingSniff;
-use SlevomatCodingStandard\Sniffs\Classes\SuperfluousTraitNamingSniff;
-use SlevomatCodingStandard\Sniffs\ControlStructures\AssignmentInConditionSniff;
-use SlevomatCodingStandard\Sniffs\ControlStructures\DisallowYodaComparisonSniff;
-use SlevomatCodingStandard\Sniffs\Namespaces\UnusedUsesSniff;
+/** @var array $config */
+$config = require __DIR__ . '/vendor/chubbyphp/chubbyphp-dev-helper/phpinsights.php';
 
-return [
-    'preset' => 'default',
-    'exclude' => [],
-    'add' => [],
-    'remove' => [
-        ArrayIndentSniff::class,
-        AssignmentInConditionSniff::class,
-        DisallowYodaComparisonSniff::class,
-        ForbiddenSetterSniff::class,
-        SpaceAfterNotSniff::class,
-        SuperfluousAbstractClassNamingSniff::class,
-        SuperfluousExceptionNamingSniff::class,
-        SuperfluousInterfaceNamingSniff::class,
-        SuperfluousTraitNamingSniff::class,
-        UnnecessaryStringConcatSniff::class,
-        UselessOverridingMethodSniff::class, // cause visibility change on expections __construct,
-    ],
-    'config' => [
-        CyclomaticComplexityIsHigh::class => [
-            'maxComplexity' => 15,
-        ],
-        FunctionLengthSniff::class => [
-            'maxLength' => 30,
-        ],
-        LineLengthSniff::class => [
-            'lineLimit' => 120,
-            'absoluteLineLimit' => 120,
-        ],
-        MaxNestingLevelSniff::class => [
-            'maxNestingLevel' => 5,
-        ],
-        MethodPerClassLimitSniff::class => [
-            'maxCount' => 20,
-        ],
-        UnusedUsesSniff::class => [
-            'searchAnnotations' => true,
-        ],
-    ],
-];
+return $config;

src/ApiProblem/AbstractApiProblem.php

@@ -35,8 +35,8 @@ public function __construct(
         string $type,
         int $status,
         string $title,
-        string $detail = null,
-        string $instance = null
+        ?string $detail = null,
+        ?string $instance = null
     ) {
         $this->type = $type;
         $this->status = $status;

src/ApiProblem/ClientError/BadRequest.php

@@ -9,14 +9,14 @@
 final class BadRequest extends AbstractApiProblem
 {
     /**
-     * @var array<int, array>
+     * @var array<int, array<mixed>>
      */
     private $invalidParameters = [];
 
     /**
-     * @param array<int, array> $invalidParameters
+     * @param array<int, array<mixed>> $invalidParameters
      */
-    public function __construct(array $invalidParameters, string $detail = null, string $instance = null)
+    public function __construct(array $invalidParameters, ?string $detail = null, ?string $instance = null)
     {
         parent::__construct(
             'https://tools.ietf.org/html/rfc2616#section-10.4.1',
@@ -30,7 +30,7 @@ public function __construct(array $invalidParameters, string $detail = null, str
     }
 
     /**
-     * @return array<int, array>
+     * @return array<int, array<mixed>>
      */
     public function getInvalidParameters(): array
     {

src/ApiProblem/ClientError/Conflict.php

@@ -8,7 +8,7 @@
 
 final class Conflict extends AbstractApiProblem
 {
-    public function __construct(string $detail = null, string $instance = null)
+    public function __construct(?string $detail = null, ?string $instance = null)
     {
         parent::__construct(
             'https://tools.ietf.org/html/rfc2616#section-10.4.10',

src/ApiProblem/ClientError/ExpectationFailed.php

@@ -16,7 +16,7 @@ final class ExpectationFailed extends AbstractApiProblem
     /**
      * @param array<int, string> $failedExpectations
      */
-    public function __construct(array $failedExpectations, string $detail = null, string $instance = null)
+    public function __construct(array $failedExpectations, ?string $detail = null, ?string $instance = null)
     {
         parent::__construct(
             'https://tools.ietf.org/html/rfc2616#section-10.4.18',

src/ApiProblem/ClientError/FailedDependency.php

@@ -8,7 +8,7 @@
 
 final class FailedDependency extends AbstractApiProblem
 {
-    public function __construct(string $detail = null, string $instance = null)
+    public function __construct(?string $detail = null, ?string $instance = null)
     {
         parent::__construct(
             'https://tools.ietf.org/html/rfc4918#section-11.4',

src/ApiProblem/ClientError/Forbidden.php

@@ -8,7 +8,7 @@
 
 final class Forbidden extends AbstractApiProblem
 {
-    public function __construct(string $detail = null, string $instance = null)
+    public function __construct(?string $detail = null, ?string $instance = null)
     {
         parent::__construct(
             'https://tools.ietf.org/html/rfc2616#section-10.4.4',

src/ApiProblem/ClientError/Gone.php

@@ -8,7 +8,7 @@
 
 final class Gone extends AbstractApiProblem
 {
-    public function __construct(string $detail = null, string $instance = null)
+    public function __construct(?string $detail = null, ?string $instance = null)
     {
         parent::__construct(
             'https://tools.ietf.org/html/rfc2616#section-10.4.11',