php-fig-rectified / psr2r-sniffer Goto Github PK

View Code? Open in Web Editor NEW

32.0 6.0 8.0 662 KB

A PSR-2-R code sniffer and code-style auto-correction-tool - including many useful additions

License: MIT License

PHP 99.16% Shell 0.74% Batchfile 0.10%

code-style sniffer php fixer tokenizer

psr2r-sniffer's Issues

NoInlineFullyQualifiedClassName vs UnusedUseStatementSniff.php

Lets say that I have the following

<?php
class ClassA {

    public function __construct(PimpleContainer $container){
         /** \MyNamespace\ClassB $classB */
         $classB = $container['class_b'];
    }
}

If I understood correctly the above is not allowed by the NoInlineFullyQualifiedClassName

But also the below is not allowed by the UnusedUseStatement

<?php
use \MyNamespace\ClassB;

class ClassA {

    public function __construct(PimpleContainer $container){
         /** ClassB $classB */
         $classB = $container['class_b'];
    }
}

Question - documenting internals

@dereuromark - I'm considering documenting how this psr2r-sniffer works (internals documentation) in support of bringing people into one aspect of php internals (lexing/tokenizing; examining how PHP source is structured) - https://gist.github.com/ewbarnard/97ba2259f0e05e4331bbaa3394da4084

develop vs master - it looks like I'm better off focusing on master rather than develop?
docs/ vs wiki - I'd prefer to add to the source tree rather than the github wiki area. Correct?

Of course getting people to think about the POINT of this project is a plus. That's why I'd like to use this as a route to understanding how the Code Sniffer works, and how the sniffs consume tokens.

Support for phpstan generics?

I was wondering if there is any chance that support would be added for PHPStan generics (https://phpstan.org/blog/generics-by-examples). They are very useful for getting precise type validation from static analysis, but the PSR-2-R sniffs aren't happy with them.

The following is an example of a doc block for a function that takes a class string and constructor arguments, and outputs an instance of the class.

/**
 * @template T of object
 * @param class-string<T> $name The name of the class to construct
 * @param mixed ...$args The arguments to pass to the constructor
 * @return T
 */

And here are the resulting PSR-2-R violations.

>> 35:  »   ·*·@template·T·of·object
   36:  »   ·*·@param·class-string<T>·$name·The·name·of·the·class·to·construct
   37:  »   ·*·@param·mixed·...$args·The·arguments·to·pass·to·the·constructor
----------------------------------------------------------------------------------------------------------------------------------------
LINE 36: ERROR   [ ] Invalid typehint `class-string<T>` (PSR2R.Commenting.FullyQualifiedClassNameInDocBlock.ClassNameInvalid)
LINE 36: ERROR   [x] Possible doc block error: `class-string<T> $name The name of the class to construct` seems to be missing type
                     `string`. (Spryker.Commenting.DocBlockParamAllowDefaultValue.Typehint)
LINE 36: ERROR   [ ] Invalid typehint `class-string<T>` (PSR2R.Commenting.FullyQualifiedClassNameInDocBlock.ClassNameInvalid)
LINE 36: ERROR   [ ] Invalid typehint `class-string<T>` (PSR2R.Commenting.FullyQualifiedClassNameInDocBlock.ClassNameInvalid)
----------------------------------------------------------------------------------------------------------------------------------------
   34:  »   ·*
   35:  »   ·*·@template·T·of·object
>> 36:  »   ·*·@param·class-string<T>·$name·The·name·of·the·class·to·construct
   37:  »   ·*·@param·mixed·...$args·The·arguments·to·pass·to·the·constructor
   38:  »   ·*·@return·T
----------------------------------------------------------------------------------------------------------------------------------------
LINE 38: ERROR   [ ] Invalid typehint `T` (PSR2R.Commenting.FullyQualifiedClassNameInDocBlock.ClassNameInvalid)
LINE 38: ERROR   [ ] Invalid typehint `T` (PSR2R.Commenting.FullyQualifiedClassNameInDocBlock.ClassNameInvalid)
LINE 38: ERROR   [ ] Invalid typehint `T` (PSR2R.Commenting.FullyQualifiedClassNameInDocBlock.ClassNameInvalid)
----------------------------------------------------------------------------------------------------------------------------------------
   36:  »   ·*·@param·class-string<T>·$name·The·name·of·the·class·to·construct
   37:  »   ·*·@param·mixed·...$args·The·arguments·to·pass·to·the·constructor
>> 38:  »   ·*·@return·T
   39:  »   ·*/

I can certainly just skip these sniffs, but I thought I'd reach out in case there was any interest in supporting this feature. Thanks!

whitespace issues

The following passes but should not:

AppPath::get( 'View/Cell' );
//expected
AppPath::get('View/Cell');

$folderContent = ( new Folder( $folder ) )->read( Folder::SORT_NAME, true );
//expected
$folderContent = (new Folder($folder))->read(Folder::SORT_NAME, true);

<rule ref="PSR2.Methods.FunctionCallSignature"/> is broken for tab and unfortunately cannot be used.

Does not detect/fix indentation issues

This does not detect missing/too much indentation or space-usage instead of tabs.

Uncaught Error: Class 'PHP_CodeSniffer\Runner' not found

Hi there :)

