#15 - docker improvement, default rules set improvement (#16)

* Added default value for CURRENT_UID_AND_GID in docker, added .env.example, improved readme.md, bump docker image to 8.0.3.1

* Half fixed BinaryOperatorSpacesFixer, Added PhpdocLineSpanFixer

* ecs fix

* tests fix

* revert docker-compose user value

* pr fixes

* Added PhpdocLineSpanFixer

.env.example

@@ -0,0 +1 @@
+CURRENT_UID=1000

.gitignore

@@ -3,3 +3,4 @@
 /vendor
 
 composer.lock
+.env

composer.json

@@ -25,7 +25,7 @@
   "scripts": {
     "ecs": "./vendor/bin/ecs check",
     "ecsf": "./vendor/bin/ecs check --fix",
-    "test": "./vendor/bin/phpunit tests"
+    "test": "./vendor/bin/phpunit tests --colors always"
   },
   "require-dev": {
     "phpunit/phpunit": "^9.5"

docker-compose.yml

@@ -2,7 +2,7 @@ version: "3.7"
 
 services:
   php:
-    image: ghcr.io/blumilksoftware/php:8.0.2.1
+    image: ghcr.io/blumilksoftware/php:8.0.3.1
     container_name: blumilk-codestyle-php
     working_dir: /application
     user: ${CURRENT_UID}

readme.md

@@ -69,3 +69,29 @@ Then run:
 ```shell
 composer ecs
 ```
+
+# Contributing
+
+### Requirements
+- docker
+- docker-compose
+
+### installation
+
+```shell
+cp .env.example .env
+# adjust '.env' file
+docker-compose up -d
+docker-compose exec php composer install
+```
+### shell
+```shell
+docker-compose exec php ash
+```
+
+### scripts
+```shell
+docker-compose exec php composer ecs
+docker-compose exec php composer ecsf
+docker-compose exec php composer test
+```

src/Configuration/Defaults/CommonAdditionalRules.php

@@ -13,6 +13,7 @@
 use PhpCsFixer\Fixer\FunctionNotation\VoidReturnFixer;
 use PhpCsFixer\Fixer\Import\FullyQualifiedStrictTypesFixer;
 use PhpCsFixer\Fixer\Import\OrderedImportsFixer;
+use PhpCsFixer\Fixer\Phpdoc\PhpdocLineSpanFixer;
 use PhpCsFixer\Fixer\Strict\DeclareStrictTypesFixer;
 
 class CommonAdditionalRules extends Rules implements AdditionalRules
@@ -29,5 +30,9 @@ class CommonAdditionalRules extends Rules implements AdditionalRules
         FullyQualifiedStrictTypesFixer::class => null,
         OrderedImportsFixer::class => null,
         BinaryOperatorSpacesFixer::class => null,
+        PhpdocLineSpanFixer::class => [
+            "const" => "single",
+            "property" => "single",
+        ],
     ];
 }

tests/AdditionalRulesConfigurationTest.php

@@ -14,6 +14,7 @@
 use PhpCsFixer\Fixer\FunctionNotation\VoidReturnFixer;
 use PhpCsFixer\Fixer\Import\FullyQualifiedStrictTypesFixer;
 use PhpCsFixer\Fixer\Import\OrderedImportsFixer;
+use PhpCsFixer\Fixer\Phpdoc\PhpdocLineSpanFixer;
 use PhpCsFixer\Fixer\Strict\DeclareStrictTypesFixer;
 use PhpCsFixer\Fixer\StringNotation\HeredocToNowdocFixer;
 use PHPUnit\Framework\TestCase;
@@ -38,6 +39,10 @@ public function testAdditionalRulesConfiguration(): void
                 FullyQualifiedStrictTypesFixer::class => null,
                 OrderedImportsFixer::class => null,
                 BinaryOperatorSpacesFixer::class => null,
+                PhpdocLineSpanFixer::class => [
+                    "const" => "single",
+                    "property" => "single",
+                ],
             ],
             $config->options()["rules"]
         );
@@ -66,6 +71,10 @@ public function testFilteringAdditionalRulesConfiguration(): void
                 FullyQualifiedStrictTypesFixer::class => null,
                 OrderedImportsFixer::class => null,
                 BinaryOperatorSpacesFixer::class => null,
+                PhpdocLineSpanFixer::class => [
+                    "const" => "single",
+                    "property" => "single",
+                ],
             ],
             $config->options()["rules"]
         );
@@ -91,6 +100,10 @@ public function testExtendingAdditionalRulesConfiguration(): void
                 FullyQualifiedStrictTypesFixer::class => null,
                 OrderedImportsFixer::class => null,
                 BinaryOperatorSpacesFixer::class => null,
+                PhpdocLineSpanFixer::class => [
+                    "const" => "single",
+                    "property" => "single",
+                ],
                 HeredocToNowdocFixer::class => null,
             ],
             $config->options()["rules"]
@@ -121,6 +134,10 @@ public function testExtendingWithOptionsAdditionalRulesConfiguration(): void
                 FullyQualifiedStrictTypesFixer::class => null,
                 OrderedImportsFixer::class => null,
                 BinaryOperatorSpacesFixer::class => null,
+                PhpdocLineSpanFixer::class => [
+                    "const" => "single",
+                    "property" => "single",
+                ],
                 NoMixedEchoPrintFixer::class => [
                     "use" => "echo",
                 ],