Merge pull request #35 from orestisf1993/master

Add option to abort when alias can be used

Author: djui

README.md

@@ -157,6 +157,21 @@ export ZSH_PLUGINS_ALIAS_TIPS_EXPAND=0
 ```
 
 
+### Force Alias Use
+
+If you want to force yourself to use the aliases you set you can enable this
+option through this environmental variable:
+
+```
+:
+export ZSH_PLUGINS_ALIAS_TIPS_FORCE=1
+:
+```
+
+This will make alias-tips to abort the command you have entered if there exists
+an alias for it.
+
+
 # Limitations
 
 - *Suffix* and *Global* aliases are currently not supported. Only *Prefix*

alias-tips.plugin.zsh

@@ -27,8 +27,12 @@ _alias_tips__preexec () {
 
   shell_functions=$(functions | grep '^[a-zA-Z].\+ () {$')
 
+  # Exit code returned from python script when we want to force use of aliases.
+  local force_exit_code=10
   echo $shell_functions "\n" $git_aliases "\n" $shell_aliases | \
     python ${_alias_tips__PLUGIN_DIR}/alias-tips.py $*
+  ret=$?
+  if [[ $ret = $force_exit_code ]]; then exit $force_exit_code; fi
 }
 
 autoload -Uz add-zsh-hook

alias-tips.py

@@ -3,6 +3,8 @@
 import os
 import sys
 
+FORCE_EXIT_CODE = 10
+
 
 def format_tip(s, prefix):
     color_blue_normal = '\033[94m'
@@ -92,6 +94,7 @@ def main(args):
     prefix   = os.getenv('ZSH_PLUGINS_ALIAS_TIPS_TEXT', 'Alias tip: ')
     expand   = os.getenv('ZSH_PLUGINS_ALIAS_TIPS_EXPAND', '1') == '1'
     excludes = os.getenv('ZSH_PLUGINS_ALIAS_TIPS_EXCLUDES', '')
+    force    = os.getenv('ZSH_PLUGINS_ALIAS_TIPS_FORCE', '0') == '1'
     input    = args[0].strip()  # Other args are resolved aliases
     als, fns = split(sys.stdin.readlines())
 
@@ -105,6 +108,8 @@ def main(args):
 
     if len(alias) < len(input) and alias != input:
         print(format_tip(alias, prefix))
+        if force:
+            sys.exit(FORCE_EXIT_CODE)
     else:
         sys.exit(1)
 

test_alias-tips.py

@@ -8,11 +8,21 @@
 
 
 def run_blackboxed(args, aliases):
-    p = subprocess.Popen(['python', './alias-tips.py', args], stdout=PIPE, stdin=PIPE, stderr=PIPE)
+    p = run_process(args)
     stdout, _ = p.communicate(input=aliases.encode())
     return stdout
 
 
+def run_blackboxed_exit_code(args, aliases):
+    p = run_process(args)
+    stdout, _ = p.communicate(input=aliases.encode())
+    return stdout, p.returncode
+
+
+def run_process(args):
+    return subprocess.Popen(['python', './alias-tips.py', args], stdout=PIPE, stdin=PIPE, stderr=PIPE)
+
+
 class TestAliasTipFormatting(TestCase):
     def test_no_prefix(self):
         self.assertEqual(alias_tips.format_tip('foo', ''), '\x1b[94m\x1b[1;94mfoo\x1b[0m')
@@ -159,3 +169,13 @@ def test_expand_env(self):
         self.assertEqual(run_blackboxed('gR -v',          'gRv=\'git remote -v\'\ngR=\'git remote\''), b'\x1b[94m\x1b[1;94mgRv\x1b[0m\n')
         self.assertEqual(run_blackboxed('gR -v -foo',     'gRv=\'git remote -v\'\ngR=\'git remote\''), b'\x1b[94m\x1b[1;94mgRv -foo\x1b[0m\n')
         self.assertEqual(run_blackboxed('g status -sb',   'g=\'git\'\ngit st = git status -sb'),       b'\x1b[94m\x1b[1;94mg st\x1b[0m\n')
+
+    def test_force_abort(self):
+        os.putenv('ZSH_PLUGINS_ALIAS_TIPS_FORCE', '1')
+        os.putenv('ZSH_PLUGINS_ALIAS_TIPS_TEXT', '')
+        stdout, returncode = run_blackboxed_exit_code('foo', 'b=foo')
+        self.assertEqual(returncode, alias_tips.FORCE_EXIT_CODE)
+        self.assertEqual(stdout, b'\x1b[94m\x1b[1;94mb\x1b[0m\n')
+        stdout, returncode = run_blackboxed_exit_code('foo', '')
+        self.assertNotEqual(returncode, alias_tips.FORCE_EXIT_CODE)
+        self.assertEqual(stdout, b'')