Feature Request

Summary

Add support for generic type hint syntax: array<int,string> etc

2.0.0-alpha.3 standard does not recognize and improperly reformats intersect types(&) in phpdoc:

     /**
      * Inject a service into the container mock.
      *
      * Adjust `has('service')` and `get('service')` returns.
      *
-     * @param ContainerInterface&ObjectProphecy $container
+     * @param ContainerInterface &ObjectProphecy $container
      * @param mixed              $service
      */
     protected function injectServiceInContainer(ObjectProphecy $container, string $serviceName, $service) : void
     {
         $container->has($serviceName)->willReturn(true);
         $container->get($serviceName)->willReturn($service);
     }

Intersections types are supported by PhpStorm, phpstan and present in the draft for phpdoc PSR
https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc.md#details

Originally posted by @Xerkus at zendframework/zend-coding-standard#16

\Exception and \Throwable are not equal and must not be swapped.
\Throwable includes php errors, some of which are not really recoverable.

On top of that it actually breaks code in some instances:

         $exception = $this->prophesize(NotFoundExceptionInterface::class)
-            ->willExtend(Exception::class)
+            ->willExtend(Throwable::class)
             ->reveal();

Originally posted by @Xerkus at zendframework/zend-coding-standard#17

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

• Update dependency slevomat/coding-standard to v8

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Lock file maintenance

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Bug Report

Summary

Coding standard does not recognize docblock as belonging to a closure when closure is immediately returned.
Bug is likely in PSR12.Files.FileHeader.IncorrectOrder

Current behavior

While applying Laminas CS to newly installed mezzio skeleton application I discovered that pipeline.php and routes.php trigger
errors PSR12.Files.FileHeader.IncorrectOrder: Header blocks must be separated by a single blank line and PSR12.Files.FileHeader.IncorrectOrder: The file-level docblock must follow the opening PHP tag in the file header

How to reproduce

Run CS check against mezzio skeleton config file https://github.com/mezzio/mezzio-skeleton/blob/c268aac1a272ee20b9bceaa5715aac4174d388ae/src/MezzioInstaller/Resources/config/routes-fastroute-minimal.php#L9-L26

<?php

declare(strict_types=1);

use Mezzio\Application;
use Mezzio\MiddlewareFactory;
use Psr\Container\ContainerInterface;

/**
 * FastRoute route configuration
 *
 * @see https://github.com/nikic/FastRoute
 *
 * Setup routes with a single request method:
 *
 * $app->get('/', App\Handler\HomePageHandler::class, 'home');
 * $app->post('/album', App\Handler\AlbumCreateHandler::class, 'album.create');
 * $app->put('/album/{id:\d+}', App\Handler\AlbumUpdateHandler::class, 'album.put');
 * $app->patch('/album/{id:\d+}', App\Handler\AlbumUpdateHandler::class, 'album.patch');
 * $app->delete('/album/{id:\d+}', App\Handler\AlbumDeleteHandler::class, 'album.delete');
 *
 * Or with multiple request methods:
 *
 * $app->route('/contact', App\Handler\ContactHandler::class, ['GET', 'POST', ...], 'contact');
 */
return static function (Application $app, MiddlewareFactory $factory, ContainerInterface $container): void {
};

Expected behavior

This docblock should be accepted as closure level rather than file level

Adds license header sniff and MD files sniff

