add(flag support): support to --no-generate and --convention

Co-authored-by:

Author: andre-filho

conventions/changelog.py

@@ -3,7 +3,7 @@
 from utils import change_if_none
 
 
-def changelog_convention(co_author):
+def changelog_convention(co_author=''):
     tag, msg = get_text()
     tag = tag.upper()
     co_author = change_if_none(co_author)

conventions/karma_angular.py

@@ -3,7 +3,7 @@
 from utils import change_if_none
 
 
-def angular_convention(co_author):
+def angular_convention(co_author=''):
     tag, msg, context = get_text(context=True)
     tag = tag.lower()
     co_author = change_if_none(co_author)

conventions/no_convention.py

@@ -2,7 +2,7 @@
 from utils import change_if_none
 
 
-def just_message(co_author):
+def just_message(co_author=''):
     msg = str(input("commit message: "))
     co_author = change_if_none(co_author)
     composed = """%s\n\nCo-authored-by: """ % msg.capitalize()

conventions/symphony_cmf.py

@@ -3,7 +3,7 @@
 from utils import change_if_none
 
 
-def symphony_convention(co_author):
+def symphony_convention(co_author=''):
     tag, msg = get_text()
     tag = tag.capitalize()
     co_author = change_if_none(co_author)

generator.py

@@ -17,10 +17,6 @@
 from utils import create_file
 
 
-# TODO:
-# - add support to --convention flag
-# - add support to --no-generate flag
-
 parser = parser_cli()
 args = parser.parse_args()
 
@@ -46,22 +42,21 @@
                 just_message(args.co_author)
         except YAMLError as exc:
             print(exc)
-else:
-    print("No config files found!\nRunning default script...")
-    opt = int(input(menu) or 4)
-    if opt == 1:
-        print("You're using the angular convention")
+
+elif args.convention is not '':
+    convention = str(args.convention)
+    if convention == 'angular' or convention == 'karma':
         angular_convention(parser.co_author)
-        create_file('angular')
-    elif opt == 2:
-        print("You're using the changelog convention")
-        changelog_convention(args.co_author)
-        create_file('changelog')
-    elif opt == 3:
-        print("You're using the symphony convention")
+        create_file(convention, args.no_file)
+    elif convention == 'changelog':
+        changelog_convention(parser.co_author)
+        create_file(convention, args.no_file)
+    elif convention == 'symphony':
         symphony_convention(args.co_author)
-        create_file('symphony')
-    elif opt == 4:
-        print("You're not using a convention")
-        just_message(args.co_author)
-        create_file('none')
+        create_file(convention, args.no_file)
+    elif convention == 'message':
+        just_message(convention)
+        create_file('none', args.no_file)
+
+else:
+    parser.print_help()

test/test_utils.py

@@ -36,6 +36,7 @@ def mock_input(s):
     if not c == 'context':
         raise AssertionError()
 
+
 def test_change_if_none():
     string = 'asopdfha'
     string2 = None

utils.py

@@ -5,7 +5,7 @@
     "angular",
     "changelog",
     "symphony",
-    "message_only",
+    "message",
 ]
 
 menu = """
@@ -31,25 +31,31 @@ def get_text(context=False):
         return tag, msg
 
 
-def create_file(convention_name):
-    data = dict(
-        convention=convention_name
-    )
-    with open('commiter.yml', 'w') as output_file:
-        dump(data, output_file, default_flow_style=False)
+def create_file(convention_name, dont_create=False):
+    if not dont_create:
+        data = dict(
+            convention=convention_name
+        )
+        with open('commiter.yml', 'w') as output_file:
+            dump(data, output_file, default_flow_style=False)
 
 
 def parser_cli():
-    parser = argparse.ArgumentParser()
+    desc = "A commit formatter tool to help you follow commit conventions."
+    help_convention = \
+        """
+        Selects a convention to be used for the commit.
+        Required if there's no commiter.yml file.
+        """
+    parser = argparse.ArgumentParser(description=desc)
     parser.add_argument("--co-author",
                         help="make your friend an co-author to the commit",
                         dest="co_author", default=None)
     parser.add_argument("--no-generate", dest="no_file",
                         help="disables the creation of a commiter.yml file",
                         default=True, type=bool)
     parser.add_argument("--convention", choices=supported_conventions,
-                        dest="convention",
-                        help="selects a convention to be used for the commit")
+                        dest="convention", default='', help=help_convention)
     return parser