shomisha / laravel-console-wizard

Laravel Console Wizard is a library for creating multi-step wizards using Laravel's Artisan CLI tool.

Laravel Console Wizard

This package provides a basis for creating multi-step wizards with complex input inside the console. It is best used for customising generator command output, but can be used for handling any sort of tasks.

<?php

namespace App\Console\Commands;

use Shomisha\LaravelConsoleWizard\Command\Wizard;
use Shomisha\LaravelConsoleWizard\Steps\ChoiceStep;
use Shomisha\LaravelConsoleWizard\Steps\TextStep;

class IntroductionWizard extends Wizard
{
    protected $signature = "wizard:introduction";

    protected $description = 'Introduction wizard.';

    public function getSteps(): array
    {
        return [
            'name'   => new TextStep("What's your name?"),
            'age'    => new TextStep("How old are you?"),
            'gender' => new ChoiceStep("Your gender?", ["Male", "Female"]),
        ];
    }

    public function completed()
    {
        $this->line(sprintf(
            "This is %s and %s is %s years old.",
            $this->answers->get('name'),
            ($this->answers->get('gender') === 'Male') ? 'he' : 'she',
            $this->answers->get('age')
        ));
    }
}

The example above shows a simple example of how you can create a wizard with several input prompts and then perform actions using the answers provided by the user. Running php artisan wizard:introduction in your console would execute the above wizard and produce the following output:

shomisha:laravel-console-wizard shomisha$ php artisan wizard:introduction

 What's your name?:
 > Misa

 How old are you?:
 > 25

 Your gender?:
  [0] Male
  [1] Female
 > 0

This is Misa and he is 25 years old.

Take a look at our wiki pages for more instructions and other Wizard features.

laravel-console-wizard's Issues

Using In a Package

Hey there, this is a great package. I'm attempting to include it in a package I have that has a ton of generators, but it doesn't seem to be finding the classes.

I noticed the ServiceProvider only provides the GenerateWizardWizard command so I skipped loading that and just loaded that command into my GeneratorServiceProvider.

It works fine from inside a Laravel app via a generated console command, but when I call a command from my package I get an error that the $answer property doesn't exist:

Undefined property: MyPackage\Console\Commands\ScaffoldMakeCommand::$answer

Very strange, the steps work fine, it loads, asks all the questions perfectly, then blows up.

Any ideas?

why not support 7.3 with polyfill?

Still many people use php 7.3 as that is the laravel's required version,
so it would be better if you can support php7.3 using polyfill

thanks.

Feature request: skip step if argument is provided

I very often use trait like this in my projects

<?php

namespace App\Console\Traits;

trait ArgumentOrAsk
{

    public function argumentOrAsk($name, $question = null, $default = null)
    {
        $argument = $this->argument($name);

        if (!empty($argument)) {
            return $argument;
        }

        return $this->ask($question ?? $name, $default);
    }
}

and I think it would be great if step could read value from arguments and maybe even ask that value again if validation rules fail

Generator Wizard Options

Okay, I have a genuine issue now that I'd like to figure out how to resolve.

All of the wizards in my package will be generators. So I've discovered I need to extend the GeneratorWizard class for this. Most of them will work fine as is since they are creating a named file. But I have a couple that don't create an actual class, they just call other generator commands.

For instance my ScaffoldMakeCommand I referenced in that previous issue. I moved the the first step into the getNameStep which works as expected, then moved my build calls from completed into generateTarget and those all run and generate all the files as expected.

The one exception here is that an extra empty file is created based on the input from getNameStep.

For example, here is my getNameStep:

public function getNameStep(): Step
{
  return new TextStep('What namespace would you like to create?');
}

This sets a namespace to then generate a bunch of files within that directory. So let's say I want to create a Countries namespace.

I go through the wizard answering all the steps:

public function getSteps(): array
{
  return [
    'visibility' => new ChoiceStep('What visibility should the namespace have?', [
      'Public', 'Protected', 'Private', 'API',
    ]),
    'actions' => new UniqueMultipleChoiceStep('Select all the actions to create for your namespace', [
      'Index', 'Create', 'Show', 'Store', 'Edit', 'Update', 'Delete', 'Restore', 'Destroy',
    ], [
      'end_keyword' => 'done',
      'retain_end_keyword' => false,
    ]),
    'model' => new TextStep('Enter the name of the Model to use for this namespace'),
    'repository' => new ConfirmStep('Would you like a repository?'),
    'observer' => new ConfirmStep('Do you need an Observer?'),
  ];
}

Then all the files requested are created, and at the end I get an empty file at:

app/Countries.php

Is there a way I can stop this file from being created? In my previous command which just extended GeneratorCommand this did not get created because I left the getStub method empty. I did that here too but it still gets created, I'm guessing maybe from the parent::handle() call in GeneratorWizard?

Any thoughts would be helpful.

Thanks again for the great package.