Add(linting) Add code linting to GitHub workflow, use php-cs-fixer

.editorconfig

@@ -2,7 +2,7 @@ root = true
 
 [*]
 indent_style = space
-indent_size = 2
+indent_size = 4
 end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true

.github/workflows/lint.yml

@@ -0,0 +1,31 @@
+name: "Code Linting"
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  php-cs-fixer:
+    name: 'PHP-CS-Fixer'
+    runs-on: 'ubuntu-latest'
+    steps:
+      - uses: 'actions/checkout@v3'
+
+      - name: 'Setup PHP'
+        uses: 'shivammathur/setup-php@v2'
+        with:
+          php-version: '8.1'
+          tools: php-cs-fixer, cs2pr
+
+      - uses: 'actions/cache@v3'
+        with:
+          path: '.php-cs-fixer.cache'
+          key: '${{ github.repository }}-8.1-phpcsfixer-${{ github.ref_name }}'
+          restore-keys: |
+            ${{ github.repository }}-8.1-phpcsfixer-main
+            ${{ github.repository }}-8.1-phpcsfixer-
+
+      - name: 'Run PHP-CS-Fixer'
+        # Using cs2pr settings, see: https://github.com/shivammathur/setup-php#tools-with-checkstyle-support
+        run: 'php-cs-fixer fix --dry-run --format checkstyle | cs2pr'

.gitignore

@@ -6,3 +6,4 @@
 lib/plugins/sfDoctrinePlugin/test/functional/fixtures/log/
 /vendor
 /composer.lock
+.php-cs-fixer.cache

.php-cs-fixer.dist.php

@@ -0,0 +1,29 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->ignoreVCSIgnored(true)
+    ->in(__DIR__.'/lib')
+    ->in(__DIR__.'/data/bin')
+    ->in(__DIR__.'/test')
+    ->append(array(__FILE__))
+    // Exclude PHP classes templates/generators, which are not valid PHP files
+    ->exclude('task/generator/skeleton/')
+    ->exclude('plugins/sfDoctrinePlugin/data/generator/')
+    // Exclude generated files (single files)
+    ->notPath('unit/config/fixtures/sfDefineEnvironmentConfigHandler/prefix_result.php')
+    ->notPath('unit/config/fixtures/sfFilterConfigHandler/result.php')
+;
+
+$config = new PhpCsFixer\Config();
+$config->setRules(array(
+    '@PhpCsFixer' => true,
+    '@Symfony' => true,
+    'array_syntax' => array(
+        'syntax' => 'long',
+    ),
+))
+    ->setCacheFile('.php-cs-fixer.cache')
+    ->setFinder($finder)
+;
+
+return $config;

data/bin/changelog.php

@@ -3,7 +3,7 @@
 /*
  * This file is part of the symfony package.
  * (c) Fabien Potencier <fabien.potencier@symfony-project.com>
- * 
+ *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
@@ -13,22 +13,22 @@
  *
  * Usage: php data/bin/changelog.php -r12345:67890 /branches/1.3
  *
- * @package    symfony
  * @author     Fabien Potencier <fabien.potencier@symfony-project.com>
+ *
  * @version    SVN: $Id$
  */
 require_once __DIR__.'/../../lib/task/sfFilesystem.class.php';
 
