wimby/skeleton

Composer package skeleton for Github implementing php-pds/skeleton standard

dev-master 2018-01-14 22:41 UTC

Requires

• composer-plugin-api: ~1.0
• overtrue/phplint: ^1.0
• pds/skeleton: ~1.0
• squizlabs/php_codesniffer: ~2.7

Requires (Dev)

• composer/composer: ~1.3

Suggests

• phpdocumentor/phpdocumentor
• phpspec/phpspec
• phpunit/phpunit

WTFPL

README

Command-line tool for generating Composer package skeleton (file structure, basic coding standard checkers and code analysing tools, pre-commit hooks...) suitable for Github.

Features

1. File structure according to PDS/Skeleton
2. Code style checker compliant with PSR-2
3. Pre-commit hook for PHP lint and code style check
4. Suggests other useful libraries

Why?

Mainly because of my laziness. It helps me create package with all the juicy files like .editorconfig, .gitattributes and helps me jump strait to a new project. Second reason is that if I change some basic code style checking tool, I would like to have an easy way to upgrade this tool in all my projects.

Installation

Step 1: Composer

Run following command for adding wimby/skeleton as your development dependency:

composer require-dev wimby/skeleton

Step 2: Configuration

You need to add the following lines to your composer.json file:

"scripts": {
    "post-create-project-cmd": "Wimby\\Skeleton::postCreateProject"
}

Step 3: Invoking

composer create-project

or

composer run-script post-create-project-cmd

License

WTFPL - Do What the Fuck You Want to Public License