[QA] Add PHP-CS-Fixer

.github/workflows/coding-standards.yml

@@ -23,3 +23,6 @@ jobs:
 
       - name: "checking coding standards ( codesniffer )"
         run: "composer cs:check"
+
+      - name: "checking coding standards ( php-cs-fixer )"
+        run: "composer cs-fixer:check"

.php_cs.dist

@@ -0,0 +1,52 @@
+<?php
+
+return PhpCsFixer\Config::create()
+    ->setFinder(
+        \Symfony\Component\Finder\Finder::create()
+            ->in([
+                __DIR__ . '/src',
+                __DIR__ . '/tests',
+            ])
+    )
+    ->setRiskyAllowed(true)
+    ->setRules([
+        'align_multiline_comment' => true,
+        'array_indentation' => true,
+        'declare_strict_types' => true,
+        // Currently it is not possible to mark all classes as final (exceptions etc.)
+        // We can run this fixer periodically on the tests folder only.
+        // 'final_class' => true,
+        'global_namespace_import' => [
+            'import_classes' => true,
+            'import_constants' => true,
+            'import_functions' => true,
+        ],
+        'list_syntax' => [
+            'syntax' => 'short',
+        ],
+        'lowercase_constants' => true,
+        'multiline_comment_opening_closing' => true,
+        'native_function_casing' => true,
+        'no_empty_phpdoc' => true,
+        'no_leading_import_slash' => true,
+        'no_superfluous_phpdoc_tags' => [
+            'allow_mixed' => true,
+        ],
+        'no_unused_imports' => true,
+        'no_useless_else' => true,
+        'no_useless_return' => true,
+        'ordered_imports' => [
+            'imports_order' => ['class', 'function', 'const'],
+        ],
+        'ordered_interfaces' => true,
+        'php_unit_test_annotation' => true,
+        'php_unit_test_case_static_method_calls' => [
+            'call_type' => 'static',
+        ],
+        'single_import_per_statement' => true,
+        'single_trait_insert_per_statement' => true,
+        'static_lambda' => true,
+        'strict_comparison' => true,
+        'strict_param' => true,
+    ])
+;

composer.json

