chore: Pre-commit hooks, black formatting, etc

- Added pre-commit hooks to repo.
- Added black formatting for Python code.
- Styling fixes due to the pre-commit hooks.
- Update prompt_toolkit to 3.0 (should fix FuzzyCompleter issue)
- Added venv path to VS Code for pylint imports issue

Author: nebbles

.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.4.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+-   repo: https://github.com/psf/black
+    rev: 19.10b0
+    hooks:
+    -   id: black

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "python.pythonPath": ".venv/bin/python"
+}

LICENSE

@@ -671,4 +671,4 @@ into proprietary programs.  If your program is a subroutine library, you
 may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
-<https://www.gnu.org/licenses/why-not-lgpl.html>.
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

README.md

@@ -5,8 +5,10 @@
   <br><br>
   <a href="https://badge.fury.io/py/conventional-commit"><img src="https://badge.fury.io/py/conventional-commit.svg" alt="PyPI version" height="18"></a>
   <a href="https://travis-ci.org/nebbles/gitcommit/branches"><img src="https://travis-ci.org/nebbles/gitcommit.svg?branch=master" alt="Travis CI build" height="18"></a>
+  <a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black" height="18"></a>
 </p>
 
+
 # Install
 
 To install
@@ -42,7 +44,7 @@ Additional rules implemeted:
 
 # Development
 
-The old distribution method is documented in 
+The old distribution method is documented in
 [docs/dev_distibution_legacy.md](docs/dev_distribution_legacy.md)
 
 *Note: if modifying `.travis.yml` you should verify it by running `travis lint .travis.yml`*

docs/dev_distribution_legacy.md

@@ -2,7 +2,7 @@
 
 The following instructions explain how this command-line application is
 distributed. We deploy our builds to the Python Package Index for distribution.
-This allows users to install the application with a simple 
+This allows users to install the application with a simple
 `pip install conventional-commit`.
 
 First ensure necessary packages are installed

gitcommit/completers.py

@@ -1,4 +1,4 @@
-from prompt_toolkit.completion import (  # pylint: disable=no-name-in-module
+from prompt_toolkit.completion import (
     Completer,
     Completion,
     FuzzyCompleter,
@@ -46,9 +46,7 @@ def __init__(self):
             "test": "any work to tests",
             "wip": "work in progress / might not build",
         }
-        super().__init__(
-            self.meta_dict.keys(), meta_dict=self.meta_dict, WORD=False,
-        )
+        super().__init__(self.meta_dict.keys(), meta_dict=self.meta_dict, WORD=False)
 
 
 class FooterCompleter(FuzzyWordCompleter):
@@ -68,6 +66,5 @@ def __init__(self):
             "Clubhouse [branch ch": "Associates branch with ticket",
         }
         super().__init__(
-            self.footer_meta_dict.keys(), meta_dict=self.footer_meta_dict, WORD=False,
+            self.footer_meta_dict.keys(), meta_dict=self.footer_meta_dict, WORD=False
         )
-

gitcommit/gitcommit.py

@@ -51,8 +51,8 @@ class LineLengthPrompt:
     def __init__(self, length_limit, session):
         self.limit = length_limit
         self.session = session
-        self.invalid_style = Style.from_dict({"rprompt": "bg:#ff0066 #000000",})
-        self.valid_style = Style.from_dict({"rprompt": "bg:#b0f566 #000000",})
+        self.invalid_style = Style.from_dict({"rprompt": "bg:#ff0066 #000000"})
+        self.valid_style = Style.from_dict({"rprompt": "bg:#b0f566 #000000"})
 
     def get_text(self):
         text = get_app().current_buffer.text
@@ -126,7 +126,7 @@ def add_type(commit_msg):
             break_long_words=False,
         )
         # ensure each line has trailing whitespace, then do join
-        type_descr_str = "".join(map(lambda l: l.ljust(type_descr_width), descr_lines,))
+        type_descr_str = "".join(map(lambda l: l.ljust(type_descr_width), descr_lines))
 
         # Combine type name with type description
         type_print = prefixes[i].ljust(prefix_length) + type_descr_str
@@ -140,7 +140,7 @@ def add_type(commit_msg):
     print()
     text = Ansi.b_green("Type: ")
     c_type = prompt(
-        ANSI(text), completer=TypeCompleter(), validator=TypeValidator(valid_inputs),
+        ANSI(text), completer=TypeCompleter(), validator=TypeValidator(valid_inputs)
     )
 
     # Convert from number back to proper type name
@@ -368,7 +368,7 @@ def run():
     # Warn of extra command line arguments
     if len(sys.argv) > 1:
         Ansi.print_warning(
-            "The following additional arguments will be passed to git commit: ", end="",
+            "The following additional arguments will be passed to git commit: ", end=""
         )
         Ansi.print_warning(sys.argv[1:])
         argv_passthrough = sys.argv[1:]  # overwrite default list

poetry.lock

@@ -22,11 +22,12 @@ gitcommit = 'gitcommit.gitcommit:main'
 
 [tool.poetry.dependencies]
 python = "^3.6"
-prompt_toolkit = "^2.0"
+prompt_toolkit = "^3.0"
 requests = "^2.22"
 pyperclip = "^1.7"
 
 [tool.poetry.dev-dependencies]
+black = {version = "^18.3-alpha.0", allows-prereleases = true}
 
 [build-system]
 requires = ["poetry>=0.12"]