dankempster/template-php-component

A template workspace for developing a new component/package. Includes configuration for travis-ci.org, Scrutinizer.com and Coveralls.io.

Maintainers

Details

github.com/dankempster/template-php-component

Source

Issues

Installs: 6

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

Type:project

dev-master / 1.0.x-dev 2015-01-02 15:28 UTC

Requires

  • php: >=5.4

Requires (Dev)

MIT f3a40e79700789629064ad15a57f540a44820c88

coverallsscrutinizerworkspace templatetravis-ci

This package is auto-updated.

Last update: 2024-11-23 06:12:08 UTC

README

Usage

Install the template using composer

$ composer create-project dankempster/workspace-component myvendor-mycomponent/
$ cd myvendor-mycomponent/

Replace distribtion files

$ rm composer.json readme.md
$ mv composer.json.dist composer.json
$ touch readme.md

The template uses the example package name Acme\Component. Replace that with your package name by performing search and replace on the following files:

  • composer.json :
    • acme/component - my-vendor/my-component
    • Acme\\Component\\ - MyVendor\\MyComponent\\
  • phpunit.xml.dist
    • Acme/Component - MyVendor/MyComponent

Now write your own readme.md file.

Directory Structure

Fairly simple and self explanatory structure:

|- docs/
|- src/
|- tests/
|- .gitignore.yml
|- .composer.json
|- phpunit.xml.dist
`- Readme.md

CI and SaaS

This template also includes configuration files for:

  • Travis CI
  • Scrutinizr
  • Coveralls

All of which are free for Open Source projects.

Tip: Also check out SensionInsight - no configuration required.

Travis CI

Travis CI is a hosted continuous integration service with Github integration. So when the hosted repo revies pull requests or pushes, Travis CI will start a build and run your projects tests.

Scrutinizer

Is a code quality analysis tool, in fact it's many tools in one. Like Travis CI, Scrutiinizer integrates with Github and so will perform an "inspection" when the hosted repo recieves any pushes or pull requests. This workspace doesn't include any default configuration for Scrutinizer (I like to use global configuratoins in my account), but Travis is configured (.travis.yml) to send code coverage reports (clover.xml) to Scrutiinizer.

Coveralls

Coveralls is an only code coverage visualisation aid. This repo uses the satooshi/php-coveralls as a dev-dependancy to upload cover coverage reports to Coveralls after a Travis build.