hu19891110 / package-builder

A composer package builder.

Package Builder

A composer package builder.

Install

1. As a Phar (Recommended)

$ curl -LSs https://overtrue.me/package-builder/installer.php | php
# as a command.
mv package-builder.phar /usr/bin/package-builder
chmod +x /usr/bin/package-builder

2. As a Global Composer Install

$ composer global require 'overtrue/package-builder' --prefer-source

Usage

 $ package-builder help

create a composer package:

package-builder build [target directory]

example:

$ package-builder build ./

# Please enter the name of the package (example: foo/bar): vendor/product
# Please enter the namespace of the package [Vendor\Product]:
# Do you want to test this package ?[Y/n]:
# Do you want to use php-cs-fixer format you code ? [Y/n]:
# Please enter the standard of php-cs-fixer [symfony] ?
# composer command...

The follow package will be created:

vendor-product
├── .editorconfig
├── .gitattributes
├── .gitignore
├── .php_cs
├── README.md
├── composer.json
├── phpunit.xml.dist
├── src
│   └── .gitkeep
└── tests
    └── .gitkeep

Update Package Builder

$ package-builder update

Contributing

You can contribute in one of three ways:

1. File bug reports using the issue tracker.
2. Answer questions or fix bugs on the issue tracker.
3. Contribute new features or update the wiki.

The code contribution process is not very formal. You just need to make sure that you follow the PSR-0, PSR-1, and PSR-2 coding guidelines. Any new code contributions must be accompanied by unit tests where applicable.

License

MIT