-
Notifications
You must be signed in to change notification settings - Fork 0
PHPCodeSniffer
This document describes the use of the PHPCodeSniffer to check if your coding style complies to the Ontowiki/Erfurt Coding standard.
To use the PHPCodeSniffer you must install the PHP PEAR Framework
For Ubuntu execute:
sudo apt-get install php-pear
For other systems or more information go to PEAR Framework Installation
Go to your Ontowiki/Erfurt directory and run:
make cs-install
This will install the latest version of the CodeSniffer and enables automatically the pre-commit code checking.
For automatically checking your coding style before every commit you can run the following commands in your Ontowiki/Erfurt directory.
make cs-enable
After that the CodeSniffer will check your code before each commit.
To turn off this functionality run:
make cs-disable
Important: The CodeSniffer only check the added or changed commit files, not the deleted files and not the whole Ontowiki-Source.
If you make a commit and your code not match the coding standard you will get something like that:
./application/tests/CodeSniffer/pre-commit
E.E.EE
PHP CODE SNIFFER REPORT SUMMARY
--------------------------------------------------------------------------------
FILE ERRORS WARNINGS
--------------------------------------------------------------------------------
/home/lars/Uni/BA/OW_default/TestClass.php 6 0
/home/lars/Uni/BA/OW_default/TestClass3.php 6 0
/home/lars/Uni/BA/OW_default/TestClass5.php 6 0
/home/lars/Uni/BA/OW_default/TestClass6.php 6 0
--------------------------------------------------------------------------------
A TOTAL OF 24 ERROR(S) AND 0 WARNING(S) WERE FOUND IN 4 FILE(S)
--------------------------------------------------------------------------------
Time: 0 seconds, Memory: 2.50Mb
make: *** [cs-check-commit] Fehler 1
This is a summary of all files, that have been checked. You can see how many files were checked and how many errors or warnings every file have caused.
To correct your code you need a more detailed view, so you can run:
make cs-check-commit
and get something like that for every file that have been checked:
FILE: /home/lars/Uni/BA/OW_default/TestClass.php
--------------------------------------------------------------------------------
FOUND 6 ERROR(S) AFFECTING 5 LINE(S)
--------------------------------------------------------------------------------
6 | ERROR | Protected member variable "test" must contain a leading
| | underscore
9 | ERROR | Variable "test_variable" is not in valid camel caps format
11 | ERROR | Variable "Test" is not in valid camel caps format
13 | ERROR | Opening brace should be on a new line
14 | ERROR | No space found after comma in function call
14 | ERROR | Space before opening parenthesis of function call prohibited
--------------------------------------------------------------------------------
Now you can see the description of the errors and the line where they occur. So you have the possibility to correct your code and check it again.
Note: If there are less than six files to check, you get the detail view automatically and not the summary view.
If you want a easier way to correct your coding standard violations, you can integrat the Code Sniffer Check in your IDE.
-
For VIM
You find a solution on this Site or on this Site. But instead of the plain PHP CodeSniffer command, you can use the Makefile command from the ontowiki main directory, so the code standard and other thinks are automatically itegrated in this command.
make cs-check-commit-emacs
If you have a better solution, feel free to write it here or if you need a other Makefile command open a new issue and assign it to me (larseidam) -
For Komodo Edit
Make a new command in your Toolbox and give it a name. After that, add
make cs-check-commit-emacs
to the command field and to the 'Start in' field write the full path to or ontowiki project. Now make a hook at the 'Parse with output' Field an write this
^(?P<file>.*):(?P<line>\d+):(?P<column>\d+):(?P<content>.*)
in the textfield. In the final step make a hook at the 'Show output as a list' field. Push 'OK' and check the new created command.
Note: You must have some Code in the stagearea of git, otherwise the CodeSniffer have no files to check and you don't want to see, if it runs or not.
For git:
The CodeSniffer checks all files or fileparts that has been added to the index (with git add). If you fix some issues that were reported, you have to re-add these changes, otherwise CS will complain again and again.