• check all files for license header
• check contents of MD files if match with templates from maintainers repository
• sniff to check if COPYTIGHT.md and LICENSE.md files exists in the repo, and create them (it's a bit hacky, because sniffs works only on existing files, so we run this sniff only ONCE on first found token)

Replaces #2
Please have a look on commits dc3d49b and e7528fe

/cc @xtreamwayz @weierophinney

Originally posted by @michalbundyra at zendframework/zend-coding-standard#4

v2.0.0rc1

phpcbf breaks equality comparasions.

Reproducing.

Source code:

<?php

var_dump(1 == '1');

Test:

$php test.php 
bool(true)

Code cleaning:

./vendor/bin/phpcbf test.php
PHPCBF RESULT SUMMARY
----------------------------------------------------------------------
FILE                                                  FIXED  REMAINING
----------------------------------------------------------------------
/home/dvp/eclipse-workspace/autowp/test.php           1      1
----------------------------------------------------------------------
A TOTAL OF 1 ERROR WERE FIXED IN 1 FILE
----------------------------------------------------------------------

Clean source code:

<?php

var_dump(1 === '1');

Test again

$php test.php 
bool(false)

Expected: bool(true)

Currently documentation mentions phpDoc tags @param and @return as being optional and in some cases undesirable. However it is done briefly and in a way that is easy to gloss over unless you already know what you are looking for.

https://github.com/laminas/laminas-coding-standard/blob/3c4bc41512e8e8577765c18ab66e6b9a3467ed20/docs/book/v2/coding-style-guide.md#9-commenting-and-docblocks

Code SHOULD be written so it explains itself. DocBlocks and comments SHOULD only be used if necessary. They MUST NOT start with # and MUST NOT be empty. They SHOULD NOT be used for already typehinted arguments, except arrays.

I believe it is fairly significant rule and should be elevated to its own block that also includes code example.

Modify composer.json to drop support for PHP less than 7.3

Feature Request

Summary

As decided during the Technical-Steering-Committee Meeting on August 3rd, 2020, Laminas wants to implement vimeo/psalm in all packages.

Implementing psalm is quite easy.

Required

• Create a .psalm.xml.dist in the project root
• Copy and paste the contents from this psalm.xml.dist
• Run $ composer require vimeo/psalm
• Run $ vendor/bin/psalm --set-baseline=psalm-baseline.xml
• Add a composer script static-analysis with the command psalm --shepherd --stats
• Add a new line to script: in .travis.yml: - if [[ $TEST_COVERAGE == 'true' ]]; then composer static-analysis ; fi
• Remove phpstan from the project (phpstan.neon.dist, .travis.yml entry, composer.json require-dev and scripts)

Optional

• Fix as many psalm errors as possible.

Previously I let phpcb insert the declare statement instead of writing it myself.
But since the latest update (2.0.0.alpha4), phpcb does not insert the declare statement anymore.
phpcs still reports the missing declare statement with an error (Missing required strict_types declaration).

Originally posted by @PatrickG at zendframework/zend-coding-standard#23

• I was not able to find an open or closed issue matching what I'm seeing.
• This is not a question. (Questions should be asked on chat (Signup here) or our forums.)

It seems there are two conflicting indent rules.

Code to reproduce the issue

Variant 1

    $routes->connect('/test/:test', 'Test::test', [
        '_name'   => 'test',
        '_method' => ['GET', 'POST'],
    ])
        ->setPass(['test']);

Shows an error for line 2-4: Invalid indent. Expected 12 spaces, found 8.
phpcbf corrects this to variant 2.

Variant 2

    $routes->connect('/test/:test', 'Test::test', [
            '_name'   => 'test',
            '_method' => ['GET', 'POST'],
        ])
        ->setPass(['test']);

Shows an error for line 2-4: Array key not indented correctly; expected 8 spaces but found 12.
phpcbf corrects this to variant 1.

Variants that show no errors

    $routes->connect(
            '/test/:test',
            'Test::test',
            [
                '_name'   => 'test',
                '_method' => ['GET', 'POST'],
            ]
        )
        ->setPass(['test']);

    $routes
        ->connect(
            '/test/:test',
            'Test::test',
            [
                '_name'   => 'test',
                '_method' => ['GET', 'POST'],
            ]
        )
        ->setPass(['test']);

    $routes
        ->connect('/test/:test', 'Test::test', [
            '_name'   => 'test',
            '_method' => ['GET', 'POST'],
        ])
        ->setPass(['test']);

Expected results

One of the variants should show no error, or phpcbf should correct both variants to a variant that shows no error.

Actual results

Both variants show an error, and phpcbf corrects them in a loop.

Originally posted by @PatrickG at zendframework/zend-coding-standard#20

Bug Report

Summary

phpcbf breaks interface matching.
All Laminas\ServiceManager\Factory\FactoryInterface implementations is broken after autofix because of $requestedName parameter typed with phpdoc

Current behavior

<?php

namespace Test;

class Test implements ITest
{
    /**
     * @param string $string
     */
    public function doIt($string): void
    {
        print $string;
    }
}

converted to

<?php

namespace Test;

class Test implements ITest
{
    public function doIt(string $string): void
    {
        print $string;
    }
}

regadless of interface method definition: Declaration must be compatible with ITest->doIt(string: string)

Expected behavior

Don't convert phpdoc type hints automatically

Workaround

Exclude SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint

Originally posted by @ma-si at zendframework/zend-coding-standard#6

Needs webimpress/coding-standard#29

Originally posted by @geerteltink at zendframework/zend-coding-standard#19

Bug Report

Summary

Parameters in PhpDoc comments are aligned which can cause huge empty space:

mezzio/mezzio@7861866#diff-c9248b3167fc44af085b81db2e292837L160-R152

The sniff responsible should be changed so it removes the excessive white space.

Bug Report

Summary

Rules WebimpressCodingStandard.Files.DeclareStrictTypes.BelowComment and PSR12.Files.FileHeader.IncorrectOrder contradict themselves, if the file header comment does not include both a @copyright and @license tag.

In this report the development.config.php.dist of the Mezzio Skeleton will serve as example.

Current behavior

Running phpcbf on the example file, will fix the violation of WebimpressCodingStandard.Files.DeclareStrictTypes.BelowComment and open the violation of PSR12.Files.FileHeader.IncorrectOrder at the same time.

How to reproduce

Detailed instructions are provided in arueckauer/strict-type-declaration-cs-issue. In summary run the following commands on development.config.php.dist.

1. phpcs: Fixable violation of WebimpressCodingStandard.Files.DeclareStrictTypes.BelowComment (the other violation is irrelevant for this issue).
2. phpcbf: Fixed: 2; Remaining: 1.
3. phpcs: Violation of PSR12.Files.FileHeader.IncorrectOrder

Expected behavior

Here I am not sure. Probably the file header comment should be always above the strict type declaration. But it is not clear to me...

With copyright docblock using older @link tag format, strict types declaration is placed before it.

 <?php
+
+declare(strict_types=1);
+
 /**
  * @link      http://github.com/zendframework/zend-mvc for the canonical source repository
  * @copyright Copyright (c) 2005-2018 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License
  */

But with @see it is placed after the docblock as it should be:

 <?php
+
 /**
- * @link      http://github.com/zendframework/zend-mvc for the canonical source repository
+ * @see      http://github.com/zendframework/zend-mvc for the canonical source repository
  * @copyright Copyright (c) 2005-2018 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License
  */
 
+declare(strict_types=1);
+

On a side note, should that extra empty line be added before copyright? Looks like unintended side effect of strict types sniff

Originally posted by @Xerkus at zendframework/zend-coding-standard#15

Bug Report

Summary

phpcbf loops until attempts limit (50) with rules Generic.Arrays.ArrayIndent & Generic.WhiteSpace.ScopeIndent then failed to fix.
On big sources failed on time limit (10min)

Current behavior

$./vendor/bin/phpcbf test.php
----------------------------------------------------------------------
FILE                                                  FIXED  REMAINING
----------------------------------------------------------------------
test.php                                              FAILED TO FIX
----------------------------------------------------------------------
A TOTAL OF 1 ERROR WERE FIXED IN 1 FILE
----------------------------------------------------------------------
PHPCBF FAILED TO FIX 1 FILE
----------------------------------------------------------------------

How to reproduce

Minimal source to reproduce:

<?php

function test()
{
    query('
        INSERT INTO table (column)
        VALUES (:value)
    ', [
        'value' => $value,
    ]);
}

