Allow drush alias templates to be overridden

Author: oxyc

default.config.yml

@@ -96,6 +96,8 @@ drupalvm_cron_jobs: []
 # Drupal VM automatically creates a drush alias file in your ~/.drush folder if
 # this variable is 'true'.
 configure_drush_aliases: true
+drush_aliases_host_template: "templates/drupalvm.aliases.drushrc.php.j2"
+drush_aliases_guest_template: "templates/drupalvm-local.aliases.drushrc.php.j2"
 
 # Helper variable to configure the PHP-FPM connection for each Apache
 # VirtualHost in the `apache_vhosts` list.

docs/extras/drush.md

@@ -35,6 +35,22 @@ $ drush @drupalvm.dev status
 
 Drupal VM automatically generates a drush alias file in `~/.drush/drupalvm.aliases.drushrc.php` with an alias for every site you have defined in the `apache_vhosts` variable.
 
+If you want to customize the generated alias file you can override the `drush_aliases_host_template` and `drush_aliases_guest_template` variables in your `config.yml`.
+
+```yaml
+drush_aliases_host_template: "{{ config_dir }}/templates/drupalvm.aliases.drushrc.php.j2"
+```
+
+Eg. to only print the alias for your main domain, and not the subdomain you can override the file using a child template.
+
+```php
+{% extends 'templates/drupalvm.aliases.drushrc.php.j2' %}
+
+{% block aliases %}
+{{ alias('drupalvm.dev', drupal_core_path) }}
+{% endblock %}
+```
+
 You can disable Drupal VM's automatic Drush alias file management if you want to manage drush aliases on your own. Just set the `configure_drush_aliases` variable in `config.yml` to `false`.
 
 ## Using sql-sync

provisioning/tasks/drush-aliases.yml

@@ -18,7 +18,7 @@
 # Note that this doesn't work for Windows, since Ansible's running in the VM.
 - name: Configure host machine drush aliases.
  template:
- src: ../templates/drupalvm.aliases.drushrc.php.j2
+ src: "{{ drush_aliases_host_template }}"
  dest: "~/.drush/{{ vagrant_machine_name }}.aliases.drushrc.php"
  delegate_to: 127.0.0.1
  become: no
@@ -30,7 +30,7 @@
 
 - name: Configure drush aliases for vagrant user inside VM.
  template:
- src: ../templates/drupalvm-local.aliases.drushrc.php.j2
+ src: "{{ drush_aliases_guest_template }}"
  dest: "~/.drush/{{ vagrant_machine_name }}.aliases.drushrc.php"
  become: no
  when: configure_drush_aliases
@@ -40,6 +40,6 @@
 
 - name: Configure drush aliases for root user inside VM.
  template:
- src: ../templates/drupalvm-local.aliases.drushrc.php.j2
+ src: "{{ drush_aliases_guest_template }}"
  dest: "~/.drush/{{ vagrant_machine_name }}.aliases.drushrc.php"
  when: configure_drush_aliases

provisioning/templates/drupalvm-local.aliases.drushrc.php.j2

@@ -16,6 +16,7 @@ $aliases['{{ host }}'] = array(
 {% endif -%}
 {% endmacro %}
 
+{% block aliases -%}
 {%- if drupalvm_webserver == 'apache' -%}
  {%- for vhost in apache_vhosts -%}
  {{ alias(vhost.servername, vhost.documentroot) }}
@@ -32,3 +33,4 @@ $aliases['{{ host }}'] = array(
  {%- endfor -%}
  {%- endfor -%}
 {%- endif -%}
+{% endblock %}

provisioning/templates/drupalvm.aliases.drushrc.php.j2

@@ -22,6 +22,7 @@ $aliases['{{ host }}'] = array(
 {% endif -%}
 {% endmacro %}
 
+{% block aliases -%}
 {%- if drupalvm_webserver == 'apache' -%}
  {%- for vhost in apache_vhosts -%}
  {{ alias(vhost.servername, vhost.documentroot) }}
@@ -38,3 +39,4 @@ $aliases['{{ host }}'] = array(
  {%- endfor -%}
  {%- endfor -%}
 {%- endif -%}
+{% endblock %}