Yeoman (http://yeoman.io) generator for a PHP Composer project
MIT License
A generator for Yeoman.
It provides a basic boilerplate for a Composer project, which features:
The proposed Grunt build for the generated Composer project has the following tasks:
The generated PHP project does not rely on any other PHP dependency than Composer and Packagist-installed packages (e.g. no PEAR dependency).
You must have Nodejs and NPM installed.
Then, to install Yeoman globally from npm, run:
npm install -g yo
Finally, to install generator-composer globally from npm, run:
npm install -g generator-composer
You may also just install it locally:
npm install generator-composer
Once you have installed Node, NPM, Yeoman and the generator itself, you can initiate the generator:
yo composer
Yeoman will ask you 3 questions:
In order to build your generated Composer project from its source, you will need Grunt and PHP on the command line.
So, you must install PHP5 on your system on your command line. Test it:
php --help
To install Grunt globally on the command line (and run the above build task), run:
npm install -g grunt-cli
Then, with Grunt, you can install Composer locally. Just run once:
grunt init
Then, you can install PhpDocumentor, PhpUnit and PhpCPD locally. Just run once:
php composer.phar install -v
Finally, you should also install the PHP extension named Xdebug, which will be used by PhpUnit for code coverage.
Once all your dependencies are installed, you can build your project with Grunt:
grunt build
The build process will run the following tasks:
The generated PHP is ready-to-publish on Packagist. Just login on Packagist with Github, add the Packagist hooks to your Github account, and activate your package on Packagist.
The generator itself can be built from its sources. At the moment, the build process only includes syntax checks with JSHint and JSCS.
In order to build the generator from its source, you will need Grunt. To install Grunt globally on the command line (and run the above build task), run:
npm install -g grunt-cli
Just run the grunt task
in the folder where your generator is installed:
grunt
This generator is released under the MIT License.