Drupal-console: Use chain as actual command

[itsdarrylnorris]

Problem / Motivation

We need to add the ability using chain as extension for the DrupalConsole commands. This can be very help to extend the drupal list from the chain commands.

Why ?

This is a nice way to easily integrate DC with other projects without need of writing any code or hacking DC to extend their functionality.

Solution

We can add two extra parameters to define the group and the command.

group-chain: bestgroup
  command: bestcommand
  chain-url: projectname/chain/chain-name.yml

Then in drupal list we are going to be able to see an extention like this

  bestgroup:bestcommand

And the user will be able to type drupal bestgroup:bestcommand and it will simulate this drupal chain --file=~/drupal/modules/projectname/chain/chain-name.yml

[jmolivas]

@darol100 like the idea, is this kinda like drush shell aliases?

[itsdarrylnorris]

I'm not 100% sure if what is exactly you are referring too..

drush shell aliases

But Drush does something very similar, there are many contrib projects that carry drush command which is very handling because extend the functionality of the Drush commands. They have this hook hook_drush_command which allows you to define your own commands.

So the goal of this issue is to be able to write DC commands base of chain pre-config information that can be extend drupal list

[jmolivas]

Since we already wrote the auto-discovery of chain files on ~/.console/chain/ directory and actually is used on chain:debug command.

I re-use that discovery feature to added to chain when not --file option is passed by the user.

[jmolivas]

This is how the execution looks like:

[jmolivas]

Based on how the current configuration for commands is handled, we can add something like this to the YAML files in order to discover and register them as commands.

• Discovering YAML file as command:

command:
  name: casper:config
  description: Import casper Manage Form and Manage Display configuration.

[jmolivas]

I merged the discovery feature on the interactive mode PR => https://github.com/hechoendrupal/DrupalConsole/pull/2068

[kenneth-bolivar-castro]

It's a great improvement, I haven't check how [drupal:chain] is working right now, but it would be lovely if I could add a YAML file with my commands into my root project, then It will be able to be manage by control version, then discovering process gets smart enough to grab it and exposes it as an option while I execute chain command even chain:debug.

Perhaps, if we define another path to discover those commands into D8 installation, or remove "--file" parameter and define it as first argument. does it make sense?
CC: @jmolivas

[jmolivas]

@kenneth-bolivar-castro we got you covered, the chain command search for YAML files at:

• User home directory ~/.console/chain
• Site root directory /path/to/d8.dev/console/chain/
• Module directory
  
  
  
  • /path/to/d8.dev/custom/module_name/console/chain/
  
  
  • /path/to/d8.dev/contrib/module_name/console/chain/
  
  

[kenneth-bolivar-castro]

Awesome! @jmolivas Drupal Console rocks! :+1:

[kenneth-bolivar-castro]

@jmolivas I'm running Drupal Console version 0.11.2, I just added "console/chain" folder structure on my root project, also I rebuild all caches, however I can't see YAML file yet, am I missing anything?

[jmolivas]

@kenneth-bolivar-castro Yes try updating to 0.11.3 if you site is 8.0.x or 1.0.0-apha1 if your site is 8.1.x

[kenneth-bolivar-castro]

@jmolivas looks like it isn't available yet,

$ drupal self-update
Checking for updates from version: 0.11.2
 The latest version 0.11.2, was already installed on your system.

[jmolivas]

@kenneth-bolivar-castro try this instead

$ curl https://github.com/hechoendrupal/DrupalConsole/releases/download/0.11.3/drupal.phar -L -o drupal.phar

[kenneth-bolivar-castro]

@jmolivas great! thx now it's up and running! :+1:

[jmolivas]

👍 on this feature

[novia713]

@darol100 if you're busy these days, i would like to contribute to this issue with some of my (few) time.
my problem is i have no idea on how to accomplish this. if you have some ideas to enlighten this task, please provide them to me. i will try to do my best.

[jmolivas]

This PR https://github.com/hechoendrupal/DrupalConsole/pull/2953 from @marcelovani address this.

[jmolivas]

Completed with this other PRs
https://github.com/hechoendrupal/drupal-console-core/pull/97
https://github.com/hechoendrupal/DrupalConsole/pull/2989
https://github.com/hechoendrupal/DrupalConsole/pull/2990

To make a chain file automatically registered as command this new block of meta-data should be added on to the file.

command:
  name: site:setup
  description: Setup site

Complete file

command:
  name: site:setup
  description: Setup site
commands:
  - command: site:install
    arguments:
      profile: standard
    options:
      force: true
      no-interaction: true
  - command: cache:rebuild
    arguments:
      cache: all

[jmolivas]

cc: @darol100 @kenneth-bolivar-castro @novia713

[itsdarrylnorris]

w00T... Good work guys...