@@ -12,16 +12,17 @@
     "require": {
         "php": "^7.4",
         "ext-bcmath": "*",
-        "ext-mbstring": "*",
         "ext-json": "*",
+        "ext-mbstring": "*",
         "ext-sodium": "*"
     },
     "require-dev": {
-        "vimeo/psalm": "dev-master",
         "phpunit/phpunit": "^9.0",
         "php-coveralls/php-coveralls": "^2.2",
+        "friendsofphp/php-cs-fixer": "^2.16",
         "roave/security-advisories": "dev-master",
-        "squizlabs/php_codesniffer": "^3.5"
+        "squizlabs/php_codesniffer": "^3.5",
+        "vimeo/psalm": "dev-master"
     },
     "autoload": {
         "psr-4": {
@@ -39,19 +40,23 @@
     "scripts": {
         "cs:fix": "phpcbf",
         "cs:check": "phpcs",
+        "cs-fixer:fix": "php-cs-fixer fix",
+        "cs-fixer:check": "php-cs-fixer fix --dry-run",
         "type:check": "psalm",
         "type:coverage": "psalm --shepherd",
         "test:unit": "phpunit",
         "code:coverage": "php-coveralls -v",
         "security:analysis": "psalm --taint-analysis",
         "check": [
+            "@cs-fixer:check",
             "@cs:check",
             "@type:check",
             "@security:analysis",
             "@test:unit"
         ]
     },
     "config": {
-        "process-timeout": 1200
+        "process-timeout": 1200,
+        "sort-packages": true
     }
 }

src/Psl/Arr/contains_key.php

@@ -4,6 +4,8 @@
 
 namespace Psl\Arr;
 
+use function array_key_exists;
+
 /**
  * Returns true if the given array contains the key.
  *
@@ -17,5 +19,5 @@
  */
 function contains_key(array $array, $key): bool
 {
-    return \array_key_exists($key, $array);
+    return array_key_exists($key, $array);
 }

src/Psl/Arr/drop.php

@@ -4,7 +4,6 @@
 
 namespace Psl\Arr;
 
-use Generator;
 use Psl;
 
 /**

src/Psl/Arr/first_key.php

@@ -4,6 +4,8 @@
 
 namespace Psl\Arr;
 
+use function array_key_first;
+
 /**
  * Get the first key of an array, if the array is empty, null will be returned.
  *
@@ -17,5 +19,5 @@
  */
 function first_key(array $array)
 {
-    return \array_key_first($array);
+    return array_key_first($array);
 }

src/Psl/Arr/group_by.php

@@ -5,7 +5,6 @@
 namespace Psl\Arr;
 
 use Psl;
-use Psl\Str;
 use Psl\Type;
 
 /**

src/Psl/Arr/keys.php

@@ -4,6 +4,8 @@
 
 namespace Psl\Arr;
 
+use function array_keys;
+
 /**
  * Return all the keys of an array.
  *
@@ -18,5 +20,5 @@
  */
 function keys(array $arr): array
 {
-    return \array_keys($arr);
+    return array_keys($arr);
 }

src/Psl/Arr/sort.php

@@ -19,7 +19,6 @@
  * @psalm-param array<Tk, Tv>                  $array
  * @psalm-param (callable(Tv, Tv): int)|null   $comparator
  *
- * @return array
  *
  * @psalm-return list<Tv>
  */

src/Psl/Arr/sort_by.php

@@ -4,6 +4,9 @@
 
 namespace Psl\Arr;
 
+use function asort;
+use function uasort;
+
 /**
  * Returns a new array sorted by some scalar property of each value of the given
  * iterable, which is computed by the given function.
@@ -33,9 +36,9 @@ function sort_by(iterable $iterable, callable $scalar_func, ?callable $comparato
     }
 
     if (null !== $comparator) {
-        \uasort($order_by, $comparator);
+        uasort($order_by, $comparator);
     } else {
-        \asort($order_by);
+        asort($order_by);
     }
 
     $result = [];

src/Psl/Arr/sort_by_key.php

@@ -4,6 +4,9 @@
 
 namespace Psl\Arr;
 
+use function ksort;
+use function uksort;
+
 /**
  * Returns a new array sorted by the keys of the given array. If the
  * optional comparator function isn't provided, the keys will be sorted in
@@ -20,9 +23,9 @@
 function sort_by_key(array $array, ?callable $comparator = null): array
 {
     if ($comparator) {
-        \uksort($array, $comparator);
+        uksort($array, $comparator);
     } else {
-        \ksort($array);
+        ksort($array);
     }
 
     return $array;

src/Psl/Arr/sort_with_keys.php

@@ -4,6 +4,9 @@
 
 namespace Psl\Arr;
 
+use function asort;
+use function uasort;
+
 /**
  * Returns a new array sorted by the values of the given array. If the
  * optional comparator function isn't provided, the values will be sorted in
@@ -20,9 +23,9 @@
 function sort_with_keys(array $array, ?callable $comparator = null): array
 {
     if (null !== $comparator) {
-        \uasort($array, $comparator);
+        uasort($array, $comparator);
     } else {
-        \asort($array);
+        asort($array);
     }
 
     return $array;

src/Psl/Arr/sort_with_keys_by.php

@@ -35,7 +35,7 @@ function sort_with_keys_by(iterable $iterable, callable $scalar_func, ?callable
          * @psalm-param array{0: Ts, 1: Tv} $a
          * @psalm-param array{0: Ts, 1: Tv} $b
          */
-        fn ($a, $b): int => $comparator($a[0], $b[0]);
+        static fn ($a, $b): int => $comparator($a[0], $b[0]);
 
     /**
      * @psalm-var array<Tk, array{0: Ts, 1: Tv}> $tuples

src/Psl/Arr/unique_by.php

@@ -4,8 +4,6 @@
 
 namespace Psl\Arr;
 
-use Psl;
-
 /**
  * Returns a new array in which each value appears exactly once, where the
  * value's uniqueness is determined by transforming it to a scalar via the

src/Psl/Collection/MutableVectorInterface.php

@@ -10,7 +10,7 @@
  * @extends  VectorInterface<T>
  * @extends  MutableAccessibleCollectionInterface<int, T>
  */
-interface MutableVectorInterface extends VectorInterface, MutableAccessibleCollectionInterface
+interface MutableVectorInterface extends MutableAccessibleCollectionInterface, VectorInterface
 {
     /**
      * Get an array copy of the current vector.

src/Psl/DataStructure/PriorityQueueInterface.php

@@ -4,9 +4,6 @@
 
 namespace Psl\DataStructure;
 
-use Psl;
-use Countable;
-
 /**
  * @template T
  *

src/Psl/DataStructure/QueueInterface.php

@@ -4,8 +4,8 @@
 
 namespace Psl\DataStructure;
 
-use Psl;
 use Countable;
+use Psl;
 
 /**
  * An interface representing a queue data structure ( FIFO ).

src/Psl/DataStructure/StackInterface.php

@@ -4,8 +4,8 @@
 
 namespace Psl\DataStructure;
 
-use Psl;
 use Countable;
+use Psl;
 
 /**
  * An interface representing a stack data structure ( LIFO ).

src/Psl/Env/get_vars.php

@@ -4,8 +4,6 @@
 
 namespace Psl\Env;
 
-use Psl;
-
 use function getenv;
 
 /**

src/Psl/Env/set_current_dir.php

@@ -11,7 +11,6 @@
 /**
  * Changes the current working directory to the specified path.
  *
- * @param string $directory
  *
  * @throws Psl\Exception\InvariantViolationException If the operation fails.
  */

src/Psl/Env/temp_dir.php

@@ -4,8 +4,6 @@
 
 namespace Psl\Env;
 
-use Psl;
-
 use function sys_get_temp_dir;
 
 /**

src/Psl/Exception/ExceptionInterface.php

@@ -4,9 +4,11 @@
 
 namespace Psl\Exception;
 
+use Throwable;
+
 /**
  * @internal
  */
-interface ExceptionInterface extends \Throwable
+interface ExceptionInterface extends Throwable
 {
 }

src/Psl/Internal/internal_encoding.php

@@ -5,12 +5,10 @@
 namespace Psl\Internal;
 
 use Psl;
-use Psl\Type;
 use Psl\Exception;
+use Psl\Type;
 
-use function in_array;
 use function mb_internal_encoding;
-use function mb_list_encodings;
 
 /**
  * @psalm-pure

src/Psl/Internal/is_encoding_valid.php

@@ -4,12 +4,7 @@
 
 namespace Psl\Internal;
 
-use Psl;
-use Psl\Type;
-use Psl\Exception;
-
 use function in_array;
-use function mb_internal_encoding;
 use function mb_list_encodings;
 
 /**

src/Psl/Internal/type.php

@@ -11,8 +11,6 @@
 /**
  * @param mixed $value
  *
- * @return string
- *
  * @psalm-pure
  *
  * @codeCoverageIgnore

src/Psl/Iter/Iterator.php

@@ -16,7 +16,7 @@
  *
  * @implements SeekableIterator<Tk, Tv>
  */
-final class Iterator implements SeekableIterator, Countable
+final class Iterator implements Countable, SeekableIterator
 {
     /**
      * @psalm-var Generator<Tk, Tv, mixed, mixed>

src/Psl/Iter/contains_key.php

@@ -4,8 +4,6 @@
 
 namespace Psl\Iter;
 
-use Psl\Arr;
-
 /**
  * Returns true if the given iterable contains the key.
  *