Code Quality

sepidarsms.com

General development and debugging environment config

Sshfs client to mount remote file system

Linux:
sshfs user@domain.com:/remote/path /local/path
Windows:
https://code.google.com/p/win-sshfs/downloads/detail?name=win-sshfs-0.0.1.5-setup.exe&can=2&q=

Eclipse Lua (remember sdk & jdk)

https://eclipse.org/downloads/packages/eclipse-ide-java-ee-developers/lunasr1a

Xdebug toolbar chrome

https://chrome.google.com/webstore/detail/xdebug-helper/eadndfjplgieldjbigjakmdgkmoaaaoc?hl=en

Install xdebug ubuntu case:

Installation:
http://xdebug.org/docs/install
pecl install xdebug
zend_extension="/usr/local/php/modules/xdebug.so"
verify: php -v | grep ‘xdebug’
Configuration
config xdebug.ini or php.ini
zend_extension=/usr/local/php/modules/xdebug.so
xdebug.idekey=default
xdebug.remote_enable=on
xdebug.remote_handler=dbgp
xdebug.remote_host=localhost //Must use ssh tunnel
xdebug.remote_port=9000

Eclipse setup:

Setup debugger:

• Preferences => PHP => Debug => Installed debuggers => xdebug
  
• Accept remote session (JIT): any
  
• If remote use ssh tunnel.
  

Create remote server:

• Preferences => PHP => PHP Servers < Server tab
  

General eclipse coding standards and GUI setup:

• Preferences -> Language(java) -> Editor -> Save Actions and configure it to remove trailing whitespace.
• Window->Preferences->Java->Code Style->Formatter->Edit->Indentation = "Spaces Only" to tabs to space.
• Window > Preferences > General > Editors > Text Editors > Click on the CheckBox "whitespace characters".
• Eclipse LF to CRLF

Eclipse cool GUI:

• Install plugin http://eclipsecolorthemes.org/?view=plugin
• Download and import https://github.com/guari/eclipse-ui-theme/blob/master/com.github.eclipseuitheme.themes.plugin/bin/color-scheme/RainbowDrops.xml?raw=true
  

PDT code formatting on steroids. Built-In PSR-2 formatter profile.:

• Install PDT : http://download.eclipse.org/tools/pdt/updates/latest

Coding Standards:

• Window -> Preferences -> PHP -> Code Style -> Formatter -> Select (PRS2)

Security:

• Read: http://phpsec.org/projects/guide/
• Enable CodeSniffer Validator

Code documentation:

• Window > Preferences > PHP > Editor > Typing > Automatically close > Phpdoc (Check) > Add Phpdoc tags
  

Eclipse for JS:

Coding Standards:

• jsHint http://github.eclipsesource.com/jshint-eclipse
• Window Menu >> Preference >> JSHINT >> Enable JSHINT errors (Check)

From google:

• Download this xml file https://code.google.com/p/google-styleguide/source/browse/trunk/eclipse-java-google-style.xml
• Import as new file configuration
  • Window Menu >> Preference >> Web >> JavaScript >> Formatter

Sencha:

• Install: https://github.com/DIRACGrid/WebAppDIRAC/wiki/How-to-setup-Eclipse-for-developing-ExtJs

Code documentation:

• Run https://code.google.com/p/jsdoc-toolkit/wiki/OtherTools
  

For vim Users:

• set numberset listchars=eol:$,tab:>-,trail:.,extends:>,precedes:<
• set list
• set tabstop=4 shiftwidth=4 expandtab
• highlight ExtraWhitespace ctermbg=red guibg=red
• match ExtraWhitespace /\s\+$/
• autocmd BufWinEnter * match ExtraWhitespace /\s\+$/
• autocmd InsertEnter * match ExtraWhitespace /\s\+\%#\@<!$/
• autocmd InsertLeave * match ExtraWhitespace /\s\+$/
• autocmd BufWinLeave * call clearmatches()
  

Useful resources: http://www.ibm.com/developerworks/library/os-debug/ https://code.google.com/p/google-styleguide

PHP

Code Validator and fixer

1. Go to buildtools_backend/libs/docs
2. Run ./buildtools_backend/libs/docs/codeValidor.sh
3. Fix errors
   

Sample output:
FILE: /home/james/buildtools_backend/libs/models/Configuration.php

---

FOUND 4 ERRORS AFFECTING 4 LINES

---

1 | ERROR | [x] End of line character is invalid; expected "\n" but  found "\r\n"

2 | ERROR | [x] Whitespace found at end of line

5 | ERROR | [ ] Each class must be in a namespace of at least one level (a top-level vendor name)

6 | ERROR | [x] Tabs must be used to indent lines; spaces are not  allowed 

---

PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY

buildtools_backend

• Models files and class names always in plural