feat(file): added support to commit-helper.yml files

Author: andre-filho

README.md

@@ -104,10 +104,10 @@ optional arguments:
                         Pass your commit context directly
   -ca CO_AUTHOR, --co-author CO_AUTHOR
                         Make your friend an co-author to the commit
-  -nf, --no-file        Disables the creation of a commiter.yml file
+  -nf, --no-file        Disables the creation of a commiter.yml or commit-helper.yml file
   -c {angular,karma,tagged,symphony,message}, --convention {angular,karma,tagged,symphony,message}
                         Selects a convention to be used for the commit.
-                        Required if there's no commiter.yml file.
+                        Required if there's no commiter.yml or commit-helper.yml file.
   -d, --debug           Toggles debug option
 
 ```
@@ -124,7 +124,7 @@ Or if you are using this for the first time in your project:
 $ commit --convention tagged
 ```
 
-To work even more smoothly, 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:
+To work even more smoothly, have in your working directory a file named **commiter.yml or commit-helper.yml**. In this file you must pass the commit convention that you want to use, following the example:
 
 ```yaml
 convention: angular   # tag(context): commit message
@@ -146,7 +146,7 @@ convention: symphony  # [Tag] commit message
 convention: none      # Commit message
 ```
 
-In case that you or your organization does already have a commit convention that is not listed above, you can configure it in the commiter.yml file as following:
+In case that you or your organization does already have a commit convention that is not listed above, you can configure it in the commiter.yml or commit-helper.yml file as following:
 
 ```yaml
 convention: custom

VERSION.txt

@@ -1 +1 @@
-3.4.13
+3.4.14

commit_helper/__main__.py

@@ -4,6 +4,7 @@
 from .utils.utils import parser_cli
 from .utils.text_utils import debug
 from .utils.file_handler import handle_file_based_commit
+from .utils.file_handler import get_file_path
 from .utils.flag_commit_handler import convention_flag_handler
 # convention imports
 from .conventions.convention_help_handler import convention_help_handler
@@ -16,7 +17,7 @@ def main():
 
     debug('args variable', args, debug_mode)
 
-    file_path = Path('commiter.yml')
+    file_path = get_file_path()
 
     debug('file_path', file_path, debug_mode)
 

commit_helper/utils/file_handler.py

@@ -1,4 +1,5 @@
 from os import system
+from pathlib import Path
 from yaml import safe_load
 from yaml import YAMLError
 # utils imports
@@ -44,3 +45,13 @@ def handle_file_based_commit(file_path, debug_mode, args):
 
         except YAMLError as err:
             print(err)
+
+
+def get_file_path():     # pragma: no cover
+    commiter = Path('commiter.yml')
+    commit_h = Path('commit-helper.yml')
+
+    if commiter.exists():
+        return commiter
+    else:
+        return commit_h