joshralph/quick-gen

A laravel generators package.

(Work in progress)

Only currently actively tested with Laravel 5.4. Previous version support to come..., _(*1)

Contribution welcome., _(*2)

Installation

Pull in the package using composer, _(*3)

$ composer require joshralph/quick-gen "dev-master" --dev

Include the service provider within /config/app.php, _(*4)

QuickGen\Providers\GeneratorServiceProvider::class,

Getting Started

You will need to run the command below to publish the stub files that ship with the package., _(*5)

php artisan vendor:publish --tag=stubs

To run the generator run the below command. The example resource name given below should be replaced as you need., _(*6)

php artisan quick-gen:generate cars

Templates

The package ships with a standard CRUD template that you can use to generate basic CRUD functionality., _(*7)

To specify which template you wish to use, add the template flag to the command., _(*8)

crud (default)

This template will generate the following files for you within the standard laravel directory structure:, _(*9)

• Controller
• Model
• Views
  • index.blade.php
  • create.blade.php
  • edit.blade.php
  • partials/list.blade.php
  • partials/form.blade.php

Custom Templates

Of course you will likely want to create your own template files that are in keeping with your current view structure, and coding style., _(*10)

To create a new template simply create a new folder within the resources/stubs/ directory. The folder name should be used when setting the --template argument., _(*11)

You can then call the command below using the --template argument, _(*12)

php artisan quick-gen:generate cars --template=my-template

Stub Syntax

Note all stub files should end in .stub, _(*13)

Variables

The following variables are made available to stub files (both content and filename):, _(*14)

name - The name of the resource as specified in the generate command, _(*15)

baseNamespace - The namespace where the generated files will reside., _(*16)

...and should be wrapped in the following way:, _(*17)

Stub Contents, _(*18)

namespace <<baseNamespace>>\Http\Controllers\Admin;

Filename, _(*19)

__name__Controller.php.stub

Filters

You may wish to transform the case and formatting of variables within stub files. These can be used both within the file contents and the filename., _(*20)

Filters can be added to variables using a . delimiter., _(*21)

@foreach ($<<name.camel.plural>> as $<<name.camel.singular>>)
    <tr>
        <td>{{ $<<name.camel.singular>>->name }}</td>
    </tr>
@endforeach

The following filters are available:, _(*22)

camel - convert the variable to camel case., _(*23)

studly - convert the variable to studly case., _(*24)

snake - convert the variable to snake case., _(*25)

plural - convert the variable to plural., _(*26)

singular - convert the variable to singular., _(*27)

lower - convert the variable to lowercase., _(*28)

ucwords - upper case the first letter of each word in the variable (see words)., _(*29)

words - convert the variable to space delimited words, _(*30)

Limitations

• The default template doesn't currently update routes files. These will need to be mapped manually: