jackiedo/workbench

Bring workbench back to Laravel 5.

As of July 1 2020, Laravel Workbench is no longer maintained., _(*1)

It will still exist as an archive, but it will not be taken care of, resolve issues and no new releases will be released in the future., _(*2)

Because the versions of the package have been fragmented, at the same time its features are no longer useful and suitable for modern Laravel versions, I decided to stop developing for it. Instead, I built another more efficient package called Laravel Packager and put energy into it., _(*3)

— Jackie Do, _(*4)

Laravel Workbench

, _(*5)

Laravel Workbench (originally from Laravel 4.x, has now stopped growing) support our in building perfect structured packages for Laravel without spending a lot of time., _(*6)

This package was created to bring Laravel Workbench back to Laravel 5+ and higher. Let this package support you in every detail through it's powerful features., _(*7)

Features

• Build directory structure for package.
• Generate a standard composer.json file for package.
• Generate a standard Service Provider file for package.
• Generate some scaffold resources file, such as:
  • Facade files
  • Interface files
  • Abstract files
  • Exception files
  • Controller files
  • Middleware files
  • Model files
  • Artisan CLI files
  • Configuration file
  • Migration files
  • Language files
  • View files
  • Route file
  • Helper file
  • ...
• Autoload dumping to be able to use your package immediately (by adding Service Provider of your package into providers section in config/app.php file or using discovery package feature through extra/laravel section in composer.json file).

Overview

Look at one of the following topics to learn more about Laravel Workbench, _(*8)

• Versions and compatibility
• Installation
• Usage
• Screenshot
• Configuration
• Other documentation

Versions and compatibility

Each branch of Laravel Workbench is similarities with each version of Laravel 5+. Currently, this package supports the following versions of Laravel:, _(*9)

In each branch we have multiple versions, tagged syntax as 5.0.*, 5.1.*, 5.2.*..., _(*10)

Installation

Step 1 - Install this package through Composer., _(*11)

Run the composer require command from the terminal on your project source:, _(*12)

$ composer require jackiedo/workbench:{{laravel-version}}.*

Note: The {{laravel-version}}.* string above is main version of Laravel that you want to install Laravel Workbench on it. Example, if you want to install this package on Laravel 5.6, you have to set require is jackiedo/workbench:5.6.*, _(*13)

Step 2 - Add mechanism to autoload service provider (for Laravel 5.4 or earlier only)., _(*14)

Open config/app.php file, and add a new item to the providers array:, _(*15)

...
'providers' => array(
    ...
    Jackiedo\Workbench\WorkbenchServiceProvider::class,
),

Note: If we are using Laravel version 5.5 or later, with the feature Discovery Packages, we can skip above step., _(*16)

Step 3 - Publish the configuration file., _(*17)

From the terminal on your project source, run the command as follow:, _(*18)

$ php artisan vendor:publish --provider="Jackiedo\Workbench\WorkbenchServiceProvider" --force

Note: You should use --force option in publish command to override configuration file with newest one., _(*19)

Step 4 - Register the workbench package loaders., _(*20)

Open the bootstrap/app.php file at the root of Laravel project and put this following code at the very top of script (after the PHP open tag):, _(*21)

<?php

/*
|--------------------------------------------------------------------------
| Register The Workbench Loaders
|--------------------------------------------------------------------------
|
| The Laravel workbench provides a convenient place to develop packages
| when working locally. However we will need to load in the Composer
| auto-load files for the packages so that these can be used here.
|
*/

if (is_dir($workbench = __DIR__.'/../workbench'))
{
    Jackiedo\Workbench\Starter::autoload($workbench);
}

Step 5 - Add mechanism to auto discover workbench packages (for Laravel 5.5 or later only)., _(*22)

In this final step, if we are using Laravel version 5.5 or later, we should to add the feature Auto Discover Workbench Packages into post-autoload-dump section in composer.json file of our Laravel project., _(*23)

Open composer.json file, and add the line @php artisan workbench:discover after the line @php artisan package:discover as follow:, _(*24)

"post-autoload-dump": [
    ...
    "@php artisan package:discover",
    "@php artisan workbench:discover"
]

Note: If we are using Laravel version 5.4 or earlier, we do not perform the above step., _(*25)

Usage

Now, you can use workbench commands to create your packages same as on Laravel 4.2., _(*26)

Note: Before you create a package, you should to update name and email config value in your config/workbench.php file., _(*27)

Creating a basic package.

Syntax:, _(*28)

$ php artisan workbench:make vendor/name

Note: The vendor/name string above is the form of your package name. Example: jackiedo/demo-package, _(*29)

Creating a package with generating some scaffold resources.

Syntax:, _(*30)

$ php artisan workbench:make vendor/name --resources

Dump autoloader for all workbench packages

During the process of building your package, every time you generate a new class, file or change the composer.json file of package, you should rebuild the autoloader for the package through the following command:, _(*31)

$ php artisan workbench:dump-autoload

Manual discover workbench packages

During the process of building your package, every time you change the extra/laravel section in composer.json file of your package, you should rebuild cached through the following command:, _(*32)

$ php artisan workbench:discover

Or you can use the composer dump-autoload command, because we add above command into post-autoload-dump section in composer.json file of Laravel project during the installation process., _(*33)

Delete an existing workbench package

Syntax:, _(*34)

$ php artisan workbench:delete vendor/name

Screenshot

Create package without generating scaffold resources., _(*35)

, _(*36)

Create package with generating scaffold resources., _(*37)

, _(*38)

Create package with generating scaffold resources and point PSR-4 autoloading namespace to the src directory., _(*39)

, _(*40)

Configuration

All details are provided in your config/workbench.php as comments (you have to run Artisan vendor:publish command before). Please read carefully before use., _(*41)

Other documentation

For more documentation about package development, you can visit Official Laravel Documentation pages:, _(*42)

• Laravel 4.2 Package Development
• Laravel 5.0 Package Development
• Laravel 5.1 Package Development
• Laravel 5.2 Package Development
• Laravel 5.3 Package Development
• Laravel 5.4 Package Development
• Laravel 5.5 Package Development
• Laravel 5.6 Package Development