Setting up your Joomla extension development environment

If you create Joomla! extensions you have to do some not complicated but time consuming tasks. It is easy to make a mistake and you have to start over again. I'll show how I have setup my environment and how this is integrated in the development process and package creating process. You can learn how a tool like phing can make you life easier.

Transcript

1. Development Tools Robert Deutz
2. Challenges
3. DEVELOPMENT TESTING PACKAGING
4. 5 Areas
5. Version Control 1
6. Code quality and consistency 2
7. Integrated Development Environment 3
8. Some little tools 4
9. Build Tools 5
11. Version Control
12. Never do development without a version control system RULE 1
13. CVS SVN Mercury Git Centralised Distributed
14. Centralised Version Control Systems • very popular at the end of the last century • complicated when working in not centralised teams • merging and working on different things at the same moment is complicated • still room for using it but NOT in an Open Source Project like Joomla!
15. Distributed • Best thing since sliced bread • good for not centralised teams • Supports merging and branching in an easy way • It allows a group of people to work on different ideas and in parallel on a single codebase
16. CVS SVN Mercury Git Centralised Distributed
17. GIT
18. try.github.com Got 15 minutes and want to learn Git?
20. Code quality and consistency
21. Write beautiful and well documented code. RULE 2 ALWAYS
22. We do • use brackets • use tabs • format code always in the same way • use meaningful function, variable, methods and class names • use phpDoc Blocks • not copy code (DRY: don‘t repeat yourself)
23. We write helpful comments As I wrote this code only god and I know what it is doing, now only god knows WRONG Registers a handler to a particular event group. RIGHT
25. Integrated Development Environment (IDE)
26. We are using an IDE RULE 3 WHEN IT MAKES SENSE
27. I don‘t care which one
28. IDEs • Eclipse (Zend Studio, phpEclipse, .....) • PHP Storm (free license for Joomla! developers) • NetBeans IDE
29. Cooler Editor: Sublime Text • Packages for almost everything we need • extremely fast • Edit features from heaven • .... but not an IDE • comes closer and closer
30. How to chose a IDE • Don‘t give up! • It need‘s time, so think first about your requirements • Think about your development process, what you have to do to make sure that you can support your process properly
32. Some little tools
33. We are trying to automate steps in our development process RULE 4 DEVELOPERS ARE LAZY
34. Code formatting Code Sniffer
35. phpcs --standard=Joomla *
36. a lot
37. phpcs --standard=Joomla *|grep 'ERROR'|wc -l
39. phpcs --standard=Joomla *|grep 'WARNING'|wc -l
41. find . -type f |wc -l
43. but
44. robert-deutzs-macbook-pro:babioon-download deutz$ phpcs --standard=Joomla *|grep 'FOUND' FOUND 15 ERROR(S) AFFECTING 8 LINE(S) FOUND 9 ERROR(S) AFFECTING 6 LINE(S) FOUND 13 ERROR(S) AND 1 WARNING(S) AFFECTING 7 LINE(S) FOUND 101 ERROR(S) AND 7 WARNING(S) AFFECTING 60 LINE(S) FOUND 15 ERROR(S) AFFECTING 9 LINE(S) FOUND 17 ERROR(S) AFFECTING 10 LINE(S) FOUND 22 ERROR(S) AFFECTING 12 LINE(S) FOUND 133 ERROR(S) AND 3 WARNING(S) AFFECTING 37 LINE(S) FOUND 123 ERROR(S) AND 7 WARNING(S) AFFECTING 72 LINE(S) FOUND 19 ERROR(S) AFFECTING 13 LINE(S) FOUND 80 ERROR(S) AFFECTING 43 LINE(S) FOUND 38 ERROR(S) AND 1 WARNING(S) AFFECTING 18 LINE(S) FOUND 33 ERROR(S) AFFECTING 20 LINE(S) FOUND 23 ERROR(S) AFFECTING 13 LINE(S) FOUND 48 ERROR(S) AND 2 WARNING(S) AFFECTING 25 LINE(S) FOUND 13 ERROR(S) AND 2 WARNING(S) AFFECTING 10 LINE(S) FOUND 28 ERROR(S) AFFECTING 21 LINE(S) FOUND 17 ERROR(S) AND 5 WARNING(S) AFFECTING 13 LINE(S) FOUND 21 ERROR(S) AFFECTING 15 LINE(S) FOUND 33 ERROR(S) AND 1 WARNING(S) AFFECTING 22 LINE(S) FOUND 15 ERROR(S) AND 1 WARNING(S) AFFECTING 10 LINE(S) FOUND 33 ERROR(S) AFFECTING 17 LINE(S) FOUND 17 ERROR(S) AND 6 WARNING(S) AFFECTING 14 LINE(S) FOUND 44 ERROR(S) AND 1 WARNING(S) AFFECTING 21 LINE(S) FOUND 20 ERROR(S) AND 1 WARNING(S) AFFECTING 16 LINE(S) FOUND 224 ERROR(S) AND 1 WARNING(S) AFFECTING 107 LINE(S)
45. PHP Documenter
46. Creates from your well documented and formated code an API documentation, with just a klick
49. Build tools
50. Don‘t do it by yourself when a script can do it for you RULE 5
51. www.PHING.info
52. extendable executing commands packaging checkout from a repository copy files replace tags in files
53. 2 FILES
54. map
57. packaging
59. [1] http://digitaldisseny.com/en/blog/141-setting-up-codesniffer-to-validate-joomla-coding-standards-on-ubuntu [2] http://git-scm.com
60. Danke rdeutz rdeutz@gmail.com