aheenam/laravel-package-cli

A small CLI to scaffold packages for Laravel framework

Laravel Package CLI

This project delivers a simple set of Console Commands to generate a directory structure for laravel package development., _(*1)

For example simply create the complete directory structure for a new package by calling laravel-package generate vendor/package-name, _(*2)

Installation

Install this command as a global composer package, _(*3)

$ composer global require aheenam/laravel-package-cli

Usage

You can then create a new repository by calling the following command:, _(*4)

$ laravel-package generate vendor/package-name

This command will create a directory named package-name and will setup a basic setup for creating a Laravel package., _(*5)

The directory structure will look like following:, _(*6)

├── database/
│   ├── .gitkeep
├── config/
│   ├── package-name.php
├── src/
│   ├── PackageNameServiceProvider.php
├── tests/
│   ├── TestCase.php
├── .gitignore
├── CHANGELOG.md
├── composer.json
├── LICENSE
├── phpunit.xml
├── README.md

All the files and classes will have set the correct names and namespaces, but remember that the generator is just creating a starting point. You should go through the files and add stuff that is missing., _(*7)

Pass a custom path

You can also pass an second argument specifying the path where the packages should be generated., _(*8)

$ laravel-package generate vendor/package-name packages/aheenam/

Above example would generate the package at ./packages/aheenam/packages-name. This can be handy if you want to use this generator within an existing Laravel project., _(*9)

The --force option

By default you will get an error notice if a directory with given package name already exists. You can ignore existing directories by using the --force flag:, _(*10)

$ laravel-package generate vendor/package-name --force

Install composer dependecies

Using the --install flag, you can enforce that, after the generation of the package is done, the command changes into the new directory and runs composer install to install the dependecies., _(*11)

Generate a LICENSE

You can pass an option to not only create an empty LICENSE file, but also populate it with the appropriate LICENSE content., _(*12)

$ laravel-package generate vendor/package-name --license=MIT

Currently there are 3 LICENSE types implemented: MIT, Apache 2.0 and GNU GPL v3. Just pass the names and you should get your LICENSE generated., _(*13)

Changelog

Check CHANGELOG for the changelog, _(*14)

Testing

To run tests use, _(*15)

$ composer test

If you are working on a windows machine use, _(*16)

vendor\bin\phpunit

Contributing

Information will follow soon, _(*17)

Security

If you discover any security related issues, please email rathes@aheenam.com or use the issue tracker of GitHub., _(*18)

About

Aheenam is a small company from NRW, Germany creating custom digital solutions. Visit our website to find out more about us., _(*19)

License

The MIT License (MIT). Please see License File for more information., _(*20)