gennadyx/skeleton

Composer package skeleton

skeleton

![Software License][ico-license] ![Total Downloads][ico-downloads], _(*1)

![Coverage Status][ico-coverage] , _(*2)

Composer package skeleton.

This package provides the handler for the 'create-project' command, which automatically collects the necessary information, for example, vendor, package name, author name, author email, etc. It is also possible to set default values using environment variables., _(*3)

Available variables and their default values:

root                Project root directory
skeleton            Skeleton directory
vendor              System username from environment variable
name                Package name, uses project root directory basename
description         Just "package_name composer package"
homepage            https://github.com/vendor/package_name
author_name         'user.name' from git config or vendor
author_email        'user.email' from git config
author_homepage     https://github.com/vendor
namespace           Vendor\\Package or Vendor\\PackageName
tests_namespace     Vendor\\Package\\Tests

Usage

``` bash $ composer create-project gennadyx/skeleton package_name, <sub>(*4)</sub>

with env variable

$ COMPOSER_DEFAULT_VENDOR="my_vendor" composer create-project gennadyx/skeleton package_name, <sub>(*5)</sub>

## Change log

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Testing

``` bash
$ composer require --dev gennadyx/skeleton-tests
$ composer test

Contributing

Please see CONTRIBUTING for details., <sub>(*6)</sub>

Security

If you discover any security related issues, please email dev@gennadyx.tech instead of using the issue tracker., <sub>(*7)</sub>

Credits

• Gennady Knyazkin
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*8)</sub>