From ae65f55de378f490bf7da143bfbbb2be06457f4d Mon Sep 17 00:00:00 2001
From: Dhruv <dhruvmanila@gmail.com>
Date: Wed, 30 Sep 2020 14:09:14 +0530
Subject: [PATCH] Add pre-commit hook for TheAlgorithms/Python (#2511)

* Add pre-commit basic config file

* Add pre-commit to requirements.txt

* Small tweaks and use stable for black

* Fix isort section in pre-commit-config file

* Fix errors and EOF only for Python files
---
 .pre-commit-config.yaml | 60 +++++++++++++++++++++++++++++++++++++++++
 requirements.txt        |  1 +
 2 files changed, 61 insertions(+)
 create mode 100644 .pre-commit-config.yaml

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
new file mode 100644
index 000000000..2fbb9cb9b
--- /dev/null
+++ b/.pre-commit-config.yaml
@@ -0,0 +1,60 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+      - id: check-executables-have-shebangs
+      - id: check-yaml
+      - id: end-of-file-fixer
+        types: [python]
+      - id: trailing-whitespace
+        exclude: |
+          (?x)^(
+            data_structures/heap/binomial_heap.py
+          )$
+      - id: requirements-txt-fixer
+  - repo: https://github.com/psf/black
+    rev: stable
+    hooks:
+      - id: black
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.5.3
+    hooks:
+      - id: isort
+        args:
+          - --profile=black
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.8.3
+    hooks:
+      - id: flake8
+        args:
+          - --ignore=E203,W503
+          - --max-complexity=25
+          - --max-line-length=88
+#     FIXME: fix mypy errors and then uncomment this
+#    - repo: https://github.com/pre-commit/mirrors-mypy
+#      rev: v0.782
+#      hooks:
+#        - id: mypy
+#          args:
+#            - --ignore-missing-imports
+  - repo: https://github.com/codespell-project/codespell
+    rev: v1.17.1
+    hooks:
+      - id: codespell
+        args:
+          - --ignore-words-list=ans,fo,followings,hist,iff,secant,som,tim
+          - --skip="./.*,./other/dictionary.txt,./other/words,./project_euler/problem_22/p022_names.txt"
+          - --quiet-level=2
+        exclude: |
+          (?x)^(
+              other/dictionary.txt |
+              other/words |
+              project_euler/problem_22/p022_names.txt
+          )$
+  - repo: local
+    hooks:
+      - id: validate-filenames
+        name: Validate filenames
+        entry: ./scripts/validate_filenames.py
+        language: script
+        pass_filenames: false
diff --git a/requirements.txt b/requirements.txt
index b070ffdf6..cb38123dc 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -10,6 +10,7 @@ numpy
 opencv-python
 pandas
 pillow
+pre-commit
 pytest
 pytest-cov
 requests