Getting started with Package development

Beginner and intermediate hints to increase the credibility of your package. Presented for #laraconeu 2014 in Amsterdam.

Transcript

1. Package development For PHP and Laravel
2. Hi, my name is Hannes.
3. • Belgium • Developer • Laravel since 4.0.0-BETA3 • @hannesvdvreken ABOUT ME
4. Laravel Brussels
5. Package development
6. 37 031 packages registered on packagist.org
7. • Stand out • What not? • For who? PACKAGE DEVELOPMENT
8. • Required steps • Recommended steps • Framework support STEPS
9. 1. Required steps
10. https:/ /getcomposer.org
11. • Setup folder structure REQUIRED STEPS - COMPOSER
12. REQUIRED STEPS - COMPOSER ! / |-- src | |-- Foo.php | +-- Bar.php |-- tests | |-- FooTest.php | +-- BarTest.php +-- composer.json
13. • Setup autoloading REQUIRED STEPS - COMPOSER
14. { "name": "vendor/package", "description": "short desc", "license": "MIT", "type": "library", "autoload": { "psr-4": { "Vendor\\Package\\": "src/" } } }
15. https:/ /packagist.org
16. • Login | Create a new account • Submit package REQUIRED STEPS - PACKAGIST
18. https:/ /packagist.org/packages/vendor/package
19. http:/ /git-scm.com/book
20. • git tag • version number • message • signed with identity • ref REQUIRED STEPS - VERSIONING - GIT
21. • semver.org • {major}.{minor}.{bug} REQUIRED STEPS - VERSIONING - SEMVER
22. • laravel/framework 4.2.* is 4.2.8 • laravel/framework 4.1.* is 4.1.30 REQUIRED STEPS - VERSIONING - SEMVER
23. • GitHub → Packagist • https:/ /github.com/
 username/repo/settings/hooks REQUIRED STEPS - VERSIONING - WEB HOOK
27. "require": { "vendor/package": "1.0.*" }
28. • composer.json • packagist • versioning REQUIRED STEPS - RECAP
29. 2. Recommended steps
30. Testing
31. • Prove your code • Prove other people’s code • Documentation RECOMMENDED - TESTING - REASONS
32. • PHPUnit • PHPSpec • PHPUnit Mocks • Mockery RECOMMENDED - TESTING - TOOLS
33. • Custom mocks • Only test your own code • Keep it simple RECOMMENDED - TESTING - PITFALLS
34. https:/ /travis-ci.org
35. language: php php: - 5.4 - 5.5 - 5.6 - hhvm before_script: - composer self-update - composer install --prefer-source --dev script: - phpunit
36. POST /v3/repos/:owner/:repo/statuses/:sha
 Host: api.github.com RECOMMENDED - TESTING - TRAVIS
37. { "status": "success", "context": "continuous-integration/travis-ci", "description": "The Travis CI build passed", "target_url": "https://travis-ci.org/username/ repo/builds/12345678" } RECOMMENDED - TESTING - TRAVIS
38. RECOMMENDED - TESTING - TRAVIS
39. RECOMMENDED - TESTING - TRAVIS
40. https:/ /coveralls.io
41. { "name": "vendor/package", "description": "short desc", "license": "MIT", "type": "library", "autoload": { "psr-4": { "Vendor\\Package\\": "src/" } }, "require-dev": { "satooshi/php-coveralls": "0.6.*" } }
42. language: php php: - 5.4 - 5.5 - 5.6 - hhvm before_script: - composer self-update - composer install --prefer-source --dev script: - phpunit --coverage-clover build/logs/clo after_success:
 - php vendor/bin/coveralls -v
43. RECOMMENDED - TESTING - COVERAGE
44. • PHPCS • PHPMD RECOMMENDED - TESTING - EXTRA
45. Documentation
46. • Brief explanation: what/how RECOMMENDED - README
47. • Code examples RECOMMENDED - README
48. • License • Contributing • Website RECOMMENDED - README
49. RECOMMENDED - README - BADGES http:/ /shields.io
50. [] (https://travis-ci.org/username/repo) RECOMMENDED - README - BADGES
51. RECOMMENDED - README - BADGES
52. RECOMMENDED - DOCUMENTATION - EXTRA • CONTRIBUTING.md • CHANGELOG.md • UPGRADE.md
53. RECOMMENDED - RECAP • Add tests • Prove they cover good % • Documentation
54. 3. Framework support
55. FRAMEWORK SUPPORT • Laravel wrapper packages
56. FRAMEWORK SUPPORT - EXAMPLES • Rocketeer, Envoy • AWS PHP SDK • Clockwork
59. FRAMEWORK SUPPORT - LARAVEL • ServiceProvider • Facade
60. FRAMEWORK SUPPORT - LARAVEL - ARTISAN • config:publish • asset:publish • view:publish • migrate --package="vendor/pack"
61. FRAMEWORK SUPPORT - LARAVEL • workbench • orchestra/testbench
62. FRAMEWORK SUPPORT - RECAP • Framework independent • Support classes in same package
63. • Publishing is easy • Document your packages • I want you to develop packages RECAP
64. Thanks! @hannesvdvreken https:/ /joind.in/11678
65. • https:/ /youtu.be/jV4iPSHbonk • https:/ /getcomposer.org • http:/ /www.php-fig.org/psr/psr-4/ • https:/ /packagist.org/statistics • http:/ /git-scm.com/book/en/Git-Basics-Tagging • https:/ /travis-ci.org • https:/ /coveralls.io • https:/ /developer.github.com/v3/repos/statuses • https:/ /shields.io • http:/ /laravel.com/docs/packages • https:/ /github.com/orchestral/testbench REFERENCES