-if (!isset($argv[1]))
-{
-  echo "You must provide a revision range (-r123:456)\n";
-  exit(1);
+if (!isset($argv[1])) {
+    echo "You must provide a revision range (-r123:456)\n";
+
+    exit(1);
 }
 
-if (!isset($argv[2]))
-{
-  echo "You must provide a repository path (/branches/1.4)\n";
-  exit(1);
+if (!isset($argv[2])) {
+    echo "You must provide a repository path (/branches/1.4)\n";
+
+    exit(1);
 }
 
 $filesystem = new sfFilesystem();
@@ -37,13 +37,12 @@
 $info = new SimpleXMLElement($out);
 
 list($out, $err) = $filesystem->execute(vsprintf('svn log %s --xml %s', array_map('escapeshellarg', array(
-  $argv[1],
-  (string) $info->entry->repository->root.$argv[2],
+    $argv[1],
+    (string) $info->entry->repository->root.$argv[2],
 ))));
 $log = new SimpleXMLElement($out);
 
-foreach ($log->logentry as $logentry)
-{
-  echo sprintf(' * [%d] %s', $logentry['revision'], trim(preg_replace('/\s*\[[\d\., ]+\]\s*/', '', (string) $logentry->msg)));
-  echo PHP_EOL;
+foreach ($log->logentry as $logentry) {
+    echo sprintf(' * [%d] %s', $logentry['revision'], trim(preg_replace('/\s*\[[\d\., ]+\]\s*/', '', (string) $logentry->msg)));
+    echo PHP_EOL;
 }

data/bin/check_configuration.php

@@ -2,25 +2,28 @@
 
 function is_cli()
 {
-  return !isset($_SERVER['HTTP_HOST']);
+    return !isset($_SERVER['HTTP_HOST']);
 }
 
 /**
  * Checks a configuration.
+ *
+ * @param mixed $boolean
+ * @param mixed $message
+ * @param mixed $help
+ * @param mixed $fatal
  */
 function check($boolean, $message, $help = '', $fatal = false)
 {
-  echo $boolean ? "  OK        " : sprintf("[[%s]] ", $fatal ? ' ERROR ' : 'WARNING');
-  echo sprintf("$message%s\n", $boolean ? '' : ': FAILED');
+    echo $boolean ? '  OK        ' : sprintf('[[%s]] ', $fatal ? ' ERROR ' : 'WARNING');
+    echo sprintf("{$message}%s\n", $boolean ? '' : ': FAILED');
 
-  if (!$boolean)
-  {
-    echo "            *** $help ***\n";
-    if ($fatal)
-    {
-      die("You must fix this problem before resuming the check.\n");
+    if (!$boolean) {
+        echo "            *** {$help} ***\n";
+        if ($fatal) {
+            exit("You must fix this problem before resuming the check.\n");
+        }
     }
-  }
 }
 
 /**
@@ -30,17 +33,15 @@ function check($boolean, $message, $help = '', $fatal = false)
  */
 function get_ini_path()
 {
-  if ($path = get_cfg_var('cfg_file_path'))
-  {
-    return $path;
-  }
+    if ($path = get_cfg_var('cfg_file_path')) {
+        return $path;
+    }
 
-  return 'WARNING: not using a php.ini file';
+    return 'WARNING: not using a php.ini file';
 }
 
-if (!is_cli())
-{
-  echo '<html><body><pre>';
+if (!is_cli()) {
+    echo '<html><body><pre>';
 }
 
 echo "********************************\n";
@@ -51,18 +52,16 @@ function get_ini_path()
 
 echo sprintf("php.ini used by PHP: %s\n\n", get_ini_path());
 
-if (is_cli())
-{
-  echo "** WARNING **\n";
-  echo "*  The PHP CLI can use a different php.ini file\n";
-  echo "*  than the one used with your web server.\n";
-  if ('\\' == DIRECTORY_SEPARATOR)
-  {
-    echo "*  (especially on the Windows platform)\n";
-  }
-  echo "*  If this is the case, please launch this\n";
-  echo "*  utility from your web server.\n";
-  echo "** WARNING **\n";
+if (is_cli()) {
+    echo "** WARNING **\n";
+    echo "*  The PHP CLI can use a different php.ini file\n";
+    echo "*  than the one used with your web server.\n";
+    if ('\\' == DIRECTORY_SEPARATOR) {
+        echo "*  (especially on the Windows platform)\n";
+    }
+    echo "*  If this is the case, please launch this\n";
+    echo "*  utility from your web server.\n";
+    echo "** WARNING **\n";
 }
 
 // mandatory
@@ -72,10 +71,9 @@ function get_ini_path()
 // warnings
 echo "\n** Optional checks **\n\n";
 check(class_exists('PDO'), 'PDO is installed', 'Install PDO (mandatory for Doctrine)', false);
-if (class_exists('PDO'))
-{
-  $drivers = PDO::getAvailableDrivers();
-  check(count($drivers), 'PDO has some drivers installed: '.implode(', ', $drivers), 'Install PDO drivers (mandatory for Doctrine)');
+if (class_exists('PDO')) {
+    $drivers = PDO::getAvailableDrivers();
+    check(count($drivers), 'PDO has some drivers installed: '.implode(', ', $drivers), 'Install PDO drivers (mandatory for Doctrine)');
 }
 check(function_exists('token_get_all'), 'The token_get_all() function is available', 'Install and enable the Tokenizer extension (highly recommended)', false);
 check(function_exists('mb_strlen'), 'The mb_strlen() function is available', 'Install and enable the mbstring extension', false);
@@ -85,10 +83,8 @@ function get_ini_path()
 
 $accelerator =
   (function_exists('apc_store') && ini_get('apc.enabled'))
-  ||
-  function_exists('eaccelerator_put') && ini_get('eaccelerator.enable')
-  ||
-  function_exists('xcache_set')
+  || function_exists('eaccelerator_put') && ini_get('eaccelerator.enable')
+  || function_exists('xcache_set')
 ;
 check($accelerator, 'A PHP accelerator is installed', 'Install a PHP accelerator like APC (highly recommended)', false);
 
@@ -99,7 +95,6 @@ function_exists('xcache_set')
 
 check(class_exists('Memcache'), 'Memcache is available', 'You must have memcache installed and enabled to use sfMemcacheCache class.', false);
 
-if (!is_cli())
-{
-  echo '</pre></body></html>';
+if (!is_cli()) {
+    echo '</pre></body></html>';
 }