Add pre-commit

.gitlab-ci.yml

@@ -25,20 +25,10 @@ tests:
     - coverage report
     - codecov
 
-flake8:
+pre-commit:
   stage: test
   script:
-    - flake8
-
-mypy:
-  stage: test
-  script:
-    - mypy .
-
-doc8:
-  stage: test
-  script:
-    - doc8
+    - pre-commit run -a
 
 deploy-pypi:
   stage: deploy

.pre-commit-config.yaml

@@ -0,0 +1,31 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+    -   id: check-merge-conflict
+    -   id: check-executables-have-shebangs
+    -   id: check-symlinks
+-   repo: https://gitlab.com/PyCQA/flake8
+    rev: 3.8.4
+    hooks:
+    -   id: flake8
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.790
+    hooks:
+    -   id: mypy
+        args:
+        -   --ignore-missing-imports
+        -   --disallow-incomplete-defs
+        -   --disallow-untyped-defs
+        -   --check-untyped-defs
+        -   --no-implicit-optional
+-   repo: https://github.com/PyCQA/doc8
+    rev: 0.8.1
+    hooks:
+    -   id: doc8

docs/Makefile

@@ -16,4 +16,4 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/cli.rst

@@ -130,4 +130,3 @@ PCI access
 ``-H2``
   Access hardware using Intel configuration mechanism 2.
   Alias to ``-A intel-conf2``.
-

docs/conf.py

@@ -112,23 +112,23 @@ htmlhelp_basename = 'pylspcidoc'
 
 # -- Options for LaTeX output ------------------------------------------------
 
-latex_elements = {
-    # The paper size ('letterpaper' or 'a4paper').
-    #
-    # 'papersize': 'letterpaper',
-
-    # The font size ('10pt', '11pt' or '12pt').
-    #
-    # 'pointsize': '10pt',
-
-    # Additional stuff for the LaTeX preamble.
-    #
-    # 'preamble': '',
-
-    # Latex figure (float) alignment
-    #
-    # 'figure_align': 'htbp',
-}
+# latex_elements = {
+#     The paper size ('letterpaper' or 'a4paper').
+#
+#     'papersize': 'letterpaper',
+#
+#     The font size ('10pt', '11pt' or '12pt').
+#
+#     'pointsize': '10pt',
+#
+#     Additional stuff for the LaTeX preamble.
+#
+#     'preamble': '',
+#
+#     Latex figure (float) alignment
+#
+#     'figure_align': 'htbp',
+# }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,

requirements-dev.txt

@@ -1,6 +1,5 @@
-flake8>=3.5
 doc8>=0.8.0
 Sphinx>=1.8.1
 coverage>=4.5
 codecov>=2.0
-mypy>=0.720
+pre-commit>=2.9.2

requirements.txt

@@ -1 +1 @@
-cached-property>=1.5.1
+cached-property>=1.5.1