add(colors): colored text in runtime

Author: andre-filho

commit_helper/conventions/no_convention.py

@@ -1,4 +1,8 @@
+from commit_helper.utils.colors import INPUT_COLOR
+from commit_helper.utils.colors import RESET
+
+
 def just_message():
-    msg = str(input("commit message: "))
+    msg = str(input(INPUT_COLOR + "commit message: " + RESET))
     composed = "%s\n" % msg.capitalize()
     return composed

commit_helper/utils/colors.py

@@ -0,0 +1,7 @@
+from colored import fg
+from colored import attr
+
+INPUT_COLOR = fg(6)
+NOTIFY_COLOR = fg(14)
+DEBUG_COLOR = fg(239)
+RESET = attr(0)

commit_helper/utils/file_handler.py

@@ -5,7 +5,10 @@
 from .utils import gen_co_author
 from .utils import dump_convention
 from .utils import validate_commiter_file
+from .colors import RESET
+from .colors import NOTIFY_COLOR
 from .text_utils import debug
+from .text_utils import notify
 from .text_utils import get_text
 from .text_utils import get_context
 # conventions imports
@@ -24,11 +27,11 @@ def handle_file_based_commit(file_path, debug_mode, args):
             convention = dump_convention(config)
 
             if convention == 'none':
-                print('You are not using a convention')
+                notify('You are not using a convention')
                 commit_msg = just_message()
 
             elif convention == 'custom':
-                print('You are using your custom convention')
+                notify('You are using your custom convention')
                 validate_commiter_file(config)
                 tag, msg = get_text()
                 commit_msg = custom_convention(tag, msg, config, debug_mode)
@@ -45,7 +48,7 @@ def handle_file_based_commit(file_path, debug_mode, args):
 
 
 def handle_conventioned_commit(convention):
-    print('You are using the %s convention' % convention)
+    notify('You are using the %s convention' % convention)
     tag, msg = get_text()
 
     if convention == 'angular' or convention == 'karma':

commit_helper/utils/text_utils.py

@@ -1,11 +1,18 @@
+from commit_helper.utils.colors import RESET
+from commit_helper.utils.colors import DEBUG_COLOR
+from commit_helper.utils.colors import INPUT_COLOR
+from commit_helper.utils.colors import NOTIFY_COLOR
+
+
 def get_text():
-    tag = str(input("type the tag: "))
-    msg = str(input("type the commit message: ")).lower()
+    tag = str(input(INPUT_COLOR + 'type the tag: ' + RESET))
+    msg = str(input(INPUT_COLOR + 'type the commit message: ' + RESET)).lower()
     return tag, msg
 
 
 def get_context():
-    context = str(input('type the context: ') or '').lower()
+    context = str(input(INPUT_COLOR + 'type the context: ' + RESET) or '')
+    context.lower()
     return context
 
 
@@ -15,6 +22,11 @@ def sanitize_as_empty_string(string):
     return string
 
 
+def notify(message):
+    print(NOTIFY_COLOR + str(message) + RESET)
+
+
 def debug(message, value, show=False):
     if show:
-        print("DEBUG-> %s: %s" % (message, value))
+        mid = 'DEBUG: ' + str(message) + ' ~> ' + str(value)
+        print(DEBUG_COLOR + mid + RESET)

test/test_utils.py

@@ -1,6 +1,9 @@
 import yaml
 import commit_helper.utils.utils as utils
 import commit_helper.utils.text_utils as text_utils
+from commit_helper.utils.colors import RESET
+from commit_helper.utils.colors import DEBUG_COLOR
+from commit_helper.utils.colors import NOTIFY_COLOR
 # from commit_helper.utils.utils import validate_commiter_file
 # import commit_helper.utils.file_handler as file_utils
 # import commit_helper.utils.flag_commit_handler as flag_utils
@@ -61,7 +64,7 @@ def test_gen_co_author():
 def test_debug(capsys):
     text_utils.debug('msg', 666, show=True)
     captured = capsys.readouterr()
-    if not captured.out == "DEBUG-> msg: 666\n":
+    if not captured.out == DEBUG_COLOR + "DEBUG: msg ~> 666" + RESET + "\n":
         raise AssertionError()
 
 
@@ -81,3 +84,10 @@ def test_dump_convention():
 
     if not response2 == 'asdf':
         raise AssertionError()
+
+
+def test_notify(capsys):
+    text_utils.notify('msg')
+    captured = capsys.readouterr()
+    if not captured.out == NOTIFY_COLOR + "msg" + RESET + "\n":
+        raise AssertionError()