Configure rules for PHP 7.4, 8.0 and 8.1

Author: jeromegamez

.gitattributes

@@ -4,5 +4,4 @@
 /.editorconfig                  export-ignore
 /.gitattributes                 export-ignore
 /.gitignore                     export-ignore
-/.php-cs-fixer.php              export-ignore
-/phpstan.neon.dist              export-ignore
+/.php-cs-fixer.dist.php         export-ignore

.github/workflows/tests.yml

@@ -1,8 +1,4 @@
 /vendor/
 
 /.php-cs-fixer.cache
-/.phpunit.result.cache
-
 /composer.lock
-/phpstan.neon
-/phpunit.xml

.gitignore

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+use Beste\PhpCsFixer\Config;
+use Ergebnis\PhpCsFixer\Config\Factory;
+
+$config = Factory::fromRuleSet(new Config\RuleSet\Php81());
+
+$config
+    ->getFinder()
+    ->in(__DIR__)
+    ->ignoreDotFiles(false);
+
+return $config;

.php-cs-fixer.dist.php

@@ -0,0 +1,16 @@
+# CHANGELOG
+
+## [Unreleased]
+
+## [1.0.0] - 2022-08-25
+
+* Rules extend the Ergebnis rules with the following modifications:
+  * `blank_line_between_import_groups`: Blank lines are put between import groups 
+  * `global_namespace_import`: classes and functions are imported
+  * `phpdoc_align`: PHPDoc items are left-aligned
+  * `phpdoc_types_order`: types are not sorted, `null` is always last
+  * `php_unit_test_class_requires_covers`: Tests don't require `@covers` annotations
+  * `yoda_style`: Condition styles are not enforced
+
+[Unreleased]: https://github.com/beste/php-cs-fixer-config/compare/1.0.0...main
+[1.0.0]: https://github.com/beste/php-cs-fixer-config/tree/1.0.0

.php-cs-fixer.php

@@ -1,15 +1,29 @@
-# PHP CS Fixer Config
+# BESTE PHP CS Fixer Config
 
-PHP CS Fixer Config used in BESTE projects
+PHP CS Fixer Config used in BESTE projects, based on
+[`ergebnis/php-cs-fixer-config`](https://github.com/ergebnis/php-cs-fixer-config).
 
 ## Installation
 
 ```shell
-composer require beste/php-cs-fixer-config
+composer require --dev beste/php-cs-fixer-config
 ```
 
-## Running tests
+## Usage
 
-```shell
-composer run tests
-```
+Detailed usage instructions can be found in the
+[README of `ergebnis/php-cs-fixer-config`](https://github.com/ergebnis/php-cs-fixer-config/blob/main/README.md).
+
+### Available configurations
+
+* [`Beste\PhpCsFixer\Config\RuleSet\Php74`](src/Config/RuleSet/Php74.php)
+* [`Beste\PhpCsFixer\Config\RuleSet\Php80`](src/Config/RuleSet/Php80.php)
+* [`Beste\PhpCsFixer\Config\RuleSet\Php81`](src/Config/RuleSet/Php81.php)
+
+## Changelog
+
+Please have a look at [`CHANGELOG.md`](CHANGELOG.md).
+
+## Credits
+
+This project extends [`ergebnis/php-cs-fixer-config`](https://github.com/ergebnis/php-cs-fixer-config).

CHANGELOG.md

@@ -10,50 +10,15 @@
         }
     ],
     "require": {
-        "php": "~8.0.0 || ~8.1.0"
-    },
-    "require-dev": {
-        "ergebnis/composer-normalize": "^2.28",
-        "ergebnis/php-cs-fixer-config": "^4.4",
-        "ergebnis/phpstan-rules": "^1.0",
-        "phpstan/extension-installer": "^1.1",
-        "phpstan/phpstan": "^1.8",
-        "phpstan/phpstan-deprecation-rules": "^1.0",
-        "phpstan/phpstan-phpunit": "^1.1.1",
-        "phpstan/phpstan-strict-rules": "^1.3.0",
-        "phpunit/phpunit": "^9.5"
+        "php": "^8.1",
+        "ergebnis/php-cs-fixer-config": "^4.7"
     },
     "autoload": {
         "psr-4": {
             "Beste\\PhpCsFixer\\": "src"
         }
     },
-    "autoload-dev": {
-        "psr-4": {
-            "Beste\\PhpCsFixer\\Tests\\": "tests"
-        }
-    },
-    "config": {
-        "allow-plugins": {
-            "phpstan/extension-installer": true,
-            "composer/package-versions-deprecated": true,
-            "ergebnis/composer-normalize": true
-        },
-        "sort-packages": true
-    },
     "scripts": {
-        "cs": "vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php --diff --verbose",
-        "phpstan": "vendor/bin/phpstan analyse",
-        "phpunit": "vendor/bin/phpunit",
-        "test": [
-            "@phpstan",
-            "@phpunit"
-        ]
-    },
-    "scripts-descriptions": {
-        "cs": "Applies coding standards",
-        "phpstan": "Runs static analysis with PHPStan",
-        "phpunit": "Runs tests with PHPUnit",
-        "test": "Runs static analysis and test suites"
+        "cs": "vendor/bin/php-cs-fixer fix --diff --verbose"
     }
 }