www.aleph1.co.uk Git - yaffs-website/blob - vendor/drush/drush/docs/generators.md

   1 Overview
   2 ==========================
   3 Generators jump start your coding by building all the boring boilerplate code for you. After running a `drush generate [foo]` command, you have a guide for where to insert your custom logic.
   4
   5 Drush's generators reuse classes provided by the excellent [Drupal Code Generator](https://github.com/Chi-teck/drupal-code-generator) project. See its [Commands directory](https://github.com/Chi-teck/drupal-code-generator/tree/master/src/Command/Drupal_8) for inspiration.
   6
   7 Writing Custom Generators
   8 ==========================
   9 Drupal modules may supply their own Generators, just like they can supply Commands.
  10
  11 See [Woot module](https://github.com/drush-ops/drush/blob/master/tests/resources/modules/d8/woot), which Drush uses for testing. Specifically,
  12
  13   1. Write a class similar to [ExampleGenerator](https://github.com/drush-ops/drush/tree/master/tests/resources/modules/d8/woot/src/Generators/). Implement your custom logic in the interact() method. Typically this class is placed in the src/Generators directory.
  14   1. Add a .twig file to the same directory. This template specifies what gets output from the generator.
  15   1. Add your class to your module's drush.services.yml file ([example](https://github.com/drush-ops/drush/blob/master/tests/resources/modules/d8/woot/drush.services.yml)). Use the tag `drush.generator` instead of `drush.command`.
  16   1. Perform a `drush cache-rebuild` to compile your drush.services.yml changes into the Drupal container.
  17
  18 Global Generators
  19 ==============================
  20
  21 Generators that don't ship inside Drupal modules are called 'global' generators. In general, its better to use modules to carry your generators. If you still prefer using a global generator, please note:
  22
  23 1. The file's namespace should be `\Drush\Generators`.
  24 1. The filename must be have a name like Generators/FooGenerator.php
  25     1. The prefix `Foo` can be whatever string you want. The file must end in `Generator.php`
  26     1. The enclosing directory must be named `Generators`
  27 1. The directory above Generators must be one of:
  28     1.  A Folder listed in the 'include' option. include may be provided via config or via CLI.
  29     1.  ../drush, /drush or /sites/all/drush. These paths are relative to Drupal root.