Add PHP-CS-Fixer (#691)

Author: theofidry

.github/workflows/lint.yaml

@@ -15,7 +15,7 @@ jobs:
                 php: [ '8.1' ]
                 check:
                     -   name: CS
-                        command: make cs
+                        command: make cs_lint
                     -   name: PHPStan
                         command: make phpstan
 

.gitignore

@@ -4,6 +4,7 @@
 !/bin/php-scoper
 !/bin/root-version.php
 /.box_dump/
+/.php-cs-fixer.cache
 /box.json
 /build/
 /clover.xml

.php-cs-fixer.dist.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the humbug/php-scoper package.
+ *
+ * Copyright (c) 2017 Théo FIDRY <theo.fidry@gmail.com>,
+ *                    Pádraic Brady <padraic.brady@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Fidry\PhpCsFixerConfig\FidryConfig;
+use PhpCsFixer\Finder;
+
+$finder = Finder::create()
+    ->in([
+        'src',
+        'tests',
+    ])
+    ->append([
+        'bin/check-composer-root-version.php',
+        'bin/dump-composer-root-version.php',
+        'bin/php-scoper',
+        'bin/root-version.php',
+        '.php-cs-fixer.dist.php',
+        'scoper.inc.php',
+    ]);
+
+$overriddenRules = [
+    'header_comment' => [
+        'header' => <<<'EOF'
+            This file is part of the humbug/php-scoper package.
+
+            Copyright (c) 2017 Théo FIDRY <theo.fidry@gmail.com>,
+                               Pádraic Brady <padraic.brady@gmail.com>
+
+            For the full copyright and license information, please view the LICENSE
+            file that was distributed with this source code.
+            EOF,
+        'location' => 'after_declare_strict',
+    ],
+    'mb_str_functions' => false,
+    'no_unneeded_control_parentheses' => false,
+    'yoda_style' => false,
+];
+
+$config = new FidryConfig('', 74000);
+$config->addRules($overriddenRules);
+
+return $config->setFinder($finder);

Makefile

@@ -10,9 +10,6 @@ PHP_SCOPER=$(PHP_SCOPER_BIN)
 
 COMPOSER_BIN_PLUGIN_VENDOR=vendor/bamarni/composer-bin-plugin
 
-CODE_SNIFFER=vendor-bin/code-sniffer/vendor/bin/phpcs
-CODE_SNIFFER_FIX=vendor-bin/code-sniffer/vendor/bin/phpcbf
-
 PHPSTAN_BIN=vendor-bin/phpstan/vendor/bin/phpstan
 PHPSTAN=$(PHPSTAN_BIN) analyze src tests --level max --memory-limit=-1
 
@@ -31,6 +28,9 @@ PHPUNIT_COVERAGE_HTML = XDEBUG_MODE=coverage $(PHPUNIT) --coverage-html=$(COVERA
 COVERS_VALIDATOR_BIN=vendor-bin/covers-validator/bin/covers-validator
 COVERS_VALIDATOR=$(COVERS_VALIDATOR_BIN)
 
+PHP_CS_FIXER_BIN = vendor-bin/php-cs-fixer/vendor/friendsofphp/php-cs-fixer/php-cs-fixer
+PHP_CS_FIXER = $(PHP_CS_FIXER_BIN) fix
+
 BLACKFIRE=blackfire
 
 
@@ -58,15 +58,28 @@ update_root_version:
 	$(MAKE) .composer-root-version
 
 .PHONY: cs
-cs:	 ## Fixes CS
-cs: $(CODE_SNIFFER) $(CODE_SNIFFER_FIX)
-	php $(CODE_SNIFFER_FIX) || true
-	php $(CODE_SNIFFER)
+cs:	## Fixes CS
+cs: php_cs_fixer
+
+.PHONY: cs_lint
+cs_lint:	## Checks CS
+cs_lint: composer_normalize_lint php_cs_fixer_lint
+
+.PHONY: php_cs_fixer
+php_cs_fixer: $(PHP_CS_FIXER_BIN)
+	$(PHP_CS_FIXER)
 
-.PHONY: cs-check
-cs-check:	## Checks CS
-cs-check: $(CODE_SNIFFER)
-	php $(CODE_SNIFFER)
+.PHONY: php_cs_fixer_lint
+php_cs_fixer_lint: $(PHP_CS_FIXER_BIN)
+	$(PHP_CS_FIXER) --dry-run
+
+.PHONY: composer_normalize
+composer_normalize: composer.json vendor
+	composer normalize
+
+.PHONY: composer_normalize_lint
+composer_normalize_lint: composer.json vendor
+	composer normalize --dry-run
 
 .PHONY: phpstan
 phpstan: ## Runs PHPStan
@@ -132,8 +145,8 @@ infection: $(COVERAGE_XML) vendor
 .PHONY: blackfire
 blackfire:	## Runs Blackfire profiling
 blackfire: $(PHP_SCOPER_BIN) vendor
-	@echo By https://blackfire.io
-	@echo This might take a while (~2min)
+	@echo "By https://blackfire.io"
+	@echo "This might take a while (~2min)"
 	$(BLACKFIRE) run php $(PHP_SCOPER_BIN) add-prefix --output-dir=build/php-scoper --force --quiet
 
 .PHONY: e2e
@@ -509,20 +522,20 @@ vendor-bin/covers-validator/vendor: vendor-bin/covers-validator/composer.lock $(
 vendor-bin/covers-validator/composer.lock: vendor-bin/covers-validator/composer.json
 	@echo covers-validator composer.lock is not up to date
 
+$(PHP_CS_FIXER_BIN): vendor-bin/php-cs-fixer/vendor
+vendor-bin/php-cs-fixer/vendor: vendor-bin/php-cs-fixer/composer.lock $(COMPOSER_BIN_PLUGIN_VENDOR)
+	composer bin php-cs-fixer install
+	touch -c $@
+vendor-bin/php-cs-fixer/composer.lock: vendor-bin/php-cs-fixer/composer.json
+	@echo php-cs-fixer composer.lock is not up to date
+
 $(PHPSTAN_BIN): vendor-bin/phpstan/vendor
 vendor-bin/phpstan/vendor: vendor-bin/phpstan/composer.lock $(COMPOSER_BIN_PLUGIN_VENDOR)
 	composer bin phpstan install
 	touch -c $@
 vendor-bin/phpstan/composer.lock: vendor-bin/phpstan/composer.json
 	@echo phpstan composer.lock is not up to date
 
-vendor-bin/code-sniffer/vendor: vendor-bin/code-sniffer/composer.lock $(COMPOSER_BIN_PLUGIN_VENDOR)
-	composer bin code-sniffer install
-	touch -c $@
-
-vendor-bin/code-sniffer/composer.lock: vendor-bin/code-sniffer/composer.json
-	@echo code-sniffer composer.lock is not up to date
-
 $(PHP_SCOPER_BIN): $(BOX) bin/php-scoper $(SRC_FILES) vendor-hotfix vendor scoper.inc.php box.json.dist
 	$(BOX) compile
 	touch -c $@
@@ -531,14 +544,6 @@ $(COVERAGE_XML): $(PHPUNIT_BIN) $(SRC_FILES)
 	$(MAKE) phpunit_coverage_infection
 	touch -c "$@"
 
-$(CODE_SNIFFER): vendor-bin/code-sniffer/vendor
-	composer bin code-sniffer install
-	touch -c $@
-
-$(CODE_SNIFFER_FIX): vendor-bin/code-sniffer/vendor
-	composer bin code-sniffer install
-	touch -c $@
-
 fixtures/set005/vendor: fixtures/set005/composer.lock
 	composer --working-dir=fixtures/set005 install
 	touch -c $@

bin/check-composer-root-version.php

@@ -35,7 +35,7 @@
 preg_match(
     '/COMPOSER_ROOT_VERSION=\'(?<version>.*?)\'/',
     file_get_contents(__DIR__.'/../.composer-root-version'),
-    $matches
+    $matches,
 );
 
 $currentRootVersion = $matches['version'];
@@ -46,8 +46,8 @@
         sprintf(
             'Expected the COMPOSER_ROOT_VERSION value to be "%s" but got "%s" instead.'.PHP_EOL,
             $expectedComposerRootVersion,
-            $currentRootVersion
-        )
+            $currentRootVersion,
+        ),
     );
 
     exit(1);

bin/dump-composer-root-version.php

@@ -37,11 +37,11 @@
     __DIR__.'/../.composer-root-version',
     sprintf(
         <<<'BASH'
-        #!/usr/bin/env bash
-        
-        export COMPOSER_ROOT_VERSION='%s'
-        
-        BASH,
+            #!/usr/bin/env bash
+
+            export COMPOSER_ROOT_VERSION='%s'
+
+            BASH,
         $composerRootVersion,
     ),
 );
