Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Enhancement] Improve Magento.Annotation rules #3

Closed
lenaorobei opened this issue Jan 11, 2019 · 1 comment
Closed

[Enhancement] Improve Magento.Annotation rules #3

lenaorobei opened this issue Jan 11, 2019 · 1 comment
Labels
accepted New rule is accepted enhancement Improvements to existing rules

Comments

@lenaorobei
Copy link
Contributor

lenaorobei commented Jan 11, 2019 •
edited
Loading

Description

PHP CodeSniffer goes out-of-box with beautifier tool (phpcbf). To use this functionality sniff should throw fixable warning/error and provide fix (tokens replacement, content change, etc).
Now rules under Magento/Annotation raise regular warnings so annotation issues cannot be fixes automatically by phpcbf.

Expected behavior

The sniff throws fixable warning instead of warning and provides fix for an issue it detects.

Benefits

Annotation issues will be fixable automatically by phpcbf tool.

Additional information

Useful links:

  1. Coding Standard Tutorial
  2. Beautifier Tool
@lenaorobei lenaorobei added the enhancement Improvements to existing rules label Jan 11, 2019
@lenaorobei lenaorobei added the accepted New rule is accepted label Jan 14, 2019
@lenaorobei lenaorobei changed the title Improve Magento.Annotation rules [Enhancement] Improve Magento.Annotation rules Jan 29, 2019
@lenaorobei
Copy link
Contributor Author

Closing since rules under Annotation section were removed due to unsuitability.
See #54 and #58.

mmansoor-magento pushed a commit that referenced this issue Dec 2, 2020
@sivaschenko
Merge pull request #3 from magento-commerce/develop
0e6f0c7 
v6 release scope
fredden added a commit to fredden/magento-coding-standard that referenced this issue May 24, 2021
@fredden
Fix PHP TypeError
437f8f3 
    Fatal error: Uncaught TypeError: vsprintf(): Argument magento#2 ($values) must be of type array, int given in /srv/www/vendor/squizlabs/php_codesniffer/src/Files/File.php:1056
    Stack trace:
    #0 /srv/www/vendor/squizlabs/php_codesniffer/src/Files/File.php(1056): vsprintf('Direct throw of...', 531)
    magento#1 /srv/www/vendor/squizlabs/php_codesniffer/src/Files/File.php(706): PHP_CodeSniffer\Files\File->addMessage(false, 'Direct throw of...', 67, 4, 'FoundDirectThro...', 531, 8, false)
    magento#2 /srv/www/vendor/magento/magento-coding-standard/Magento2/Sniffs/Exceptions/DirectThrowSniff.php(48): PHP_CodeSniffer\Files\File->addWarning('Direct throw of...', 526, 'FoundDirectThro...', 531)
    magento#3 /srv/www/vendor/squizlabs/php_codesniffer/src/Files/File.php(498): Magento2\Sniffs\Exceptions\DirectThrowSniff->process(Object(PHP_CodeSniffer\Files\LocalFile), 526)
    magento#4 /srv/www/vendor/squizlabs/php_codesniffer/src/Files/LocalFile.php(92): PHP_CodeSniffer\Files\File->process()
    #5 /srv/www/vendor/squizlabs/php_codesniffer/src/Runner.php(630): PHP_CodeSniffer\Files\LocalFile->process()
    magento#6 /srv/www/vendor/squizlabs/php_codesniffer/src/Runner.php(434): PHP_CodeSniffer\Runner->processFile(Object(PHP_CodeSniffer\Files\LocalFile))
    magento#7 /srv/www/vendor/squizlabs/php_codesniffer/src/Runner.php(114): PHP_CodeSniffer\Runner->run()
    magento#8 /srv/www/vendor/squizlabs/php_codesniffer/bin/phpcs(18): PHP_CodeSniffer\Runner->runPHPCS()
    magento#9 {main}
      thrown in /srv/www/vendor/squizlabs/php_codesniffer/src/Files/File.php on line 1056
fredden added a commit to fredden/magento-coding-standard that referenced this issue Sep 2, 2021
@fredden
Fix PHP Fatal error when docblock is invalid
3fd461e 
  PHP Fatal error:  Uncaught TypeError: strpos(): Argument magento#2 ($needle) must be of type string, null given in /srv/www/vendor/magento/magento-coding-standard/Magento2/Sniffs/Annotation/MethodArgumentsSniff.php:629
  Stack trace:
  #0 /srv/www/vendor/magento/magento-coding-standard/Magento2/Sniffs/Annotation/MethodArgumentsSniff.php(629): strpos('\\VendorName\\Mod...', NULL)
  magento#1 /srv/www/vendor/magento/magento-coding-standard/Magento2/Sniffs/Annotation/MethodArgumentsSniff.php(515): Magento2\Sniffs\Annotation\MethodArgumentsSniff->validateFormattingConsistency(Array, Array, Object(PHP_CodeSniffer\Files\LocalFile), Array)
  magento#2 /srv/www/vendor/magento/magento-coding-standard/Magento2/Sniffs/Annotation/MethodArgumentsSniff.php(600): Magento2\Sniffs\Annotation\MethodArgumentsSniff->validateMethodParameterAnnotations(385, Array, Array, Object(PHP_CodeSniffer\Files\LocalFile), Array, 356, 380)
  magento#3 /srv/www/vendor/squizlabs/php_codesniffer/src/Files/File.php(498): Magento2\Sniffs\Annotation\MethodArgumentsSniff->process(Object(PHP_CodeSniffer\Files\LocalFile), 385)
  magento#4 /srv/www/vendor/squizlabs/php_codesniffer/src/Files/LocalFile.php(92): PHP_CodeSniffer\Files\File->process()
  #5 /srv/www/vendor/squizlabs/php_codesniffer/src/Runner.php(630): PHP_CodeSniffer\Files\LocalFile->process()
  magento#6 /srv/www/vendor/squizlabs/php_codesniffer/src/Runner.php(434): PHP_CodeSniffer\Runner->processFile(Object(PHP_CodeSniffer\Files\LocalFile))
  magento#7 /srv/www/vendor/squizlabs/php_codesniffer/src/Runner.php(114): PHP_CodeSniffer\Runner->run()
  magento#8 /srv/www/vendor/squizlabs/php_codesniffer/bin/phpcs(18): PHP_CodeSniffer\Runner->runPHPCS()
  magento#9 {main}
    thrown in /srv/www/vendor/magento/magento-coding-standard/Magento2/Sniffs/Annotation/MethodArgumentsSniff.php on line 629
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
accepted New rule is accepted enhancement Improvements to existing rules
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@lenaorobei