Expected behavior

No error (all other rules applied)

Verbose output fragment

$./vendor/bin/phpcbf test.php -vvvv

---START FILE CONTENT---
 1|<?php
 2|
 3|function test()
 4|{
 5|    query('
 6|        INSERT INTO table (column)
 7|        VALUES (:value)
 8|    ', [
 9|    'value' => $value,
10|    ]);
11|}
12|
--- END FILE CONTENT ---
	**** Generic.Arrays.ArrayIndent:137 has possible conflict with another sniff on loop 45; caused by the following change ****
	**** replaced token 29 (T_WHITESPACE on line 10) "····]" => "]" ****
	**** ignoring all changes until next loop ****
        => Fixing file: 0/2 violations remaining [made 47 passes]...    * fixed 0 violations, starting loop 48 *
---START FILE CONTENT---
 1|<?php
 2|
 3|function test()
 4|{
 5|    query('
 6|        INSERT INTO table (column)
 7|        VALUES (:value)
 8|    ', [
 9|    'value' => $value,
10|    ]);
11|}
12|
--- END FILE CONTENT ---
	Generic.Arrays.ArrayIndent:137 replaced token 29 (T_WHITESPACE on line 10) "····]" => "]"
        => Fixing file: 1/2 violations remaining [made 48 passes]...    * fixed 1 violations, starting loop 49 *