@@ -52,7 +52,7 @@
         '/COMPOSER_ROOT_VERSION: \'.*?\'/',
         sprintf(
             'COMPOSER_ROOT_VERSION: \'%s\'',
-            $composerRootVersion
+            $composerRootVersion,
         ),
         file_get_contents($scrutinizerPath),
     ),

bin/php-scoper

@@ -31,7 +31,7 @@ set_error_handler(
         if (error_reporting() & $code) {
             throw new ErrorException($message, 0, $code, $file, $line);
         }
-    }
+    },
 );
 
 $findAutoload = static function () {

bin/root-version.php

@@ -34,12 +34,11 @@ function request_tags(): string
 
     $headerOption = false === $gitHubToken || '' === $gitHubToken
         ? ''
-        : "-H \"Authorization: token $gitHubToken\""
-    ;
+        : "-H \"Authorization: token {$gitHubToken}\"";
 
     $command = <<<BASH
-    curl -s $headerOption https://api.github.com/repos/humbug/php-scoper/tags?per_page=1
-    BASH;
+        curl -s {$headerOption} https://api.github.com/repos/humbug/php-scoper/tags?per_page=1
+        BASH;
 
     echo 'cURL command:'.PHP_EOL;
     echo '$ '.$command;
@@ -67,7 +66,7 @@ function parse_tag(string $responseContent): string
         throw new RuntimeException(
             sprintf(
                 'No tag name could be found in: %s',
-                $responseContent
+                $responseContent,
             ),
             100,
         );
@@ -79,7 +78,7 @@ function parse_tag(string $responseContent): string
         throw new RuntimeException(
             sprintf(
                 'No tag name could be found in: %s',
-                $responseContent
+                $responseContent,
             ),
             100,
         );
@@ -89,7 +88,7 @@ function parse_tag(string $responseContent): string
         throw new RuntimeException(
             sprintf(
                 'No tag name could be found in: %s',
-                $responseContent
+                $responseContent,
             ),
             100,
         );

composer.json

@@ -16,9 +16,6 @@
             "email": "padraic.brady@gmail.com"
         }
     ],
