How to create ConsoleCommand?

[popovserhii]

All work just fine, I can generate a module with Controller, Model and etc, but now I need to create a console command in my module. How can I do it?

[Artem-Schander]

Hi @popovserhii for now there is no generator and no custom registration for module commands. But it would be a useful improvement. Feel free to create a PR. Otherwise wait till I find some time to implement it.

[popovserhii]

If you'll explain how or give some resource where I can read about it, then I check if I could do it.

[Artem-Schander]

Ok, there are three different aspects to cover:

1. A make command must be implemented
2. The module service provider needs to look into the configured console commands folder and register the commands if it finds some.
3. The configuration

The make command You could extend the ConsoleMakeCommand. You can see some examples in the src/Console folder. Take note, there is a MakesComponent trait. It handles almost al the stuff that differs to the original make commands.

Besides that there is the artisan make:module command, which should also generate a console command, if configured so.

Registering the existing commands The registerModule method is called for every module. There needs to be something like $this->registerConsoleCommands($name). I don't know yet how to register console commands, but the first google search looks like it should be possible.

Configuration In the config/modules.php are two arrays where the new component must be present. Within generate to let the user decide wether a console command should be generated with the artisan module:make command or not. And within default.structure to let the user decide where the console commands needs to be placed (and also for the service provider)

Please let me know, if you decide to give the implementation a go. So that we don't work on it simultaneously.

[Artem-Schander]

I forgot to mention, everything must be covered with unit tests / integration tests and should have no code smells, repetition, etc. (according to Code Climate)

[juliomotol]

I didn't thought anyone would do this so i didn't included it. If I may add, place the generated command in this directory.

laravel-project/
    app/
    └── Modules/
        └── FooBar
            ├── Console
            │   └── FooBarCommand.php // generate the command here
            ├── Http
            │   └── Controllers
            │       └── FooBarController.php
            ├── Models
            │   └── FooBar.php
            ├── resources
            │   ├── lang
            │   │   └── en.php
            │   └── views
            │       └── welcome.blade.php
            └── routes
                ├── api.php
                └── web.php