Automated project review reported several errors that we should be able to fix without too much trouble, since it's mostly coding standards errors (spaces missing, wrong indent, missing empty lines, etc...).
Review of the 7.x-1.x branch:
- README.txt is missing, see the guidelines for in-project documentation.
- Remove "version" from the ./collapse_text_wysiwyg.info file, it will be added by drupal.org packaging automatically.
- Coder Sniffer has found some issues with your code (please check the Drupal coding standards). See attachment.
This automated report was generated with PAReview.sh, your friendly project application review script. You can also use the online version to check your project. You have to get a review bonus to get a review from me.
FILE: ...rupal-7-pareview/pareview_temp/ckeditor-plugins/collapse_text/plugin.js
--------------------------------------------------------------------------------
FOUND 34 ERROR(S) AFFECTING 19 LINE(S)
--------------------------------------------------------------------------------
1 | ERROR | There should be no white space after an opening "("
3 | ERROR | There should be no white space after an opening "("
3 | ERROR | There should be no white space before a closing ")"
6 | ERROR | There should be no white space after an opening "("
6 | ERROR | There should be no white space after an opening "("
6 | ERROR | There should be no white space before a closing ")"
6 | ERROR | There should be no white space before a closing ")"
9 | ERROR | There should be no white space after an opening "("
14 | ERROR | There should be no white space before a closing ")"
17 | ERROR | There should be no white space after an opening "("
17 | ERROR | There should be no white space after an opening "("
17 | ERROR | There should be no white space before a closing ")"
33 | ERROR | There should be no white space after an opening "("
33 | ERROR | There should be no white space before a closing ")"
38 | ERROR | There should be no white space after an opening "("
38 | ERROR | There should be no white space before a closing ")"
52 | ERROR | There should be no white space after an opening "("
52 | ERROR | There should be no white space before a closing ")"
53 | ERROR | There should be no white space after an opening "("
53 | ERROR | There should be no white space before a closing ")"
54 | ERROR | There should be no white space after an opening "("
54 | ERROR | There should be no white space before a closing ")"
55 | ERROR | There should be no white space after an opening "("
55 | ERROR | There should be no white space before a closing ")"
57 | ERROR | Expected 1 space before "!="; 0 found
57 | ERROR | Expected 1 space after "!="; 0 found
57 | ERROR | There should be no white space before a closing ")"
63 | ERROR | There should be no white space after an opening "("
72 | ERROR | There should be no white space after an opening "("
77 | ERROR | Functions must not contain multiple empty lines in a row; found
| | 2 empty lines
82 | ERROR | There should be no white space after an opening "("
82 | ERROR | There should be no white space before a closing ")"
98 | ERROR | Comments may not appear after statements.
100 | ERROR | Comments may not appear after statements.
--------------------------------------------------------------------------------
FILE: /var/www/drupal-7-pareview/pareview_temp/collapse_text_wysiwyg.module
--------------------------------------------------------------------------------
FOUND 3 ERROR(S) AND 1 WARNING(S) AFFECTING 3 LINE(S)
--------------------------------------------------------------------------------
2 | ERROR | Missing file doc comment
4 | WARNING | Format should be "* Implements hook_foo().", "* Implements
| | hook_foo_BAR_ID_bar() for xyz_bar().", or "* Implements
| | hook_foo_BAR_ID_bar() for xyz_bar.tpl.php.".
4 | ERROR | Expected 1 space(s) before asterisk; 0 found
5 | ERROR | Expected 1 space(s) before asterisk; 0 found
--------------------------------------------------------------------------------
Source: http://ventral.org/pareview - PAReview.sh online service
Let's try to bring back module's code in compliance with coding standards and fix all validation errors.
There shouldn't be any change of code, other than the ones recommended by the coding standards PAReview.
Please let me know if you would have any questions, objections, comments, suggestions, recommendations or concerns on any aspects of this issue, I would be glad to provide more information or explain in more details.
Any questions, feedback, testing, changes, recommendations would be highly appreciated.
Thanks to all in advance.
Comments
Comment #1
dydave commentedQuick follow-up on this issue:
PAReview is not prompting any coding standards errors or warnings anymore:
7.x-1.x PAReview report: no more coding standards errors after changes were committed at a97de83 and 0155863.
I didn't do any complicated changes, just fixed the errors as indicated by the reports: wrong spaces, break down too long inline comments, standardize Doc comments blocks, add full stops at end of lines of inline comments, etc....
Also added a README.TXT file greatly inspired from project's page.
I have tested a little bit and everything seems to work as expected, but I would greatly appreciate if you could let me know if anybody encounters any issue with the latest commits related with coding standards, I would surely try doing a quick fix as soon as possible.
I allowed myself to mark this issue as fixed for now, but feel free to re-open it, or post a new ticket, at any time if you have any further objections with the changes committed at a97de83 and 0155863 (we would surely be happy to hear your feedback).
Please let me know if you would have any further comments, feedback, questions, issues, objections, suggestions or concerns on any of the latest commits or this ticket in general, I would be glad to provide more information or explain in more details.
Thanks in advance to everyone for your testing, reviews, reporting and feedback.
Cheers!
Comment #3
dydave commentedFollowing up with the latest code changes at 64f81be which introduced a small coding standards issue:
I went ahead, modified the code as suggested and committed the changes against collapse_text_wysiwyg-7.x-1.x at fbfc831.
Feel free to let me know if you would have any further comments, feedback, questions, issues, objections, suggestions or concerns on any of the latest code changes or this ticket in general, I would be glad to provide more information or explain in more details.
Thanks in advance to everyone for your testing, reviews, reporting and feedback.
Cheers!