-
-    "minimum-stability": "dev",
-    "prefer-stable": true,
     "require": {
         "php": "^8.1",
         "composer/package-versions-deprecated": "^1.8",
@@ -34,42 +31,46 @@
     },
     "require-dev": {
         "bamarni/composer-bin-plugin": "^1.1",
+        "ergebnis/composer-normalize": "^2.28",
         "humbug/box": "^4.0",
         "phpspec/prophecy-phpunit": "^2.0",
         "phpunit/phpunit": "^9.0"
     },
     "replace": {
         "symfony/polyfill-php73": "*"
     },
-
-    "bin": ["bin/php-scoper"],
+    "minimum-stability": "dev",
+    "prefer-stable": true,
     "autoload": {
-        "files": [
-            "src/functions.php"
-        ],
         "psr-4": {
             "Humbug\\PhpScoper\\": "src/"
-        }
+        },
+        "files": [
+            "src/functions.php"
+        ]
     },
     "autoload-dev": {
-        "files": [
-            "tests/functions.php"
-        ],
         "psr-4": {
             "Humbug\\PhpScoper\\": "tests/"
-        }
+        },
+        "files": [
+            "tests/functions.php"
+        ]
     },
-
+    "bin": [
+        "bin/php-scoper"
+    ],
     "config": {
+        "allow-plugins": {
+            "bamarni/composer-bin-plugin": true,
+            "composer/package-versions-deprecated": true,
+            "ergebnis/composer-normalize": true
+        },
         "bin-dir": "bin",
-        "sort-packages": true,
         "platform": {
             "php": "8.1.0"
         },
-        "allow-plugins": {
-            "bamarni/composer-bin-plugin": true,
-            "composer/package-versions-deprecated": true
-        }
+        "sort-packages": true
     },
     "extra": {
         "bamarni-bin": {