Revision of http://git.drupal.org/project/cision_block.git 8.x-1.x from Sat, 02/17/2018 - 21:41

Revisions allow you to track differences between multiple versions of your content, and revert back to older versions.

Review of the 8.x-1.x branch (commit 8c80189):
  • Your README.txt does not follow best practices (headings need to be uppercase). See https://www.drupal.org/node/2181737 .
    • The INTRODUCTION section is missing.
    • The REQUIREMENTS section is missing.
    • The INSTALLATION section is missing.
    • The CONFIGURATION section is missing.
  • The cision_block.module does not implement hook_help(). See https://www.drupal.org/docs/develop/documenting-your-project/module-docu... .
  • Remove all old CVS $Id tags, they are not needed anymore.
    src/Item/CisionItem.php:9:  public $Id;
    
  • Coder Sniffer has found some issues with your code (please check the Drupal coding standards). See attachment.
  • DrupalPractice has found some issues with your code, but could be false positives.
    
    FILE: ...dor/drupal/pareviewsh/pareview_temp/src/Plugin/Block/CisionBlock.php
    --------------------------------------------------------------------------
    FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
    --------------------------------------------------------------------------
     101 | WARNING | \Drupal calls should be avoided in classes, use
         |         | dependency injection instead
    --------------------------------------------------------------------------
    
    Time: 170ms; Memory: 4Mb
    
  • No automated test cases were found, did you consider writing PHPUnit tests? This is not a requirement but encouraged for professional software development.
This automated report was generated with PAReview.sh, your friendly project application review script.

FILE: ...e1101/web/vendor/drupal/pareviewsh/pareview_temp/cision_block.module
--------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------
 16 | WARNING | [x] A comma should follow the last multiline array item.
    |         |     Found: NULL
--------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------


FILE: ...1/web/vendor/drupal/pareviewsh/pareview_temp/src/Item/CisionItem.php
--------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------
 41 | ERROR | [x] You must use "/**" style comments for a member variable
    |       |     comment
--------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------


FILE: ...dor/drupal/pareviewsh/pareview_temp/src/Plugin/Block/CisionBlock.php
--------------------------------------------------------------------------
FOUND 6 ERRORS AND 2 WARNINGS AFFECTING 6 LINES
--------------------------------------------------------------------------
   9 | WARNING | [x] Unused use statement
  91 | ERROR   | [x] Line indented incorrectly; expected 2 spaces, found
     |         |     4
  91 | ERROR   | [ ] Missing short description in doc comment
  92 | ERROR   | [ ] Missing parameter comment
  93 | ERROR   | [ ] Missing parameter comment
  93 | ERROR   | [ ] Missing parameter type
  94 | ERROR   | [ ] Description for the @return value is missing
 140 | WARNING | [x] A comma should follow the last multiline array item.
     |         |     Found: 'url.query_args'
--------------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------

Time: 409ms; Memory: 4Mb