Drupal Coder - coder_format08.Sep. 2010
Bei der Entwicklung eigener Drupal Module sollte man sich an die von Drupal definierten Coding-Standard halten .
Das Modul Coder hilft beim Review des Codes und zeigt eventuelle Fehlerquellen.
Neben der Fehlersuche kann Coder aber auch aktiv den Code "aufräumen", um den Coding Standards gerecht zu werden.
Hierfür gibt es die Kommandozeilenanwendung coder_format - das Script befindet sich im Ordner scripts/coder_format des coder Moduls.
Der Aufruf erfolgt wie folgt:
$ php coder_format.php mymodule.module
coder_format erzeugt beim Aufruf automatisch ein Backup der entsprechenden Datei.
Sinnvoll ist die Einrichtung eines eigenen Aliases für den Aufruf von coder_format.
Beschreibung für Mac OSx
- Kopie des Ordners scripts/coder_format in beliebigen Ordner bspw. /Users/steffen/drupal_cmd/coder_format
- Erstellung eines Aliases in .bash_profile
- Öffnen der Datei .bash_profile im terminal $ nano /Users/steffen/
- Alias hinzufügen - folgende Zeile je nach Verzeichnisstruktur einfügen/ anpassen
alias coder_format="/Applications/MAMP/bin/php5/bin/php /Users/steffen/drupal_cmd/coder_format/coder_format.php"
- terminal neustarten
- coder_format über den Aufruf $ coder_format mymodule.module nutzen ;)
Bis auf ein paar kleinere Probleme ( verschachtelte switch/case Strukturen) leistet das Script sehr gute Arbeit.
Falls der Quellcode doch einmal unschön formatiert wird, kann man mittels Sed auch recht fix alle führenden Leerzeichen aus der Datei entfernen und coder_format erneut ausführen bzw. entsprechende Anpassungen vornehmen.
- alle leeren Zeilen entfernen
$ cat my_module.module | sed '/^$/d' > my_module_.module - alle führenden Leerzeichen entfernen
$ cat my_module.module | sed -e 's/^[ \t]*//' > my_module_.module
Weitere Infos:
http://drupal.org/project/coder
http://www.cyberciti.biz/tips/delete-leading-spaces-from-front-of-each-w...