solution10/devkit

Aides in the development of the S10 packages by grouping dev tools together into one package

solution10/devkit

This package aides in the development of the S10 packages by grouping dev tools together into one package and providing a sweet command line tool for generating common elements of an s10 component (Makefile, folders, legal docs, phpunit etc), _(*1)

Whilst this is heavily focused on the s10 components, there might be something in here useful to others! Let me know if it is!, _(*2)

Installation

$ composer require --dev solution10/devkit

By using the --dev option you ensure that the devkit isn't pulled down when people install and use your component in production., _(*3)

Dependancies Installed

• phpUnit
• PHP Code Sniffer
• PHP Coveralls (for Travis generated coverage reports)
• APIgen

Command line tool

The command line tool can create all of the project files you need either all in one or individually if you only want some., _(*4)

The tool can create:, _(*5)

• Directories (src/ tests/ and docs/)
• .gitignore
• "Legal" docs (Contributing, License and readme)
• Makefile (with shortcut for generating API docs)
• PHPUnit configuration and bootstrap file
• Travis configuration file

Use $ ./vendor/bin/s10devkit list to see the individual commands and info on how to use them, _(*6)

How to use the Devkit

On starting a new component., _(*7)

$ mkdir s10-mycomponent
$ touch s10-mycomponent/composer.json

Then fill in composer.json with a name, description and require-dev line like so:, _(*8)

{
    "name": "solution10/(put the name of your component here)",
    "description": "(put your component description here)",
    "minimum-stability": "stable",
    "license": "MIT",
    "authors": [
        {
            "name": "Your Name",
            "email": "Your Email"
        }
    ],
    "require-dev": {
        "solution10/devkit": "@dev"
    }
}

By filling in the title, description and authors, the devkit can automatically generate things like the README, phpUnit config and Licensing info without you doing a thing., _(*9)

Now all that's left to do is run composer install, and then the devkit, _(*10)

$ composer install
$ ./vendor/bin/s10devkit bootstrap-component

Instead of bootstrap-component, you could always just generate the things you want:, _(*11)

$ ./vendor/bin/s10devkit makefile && ./vendor/bin/s10devkit gitignore

To see all of the available generators, simply list:, _(*12)

$ ./vendor/bin/s10devkit

The Travis Config file

By default the Travis file is setup to run phpunit and phpcs but obviously you can change it to do whatever you want!, _(*13)

Authors

• Alex Gisby alex@solution10.com