I have psr2r-sniffer installed (in a CakePHP 4 project), via composer, running PHP 7.3.29.

When I run the sniffer, I get the following error:

PHP Fatal error:  Uncaught Error: Class 'PHP_CodeSniffer\Runner' not found in /home/sites/olive/htdocs/vendor/fig-r/psr2r-sniffer/PSR2R/Tools/Sniffer.php:73
Stack trace:
#0 /home/sites/olive/htdocs/vendor/fig-r/psr2r-sniffer/bin/sniff.php(23): PSR2R\Tools\Sniffer->sniff()
#1 {main}
  thrown in /home/sites/olive/htdocs/vendor/fig-r/psr2r-sniffer/PSR2R/Tools/Sniffer.php on line 73

I have PHP_CodeSniffer installed through composer as well, and can run vendor/bin/phpcs path-to-file without issues.

What could be wrong here? Thanks in advance!

Difference of SingleQuote sniff from Squiz.Strings.DoubleQuoteUsage

As the title says what's the difference between them?

Uncaught Error: Class 'PHP_CodeSniffer_CLI'

Hi,

I've got Code sniffer installed via composer (dev dependency) but I'm getting this issue. I'm running PHP 7.1

PHP Fatal error:  Uncaught Error: Class 'PHP_CodeSniffer_CLI' not found in /vendor/fig-r/psr2r-sniffer/PSR2R/Tools/Sniffer.php:68
Stack trace:
#0 /vendor/fig-r/psr2r-sniffer/bin/sniff.php(22): PSR2R\Tools\Sniffer->sniff()
#1 {main}
  thrown in /vendor/fig-r/psr2r-sniffer/PSR2R/Tools/Sniffer.php on line 68
[woohuiren@localhost atom-api]$ vendor/bin/sniff
PHP Fatal error:  Uncaught Error: Class 'PHP_CodeSniffer_CLI' not found in /vendor/fig-r/psr2r-sniffer/PSR2R/Tools/Sniffer.php:68
Stack trace:
#0 /vendor/fig-r/psr2r-sniffer/bin/sniff.php(22): PSR2R\Tools\Sniffer->sniff()
#1 {main}
  thrown in /vendor/fig-r/psr2r-sniffer/PSR2R/Tools/Sniffer.php on line 68\

I went to look at the file. Apparently its just use use PHP_CodeSniffer_CLI;. Is there a better way to go about? I could possibly contribute something to allow the use of dev dependency version of PHP code sniffer.

Thanks again

EDIT: I took a look and apparenly #11 fixes this?

Issue with alphabetical order of classes

Weird behaviour occurs in sorting used classes in alphabetical order (see screenshot).
In my opinion a space comes before any letter...

To fix the notice it wants me to place Ad between AdAdvertiser and AdGroupLeadgeneration.

Suspect sniff: PSR2R\Sniffs\Namespaces\UseInAlphabeticalOrderSniff.php
PHP: 7.3.9
IDE: PhpStorm 2020.1.1

Agenda

First

Then

apply improvements from #11
include maybe https://gist.github.com/gsherwood/9d22f634c57f990a7c64 for simplicity
raise PHP min version to ~~7.1~~ 7.2
add new (slevomat) sniffs (e.g. SlevomatCodingStandard.Arrays.TrailingArrayComma )
release 1.0

See https://github.com/php-fig-rectified/psr2r-sniffer/wiki#php-version-map

Assert no newlines before namespace

Add: There must be no blank line before the namespace declaration.

php-fig-rectified / psr2r-sniffer Goto Github PK

psr2r-sniffer's People

Contributors

Stargazers

Watchers

Forkers

psr2r-sniffer's Issues

NoInlineFullyQualifiedClassName vs UnusedUseStatementSniff.php

Question - documenting internals

Support for phpstan generics?

whitespace issues

Does not detect/fix indentation issues

Uncaught Error: Class 'PHP_CodeSniffer\Runner' not found

Difference of SingleQuote sniff from Squiz.Strings.DoubleQuoteUsage

Uncaught Error: Class 'PHP_CodeSniffer_CLI'

Issue with alphabetical order of classes

Agenda

Assert no newlines before namespace

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent