feat(yaml config): merges implementation of yaml configuration

Adds .yml config file support

Author: andre-filho

.editorconfig

@@ -1,5 +1,8 @@
-[*.py]
-indent_size = 4
+[*]
+charset = utf-8
 indent_style = space
 end_of_line = lf
 trim_trailing_whitespace = false
+
+[*.py]
+indent_size = 4

.gitignore

@@ -1 +1,3 @@
 .vscode/
+commiter.yml
+__pycache__/

README.md

@@ -29,6 +29,40 @@ Just follow the commands below:
 
 ```
 
+## Usage and configuration
+
+For this project to work smoothly, you must have in your working directory a file named **commiter.yml**. In this file you must pass the commit convention that you want to use, following the example:
+
+```yaml
+convention: angular
+# or
+convention: changelog
+# or even
+convention: symphony
+```
+
+
+
+Supported conventions available:
+<!-- list here all tags that are used in configuration file -->
+
+ - angular/karma
+ - changelog
+ - symphony
+
+In the event of no commiter.yml file presence, you will be prompted with the following option menu:
+
+```bash
+No config files found!
+Running default script...
+    what type of commit convention are you using?
+    1- Karma/Angular
+    2- Conventional changelog
+    3- Symfony CMF
+```
+
+
+
 ## Project's maintainers
 | **Name** | **Username** |
 | :--------: | :-----: |

generator.py

@@ -1,25 +1,55 @@
 import os
 
-opt = int(input("""
-what type of commit convention are you using?
+from pathlib import Path
+from yaml import safe_load
+from yaml import YAMLError
 
-1- Karma/Angular
-2- Conventional changelog
-3- Symfony CMF
-"""))
+from utils import run_config
+from utils import angular_convention
+from utils import changelog_convention
+from utils import symphony_convention
 
-tag = str(input("type the tag: "))
-msg = str(input("type the commit message: ")).lower()
+tag = ''
+tag_is_lowercase = False
+tag_is_uppercase = False
+tag_is_capitalized = False
+convention = ''
 
-if opt == 1:
-    context = str(input('type the context: ')).lower()
-    tag = tag.lower()
-    os.system("git commit -m '%s(%s): %s'" % (tag, context, msg))
+file_path = Path("commiter.yml")
 
-elif opt == 2:
-    tag = tag.upper()
-    os.system("git commit -m '%s: %s'" % (tag, msg))
+if file_path.is_file():
+    with open(str(file_path), 'r') as stream:
+        try:
+            config = safe_load(stream)
+            tag, tag_is_capitalized, tag_is_lowercase, tag_is_uppercase, convention = run_config(config, tag, tag_is_capitalized, tag_is_lowercase, tag_is_uppercase, convention)
+            if convention != '' or convention != 'custom':
+                if convention == 'angular':
+                    print('You are using the %s convention' % convention)
+                    angular_convention()
+                elif convention ==  'changelog':
+                    print('You are using the %s convention' % convention)
+                    changelog_convention()
+                elif convention == 'symphony':
+                    print('You are using the %s convention' % convention)
+                    symphony_convention()
+            else:
+                custom_convention()
+        except YAMLError as exc:
+            print(exc)
 
-elif opt == 3:
-    tag = tag.capitalize()
-    os.system("git commit -m '[%s] %s'" % (tag, msg))
+else:
+    print("No config files found!\nRunning default script...")
+    opt = int(input("""
+    what type of commit convention are you using?
+
+    1- Karma/Angular
+    2- Conventional changelog
+    3- Symfony CMF
+    """))
+
+    if opt == 1:
+        angular_convention()
+    elif opt == 2:
+       changelog_convention()
+    elif opt == 3:
+        symphony_convention()

utils.py

@@ -0,0 +1,54 @@
+import os
+
+possible_configurations = [
+    'tag',
+    'tag_is_lowercase',
+    'tag_is_uppercase',
+    'tag_is_capitalized',
+    'convention',
+]
+
+# refactor this function, surely there is a better way of writing this
+def run_config(array, tag, tag_is_capitalized, tag_is_lowercase, tag_is_uppercase,convention):
+    for conf in possible_configurations:
+        if conf in array:
+            if conf == 'tag':
+                tag = str(array[conf])
+            elif conf == 'tag_is_lowercase':
+                tag_is_lowercase = bool(array[conf])
+            elif conf == 'tag_is_uppercase':
+                tag_is_uppercase = bool(array[conf])
+            elif conf == 'tag_is_capitalized':
+                tag_is_capitalized = bool(array[conf])
+            elif conf == 'convention':
+                convention = str(array[conf])
+    return tag, tag_is_capitalized, tag_is_lowercase, tag_is_uppercase, convention
+
+def get_text(context=False):
+    if context:
+        tag = str(input("type the tag: "))
+        msg = str(input("type the commit message: ")).lower()
+        context = str(input('type the context: ')).lower()
+        return tag, msg, context
+    else:
+        tag = str(input("type the tag: "))
+        msg = str(input("type the commit message: ")).lower()
+        return tag, msg        
+
+def angular_convention():
+    tag, msg, context = get_text(context=True)
+    tag = tag.lower()
+    os.system("git commit -m '%s(%s): %s'" % (tag, context, msg))
+
+def changelog_convention():
+    tag, msg = get_text()
+    tag = tag.upper()
+    os.system("git commit -m '%s: %s'" % (tag, msg))
+
+def symphony_convention():
+    tag, msg = get_text()
+    tag = tag.capitalize()
+    os.system("git commit -m '[%s] %s'" % (tag, msg))
+
+def custom_convention():
+    pass