---START FILE CONTENT---
 1|<?php
 2|
 3|function test()
 4|{
 5|    query('
 6|        INSERT INTO table (column)
 7|        VALUES (:value)
 8|    ', [
 9|    'value' => $value,
10|]);
11|}
12|
--- END FILE CONTENT ---
	**** Generic.WhiteSpace.ScopeIndent:1476 has possible conflict with another sniff on loop 47; caused by the following change ****
	**** replaced token 29 (T_CLOSE_SHORT_ARRAY on line 10) "]" => "····]" ****
	**** ignoring all changes until next loop ****
        => Fixing file: 0/2 violations remaining [made 49 passes]...    * fixed 0 violations, starting loop 50 *
---START FILE CONTENT---
 1|<?php
 2|
 3|function test()
 4|{
 5|    query('
 6|        INSERT INTO table (column)
 7|        VALUES (:value)
 8|    ', [
 9|    'value' => $value,
10|]);
11|}
12|
--- END FILE CONTENT ---
	Generic.WhiteSpace.ScopeIndent:1476 replaced token 29 (T_CLOSE_SHORT_ARRAY on line 10) "]" => "····]"
        => Fixing file: 1/2 violations remaining [made 50 passes]...    * fixed 1 violations, starting loop 51 *
	*** Reached maximum number of loops with 1 violations left unfixed ***
ERROR in 217ms

PHPCBF RESULT SUMMARY
----------------------------------------------------------------------
FILE                                                  FIXED  REMAINING
----------------------------------------------------------------------
test.php                                              FAILED TO FIX
----------------------------------------------------------------------
A TOTAL OF 1 ERROR WERE FIXED IN 1 FILE
----------------------------------------------------------------------
PHPCBF FAILED TO FIX 1 FILE
----------------------------------------------------------------------

Time: 292ms; Memory: 10MB

Squiz.Strings.DoubleQuoteUsage.ContainsVar prevents strings containing variables. This doesn't match the examples in the documentation and, given that PHP7s interpolation uses less memory than concatenation, probably isn't intended.

This PR adds an exclude for that check and tries to make the docs a little more exact.

Originally posted by @kynx at zendframework/zend-coding-standard#18

This references slevomat/coding-standard#1149

RFC

Goal

Allow omitting docblock when provided from either parent objects or interfaces.

Background

I am implementing the coding standard in laminas-cache and I have the setup shown in the reference issue within slevomat coding standard.
As we have the same setup when implementing interfaces (and repeating docblock is bad practice imho), I'd like to replace the SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingAnyTypeHint with either a self-written sniff or an appropriate sniff which resolves interfaces and parent objects aswells.

This shoud not allow some kind of docblock merging. So code like this should be still considered invalid as the parameter $foo has no typehint:

<?php

interface Foo
{
    /**
     * @param string $foo
     * @param array $baz
     */
    public function bar($foo, array $bar): void;
}

class Baz implements Foo
{
    /**
     * @param array<string,mixed> $baz
     */
    public function bar($foo, array $bar): void
    {}
}

Considerations

There are no implications to the codebase as for now, the codestandard requires repetition of the docblock. In the future, this can be omitted.

Proposal(s)

• Removal of SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingAnyTypeHint
• Creation of an appropriate sniff or taking another sniff

Appendix

None, yet.

Feature Request

Summary

To be prepared for the december release of PHP 8.0, this repository has some additional TODOs to be tested against the new major version.

In order to make this repository compatible, one has to follow these steps:

• Modify composer.json to provide support for PHP 8.0 by adding the constraint ~8.0.0
• Modify composer.json to drop support for PHP less than 7.3
• Modify composer.json to implement phpunit 9.3 which supports PHP 7.3+
• Modify .travis.yml to ignore platform requirements when installing composer dependencies (simply add --ignore-platform-reqs to COMPOSER_ARGS env variable)
• Modify .travis.yml to add PHP 8.0 to the matrix (NOTE: Do not allow failures as PHP 8.0 has a feature freeze since 2020-08-04!)
• Modify source code in case there are incompatibilities with PHP 8.0

