Merge pull request #473 from kbsali/housekeeping

Housekeeping for v2.10.0-dev

Author: Art4

.php-cs-fixer.dist.php

@@ -1,21 +1,41 @@
 <?php
 
-$finder = PhpCsFixer\Finder::create()
+declare(strict_types=1);
+
+$finder = \PhpCsFixer\Finder::create()
     ->in(__DIR__)
     ->exclude([
         'vendor',
     ])
 ;
 
-$config = new PhpCsFixer\Config();
-return $config->setRules([
-        '@PER-CS2.0' => true,
-        '@PER-CS2.0:risky' => true,
+return (new \PhpCsFixer\Config())
+    ->setRules([
+        '@PER-CS3x0' => true,
+        '@PER-CS3x0:risky' => true,
         '@PHPUnit100Migration:risky' => true,
-        'array_syntax' => ['syntax' => 'short'],
         'linebreak_after_opening_tag' => true,
         'ordered_imports' => true,
+        'no_empty_phpdoc' => true,
+        'no_unused_imports' => true,
+        'no_useless_return' => true,
+        'return_assignment' => true,
+        'simplified_null_return' => true,
+        'no_superfluous_phpdoc_tags' => ['allow_mixed' => true],
+        'phpdoc_add_missing_param_annotation' => true,
+        'phpdoc_indent' => true,
+        'phpdoc_no_access' => true,
+        'phpdoc_no_empty_return' => true,
+        'phpdoc_order_by_value' => true,
         'phpdoc_order' => true,
+        'phpdoc_param_order' => true,
+        'phpdoc_separation' => ['skip_unlisted_annotations' => false],
+        'phpdoc_trim_consecutive_blank_line_separation' => true,
+        'phpdoc_trim' => true,
+        'phpdoc_types' => true,
+        'phpdoc_types_no_duplicates' => true,
+        'phpdoc_var_annotation_correct_order' => true,
+        'phpdoc_var_without_name' => true,
         'trailing_comma_in_multiline' => ['after_heredoc' => true, 'elements' => ['arguments', 'arrays']], // Remove this rule after dropping support for PHP 7.4
     ])
     ->setFinder($finder)

.phpstan.neon

@@ -6,17 +6,3 @@ parameters:
         - tests/
 
     treatPhpDocTypesAsCertain: false
-
-    ignoreErrors:
-        -
-            # Ignore missing or imprecise parameter types for methods in tests
-            message: '(^Method .+ has parameter .+ with no.* type specified.*\.$)'
-            path: tests
-        -
-            # Ignore imprecise return types for methods in tests
-            message: '(^Method .+ return type has no.* type specified.+\.$)'
-            path: tests
-        -
-            # Ignore missing return types for methods in tests
-            message: '(^Method .+ has no return type specified\.$)'
-            path: tests

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "kbsali/redmine-api",
-    "version": "v2.9.1",
+    "version": "v2.10.0-dev",
     "type": "library",
     "description": "Redmine API client",
     "homepage": "https://github.com/kbsali/php-redmine-api",

src/Redmine/Api/AbstractApi.php

@@ -235,10 +235,10 @@ protected function delete($path)
     protected function isNotNull($var)
     {
         return
-            false !== $var &&
-            null !== $var &&
-            '' !== $var &&
-            !((is_array($var) || is_object($var)) && empty($var));
+            false !== $var
+            && null !== $var
+            && '' !== $var
+            && !((is_array($var) || is_object($var)) && empty($var));
     }
 
     /**

src/Redmine/Api/CustomField.php

@@ -107,7 +107,6 @@ final public function listNames(): array
      *
      * @deprecated v2.4.0 Use list() instead.
      * @see CustomField::list()
-     *
      * @see http://www.redmine.org/projects/redmine/wiki/Rest_CustomFields#GET
      *
      * @param array<mixed> $params optional parameters to be passed to the api (offset, limit, ...)

src/Redmine/Api/Group.php

@@ -109,7 +109,6 @@ final public function listNames(): array
      *
      * @deprecated v2.4.0 Use list() instead.
      * @see Group::list()
-     *
      * @see http://www.redmine.org/projects/redmine/wiki/Rest_Groups#GET
      *
      * @param array<mixed> $params optional parameters to be passed to the api (offset, limit, ...)
@@ -238,7 +237,7 @@ public function update(int $id, array $params = [])
      * available $params :
      * - include: a coma separated list of associations to include in the response: users,memberships
      *
-     * @param int          $id     the group id
+     * @param string|int $id the group id
      * @param array<mixed> $params params to pass to url
      *
      * @return array<mixed>|false|string information about the group as array or false|string on error

src/Redmine/Api/Issue.php

@@ -140,7 +140,6 @@ final public function list(array $params = []): array
      *
      * @deprecated v2.4.0 Use list() instead.
      * @see Issue::list()
-     *
      * @see http://www.redmine.org/projects/redmine/wiki/Rest_Issues
      * available $params :
      * - offset: skip this number of issues in response (optional)

src/Redmine/Api/IssueCategory.php

@@ -30,8 +30,8 @@ final public static function fromHttpClient(HttpClient $httpClient): self
     }
 
     /**
-    * @var null|array<mixed>
-    */
+     * @var null|array<mixed>
+     */
     private ?array $issueCategories = null;
 
     /**
@@ -134,7 +134,6 @@ final public function listNamesByProject($projectIdentifier): array
      *
      * @deprecated v2.4.0 Use listByProject() instead.
      * @see IssueCategory::listByProject()
-     *
      * @see http://www.redmine.org/projects/redmine/wiki/Rest_IssueCategories#GET
      *
      * @param string|int   $project project id or literal identifier

src/Redmine/Api/IssuePriority.php

@@ -73,7 +73,6 @@ final public function list(array $params = []): array
      *
      * @deprecated v2.4.0 Use list() instead.
      * @see IssuePriority::list()
-     *
      * @see http://www.redmine.org/projects/redmine/wiki/Rest_Enumerations#enumerationsissue_prioritiesformat
      *
      * @param array<mixed> $params optional parameters to be passed to the api (offset, limit, ...)

src/Redmine/Api/IssueRelation.php

@@ -77,7 +77,6 @@ final public function listByIssueId(int $issueId, array $params = []): array
      *
      * @deprecated v2.4.0 Use listByIssueId() instead.
      * @see IssueRelation::listByIssueId()
-     *
      * @see http://www.redmine.org/projects/redmine/wiki/Rest_IssueRelations#GET
      *
      * @param int          $issueId the issue id