mindtwo/php-package-creator

Craft a new PHP package based on thephpleague skeleton repository.

1.1 2024-04-18 22:34 UTC

This package is auto-updated.

Last update: 2024-10-18 23:40:07 UTC


README

Latest Version on Packagist Software License Total Downloads

Ask 100 developers what defines an awesome PHP package and you’ll get a lot of different answers. That also sounds like a really long and boring task, so the The League of Extraordinary Packages come up with a list of rules that we think make a package awesome.

This installer is a wrapper around the thephpleague/skeleton package.

Install

Via Composer

$ composer require mindtwo/php-package-creator --global

Make sure to place the $HOME/.composer/vendor/bin directory (or the equivalent directory for your OS) in your $PATH so the executable can be located by your system.

Usage

Once installed, the php-package-creator new command will create a fresh php package based on the thephpleague skeleton repository.

Only the first argumen

php-package-creator new test-package

Argument & Options

There is only one required argument ans some optional options for the php-package-creator new command.

  • Argument: php-package-creator new folder_name (Required)
  • Option: php-package-creator new folder_name --author_name=John (Optional)
  • Option: php-package-creator new folder_name --author_github_username=john (Optional)
  • Option: php-package-creator new folder_name --author_email=john@doe.com (Optional)
  • Option: php-package-creator new folder_name --author_twitter=john (Optional)
  • Option: php-package-creator new folder_name --author_website=https://example.com (Optional)
  • Option: php-package-creator new folder_name --package_vendor=doe (Optional)
  • Option: php-package-creator new folder_name --package_name=john (Optional)
  • Option: php-package-creator new folder_name --package_description="Example..." (Optional)
  • Option: php-package-creator new folder_name --psr4_namespace=Doe\John (Optional)
  • Option: php-package-creator new folder_name --force (Optional)
  • Option: php-package-creator new folder_name --laravel (Optional)

Change log

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email :author_email instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.