Feature Request

You can see the diff with PSR-12 here https://github.com/php-fig/per-coding-style/compare/8201676d799ca5d03bec8ee702df1dd3fda8d2b0..2.0.0

root@5c7fdcaf9404:/var/www# composer cs-check

phpcs
ERROR: Referenced sniff "./vendor/laminas/laminas-coding-standard/ruleset.xml" does not exist

Run "phpcs --help" for usage information

Script phpcs handling the cs-check event returned with error code 3

zend-coding-standard current version require squizlabs/php_codesniffer ^2.7 but now php_codesniffer stable version is 3.1.1, please update your lib dependencies

Originally posted by @marashlyansuren at zendframework/zend-coding-standard#3

This file causes maximum number of loops reached error with 2.0.0-alpha.3:
https://github.com/zendframework/zend-mvc/blob/d83d57e2e64e240e94efcc43d5b1483919cb65a0/src/View/Http/InjectTemplateListener.php

Related dependencies:

dealerdirect/phpcodesniffer-composer-installer v0.5.0
slevomat/coding-standard                       4.8.7
squizlabs/php_codesniffer                      3.4.0
webimpress/coding-standard                     dev-master dffb652
zendframework/zend-coding-standard             2.0.0-alpha.3

Offending part by the looks of it:
https://github.com/zendframework/zend-mvc/blob/d83d57e2e64e240e94efcc43d5b1483919cb65a0/src/View/Http/InjectTemplateListener.php#L108-L115

            if (// Allow disabling rule by setting value to false since config
                // merging have no feature to remove entries
                false == $replacement
                // Match full class or full namespace
                || ! ($controller === $namespace || strpos($controller, $namespace . '\\') === 0)
            ) {
                continue;
            }

 => Fixing file: 0/38 violations remaining [made 45 passes]...   * fixed 0 violations, starting loop 46 *
WebimpressCodingStandard\Sniffs\Commenting\PlacementSniff (line 41) replaced token 838 (T_COMMENT) "//·Allow·disabling·rule·by·setting·value·to·false·since·config\n" => "·//·Allow·disabling·rule·by·setting·value·to·false·since·config\n"
=> Fixing file: 1/38 violations remaining [made 46 passes]...   * fixed 1 violations, starting loop 47 *
**** PHP_CodeSniffer\Standards\PSR2\Sniffs\ControlStructures\ControlStructureSpacingSniff (line 105) has possible conflict with another sniff on loop 45; caused by the following change ****
**** replaced token 838 (T_WHITESPACE) "·//·Allow·disabling·rule·by·setting·value·to·false·since·config\n" => "//·Allow·disabling·rule·by·setting·value·to·false·since·config\n" ****
**** ignoring all changes until next loop ****
=> Fixing file: 0/38 violations remaining [made 47 passes]...   * fixed 0 violations, starting loop 48 *
PHP_CodeSniffer\Standards\PSR2\Sniffs\ControlStructures\ControlStructureSpacingSniff (line 105) replaced token 838 (T_WHITESPACE) "·//·Allow·disabling·rule·by·setting·value·to·false·since·config\n" => "//·Allow·disabling·rule·by·setting·value·to·false·since·config\n"
=> Fixing file: 1/38 violations remaining [made 48 passes]...   * fixed 1 violations, starting loop 49 *
**** WebimpressCodingStandard\Sniffs\Commenting\PlacementSniff (line 41) has possible conflict with another sniff on loop 47; caused by the following change ****
**** replaced token 838 (T_COMMENT) "//·Allow·disabling·rule·by·setting·value·to·false·since·config\n" => "·//·Allow·disabling·rule·by·setting·value·to·false·since·config\n" ****
**** ignoring all changes until next loop ****

Originally posted by @Xerkus at zendframework/zend-coding-standard#14

Bug Report

• wrong installation command
• wrong site description
• the page "Coding Style Guide" is too long
• wrong indentation in lists for code examples
• wrong formatting in blockquotes
• wrong or no syntax for links
• unneeded PHP tags
• unneeded numbering in headlines
• invalid the very first code example in v2 docs
• …