diff --git a/plugins/drush/README.md b/plugins/drush/README.md index 958a575d..25813532 100644 --- a/plugins/drush/README.md +++ b/plugins/drush/README.md @@ -1,31 +1,68 @@ -# Drush plugin # +# Drush -## Description ## +## Description This plugin offers aliases and functions to make the work with drush easier and more productive. -## How to use ## +To enable it, add the `drush` to your `plugins` array in `~/.zshrc`: + +```zsh +plugins=(... drush) ``` -# Aliases, sorted alphabetically. -drca #Clear all drupal caches. -drcb #Clear block cache. -drcg #Clear registry cache. -drcj #Clear css-js cache. -drcm #Clear menu cache. -drcml #Clear module-list cache. -drcr #Run all cron hooks in all active modules for specified site. -drct #Clear theme-registry cache. -drcv #Clear views cache. -drif #Flush all derived images. -drpm #Show a list of available modules. -drst #Provides a birds-eye view of the current Drupal installation, if any. -drup #Apply any database updates required (as with running update.php). -drups #List any pending database updates. -drv #Show drush version. + +## Aliases +| Alias | Description | Command | +|-------|-----------------------------------------------------------------------|-----------------------------| +| drca | Clear all drupal caches. | drush cc all | +| drcb | Clear block cache. | drush cc block | +| drcg | Clear registry cache. | drush cc registry | +| drcj | Clear css-js cache. | drush cc css-js | +| drcm | Clear menu cache. | drush cc menu | +| drcml | Clear module-list cache. | drush cc module-list | +| drcr | Run all cron hooks in all active modules for specified site. | drush core-cron | +| drct | Clear theme-registry cache. | drush cc theme-registry | +| drcv | Clear views cache. (Make sure that the views module is enabled) | drush cc views | +| drif | Flush all derived images. | drush image-flush --all | +| drpm | Show a list of available modules. | drush pm-list --type=module | +| drst | Provides a birds-eye view of the current Drupal installation, if any. | drush core-status | +| drup | Apply any database updates required (as with running update.php). | drush updatedb | +| drups | List any pending database updates. | drush updatedb-status | +| drv | Show drush version. | drush version | + + +## Functions + +### dren +Download and enable one or more extensions (modules or themes). +Must be invoked with one or more parameters. e.g.: +`dren devel` or `dren devel module_filter views` + +### drf +Edit drushrc, site alias, and Drupal settings.php files. +Can be invoked with one or without parameters. e.g.: +`drf 1` + +### dris +Disable one or more extensions (modules or themes) +Must be invoked with one or more parameters. e.g.: +`dris devel` or `dris devel module_filter views` + +### drpu +Uninstall one or more modules. +Must be invoked with one or more parameters. e.g.: +`drpu devel` or `drpu devel module_filter views` + +## Additional features + +### Autocomplete +The [completion script for drush](https://github.com/drush-ops/drush/blob/8.0.1/drush.complete.sh) comes enabled with this plugin. +So, it is possible to type a command: ``` +drush sql ``` -# Functions, sorted alphabetically. -dren #Download and enable one or more extensions (modules or themes). -drf #Edit drushrc, site alias, and Drupal settings.php files. Can be called with a parameter e.g.: drf 2 -dris #Disable one or more extensions (modules or themes). -drpu #Uninstall one or more modules. + +And as soon as the tab key is pressed, the script will display the available commands: +``` +drush sql +sqlc sql-conf sql-create sql-dump sql-query sql-sanitize +sql-cli sql-connect sql-drop sqlq sqlsan sql-sync ``` diff --git a/plugins/drush/drush.plugin.zsh b/plugins/drush/drush.plugin.zsh index c473c4ca..381107e5 100644 --- a/plugins/drush/drush.plugin.zsh +++ b/plugins/drush/drush.plugin.zsh @@ -39,12 +39,12 @@ alias drcml="drush cc module-list" alias drcr="drush core-cron" alias drct="drush cc theme-registry" alias drcv="drush cc views" +alias drif="drush image-flush --all" alias drpm="drush pm-list --type=module" alias drst="drush core-status" alias drup="drush updatedb" alias drups="drush updatedb-status" alias drv="drush version" -alias drif="drush image-flush --all" # Enable drush autocomplete support autoload bashcompinit