From 79d0182a2666a98f04bd0d731012ce97114c1ef1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marc=20Cornell=C3=A0?= <marc.cornella@live.com>
Date: Thu, 10 Dec 2020 20:38:19 +0100
Subject: [PATCH] refactor(hanami): change global aliases and clean up README

---
 plugins/hanami/README.md         | 61 +++++++++++++++++++-------------
 plugins/hanami/hanami.plugin.zsh |  6 ++--
 2 files changed, 40 insertions(+), 27 deletions(-)

diff --git a/plugins/hanami/README.md b/plugins/hanami/README.md
index 3ac8defbb..c9e09f4f2 100644
--- a/plugins/hanami/README.md
+++ b/plugins/hanami/README.md
@@ -1,32 +1,45 @@
-# Hanami Plugin #
-This plugin adds convenient ways to work with [Hanami](https://hanamirb.org/) via console.
+# Hanami Plugin
+
+This plugin adds convenient aliases to work with [Hanami](https://hanamirb.org/) via console.
 It's inspired by Rails plugin, so if you've used it, you'll feel like home.
 
-## Usage ##
+To use it, add `hanami` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... hanami)
+```
+
+## Usage
 
 For example, type `hc` into your console when you're within Hanami project directory to run
 the application console. Have a look at available shortcuts below. You can read more about
 these commands [on the official website](https://hanamirb.org/guides/command-line/applications/).
 
-## Aliases ##
+## Aliases
 
-| Alias | Command                   | Description                                             |
-|-------|---------------------------|---------------------------------------------------------|
-| HED   | HANAMI_ENV=development    | Set environment variable HANAMI_ENV to development      |
-| HEP   | HANAMI_ENV=production     | Set environment variable HANAMI_ENV to production       |
-| HET   | HANAMI_ENV=test           | Set environment variable HANAMI_ENV to test             |
-| hc    | hanami console            | Run application console                                 |
-| hd    | hanami destroy            | Remove specified hanami resource                        |
-| hg    | hanami generate           | Create specified hanami resource                        |
-| hgm   | hanami generate migration | Create migration file                                   |
-| hs    | hanami server             | Launch server with hanami application                   |
-| hsp   | hanami server -p          | Launch server with specified port                       |
-| hr    | hanami routes             | List application routes                                 |
-| hdc   | hanami db create          | Create application database                             |
-| hdd   | hanami db drop            | Delete application database                             |
-| hdp   | hanami db prepare         | Prepare database for the current environment            |
-| hda   | hanami db apply           | Recreates a fresh schema after migrations (destructive) |
-| hdv   | hanami db version         | Print current database version                          |
-| hdrs  | hdd && hdp                | Drop and recreate application database                  |
-| hdtp  | HET hdp                   | Actualize test environment database                     |
-| hrg   | hr &#124; grep            | Grep hanami routes with specified pattern               |
+| Alias | Command                     | Description                                             |
+|-------|-----------------------------|---------------------------------------------------------|
+| HED\* | `HANAMI_ENV=development`    | Set environment variable HANAMI_ENV to development      |
+| HEP\* | `HANAMI_ENV=production`     | Set environment variable HANAMI_ENV to production       |
+| HET\* | `HANAMI_ENV=test`           | Set environment variable HANAMI_ENV to test             |
+| hc    | `hanami console`            | Run application console                                 |
+| hd    | `hanami destroy`            | Remove specified hanami resource                        |
+| hg    | `hanami generate`           | Create specified hanami resource                        |
+| hgm   | `hanami generate migration` | Create migration file                                   |
+| hs    | `hanami server`             | Launch server with hanami application                   |
+| hsp   | `hanami server -p`          | Launch server with specified port                       |
+| hr    | `hanami routes`             | List application routes                                 |
+| hdc   | `hanami db create`          | Create application database                             |
+| hdd   | `hanami db drop`            | Delete application database                             |
+| hdp   | `hanami db prepare`         | Prepare database for the current environment            |
+| hda   | `hanami db apply`           | Recreates a fresh schema after migrations (destructive) |
+| hdv   | `hanami db version`         | Print current database version                          |
+| hdrs  | `hdd && hdp`                | Drop and recreate application database                  |
+| hdtp  | `HET hdp`                   | Actualize test environment database                     |
+| hrg   | `hr | grep`                 | Grep hanami routes with specified pattern               |
+
+\* You should use these at the beginning of a command, for example:
+
+```console
+$ HED hdd # equivalent to 'HANAMI_ENV=development hanami db drop'
+```
diff --git a/plugins/hanami/hanami.plugin.zsh b/plugins/hanami/hanami.plugin.zsh
index 349c42cae..42143b428 100644
--- a/plugins/hanami/hanami.plugin.zsh
+++ b/plugins/hanami/hanami.plugin.zsh
@@ -1,6 +1,6 @@
-alias -g HED='HANAMI_ENV=development'
-alias -g HEP='HANAMI_ENV=production'
-alias -g HET='HANAMI_ENV=test'
+alias HED='HANAMI_ENV=development '
+alias HEP='HANAMI_ENV=production '
+alias HET='HANAMI_ENV=test '
 
 alias hc='hanami console'
 alias hd='hanami destroy'