generator-composer-php-library v0.0.0

generator-composer-php-library

Yeoman generator

It provides a basic boilerplate for a Composer php library project, which features:

• Phpunit with code coverage, phpcs, phpmd, phpcpd
• Ready for Jenkins
• A functional example

The generated PHP project does not rely on any other PHP dependency than Composer (e.g. no PEAR dependency).

The generated Composer project has the following tasks:

• PHPUnit to run tests composer phpunit
• Phpcs to review quality of code (symfony2 standards) composer phpcs
• Usage of Php Copy/Paste Detector composer phpcpd
• Usage of phpmd to detect ugly code composer phpmd

Requirements

• Yeoman
• XDebug
• composer

Getting Started

What is Yeoman?

Trick question. It's not a thing. It's this guy:

Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.

Not every new computer comes with a Yeoman pre-installed. He lives in the npm package repository. You only have to ask for him once, then he packs up and moves into your hard drive. Make sure you clean up, he likes new and shiny things.

npm install -g yo

Yeoman Generators

Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.

To install generator-composer-php-library from npm, run:

npm install -g generator-composer-php-library

Finally, initiate the generator:

yo composer-php-library

Getting To Know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.

If you'd like to get to know Yeoman better and meet some of his friends, Grunt and Bower, check out the complete Getting Started Guide.

License

MIT