Add pre-commit config and apply all fixes

hackedd · Davidy22 · commit 86bb9b55c1b9 · 2022-10-27T15:31:25.000+08:00
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -15,5 +15,4 @@ For how to run the latest Guake in your computer, please refer to [Install from
 
 Please use [FeatHub](https://feathub.com/Guake/guake) to fill-up a feature request.
 
-This allow us to spot directly which are the most requested features.
-
+This allows us to spot directly which are the most requested features.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -41,14 +41,14 @@ Please follow these steps before submitting a new Pull Request to Guake:
 
 - Semantic commit is supported (and recommended). Add one of the following
   line in your commit messages:
-  
+
   ```
   # For a bug fix, uses:
   sem-ver: bugfix
-  
+
   # For a new feature, uses:
   sem-ver: feature
-  
-  # Please do not use the 'breaking change' syntax (`sem-ver: api-break`), 
+
+  # Please do not use the 'breaking change' syntax (`sem-ver: api-break`),
   # it is reserved for really big reworks
   ```
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -60,7 +60,7 @@ jobs:
           make test-actions
           # prepare for deployment
           make generate-paths
-          
+
       - uses: Thog/action-equals@v1
         id: isLatest
         with:
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,25 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks.git
+    rev: v4.3.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+        args:
+          - "--markdown-linebreak-ext=md"
+        exclude: COPYING
+  - repo: https://github.com/PyCQA/flake8.git
+    rev: 3.9.2
+    hooks:
+      - id: flake8
+  - repo: https://github.com/PyCQA/pylint.git
+    rev: v2.13.6
+    hooks:
+      - id: pylint
+  - repo: https://github.com/psf/black.git
+    rev: 22.10.0
+    hooks:
+      - id: black
+  - repo: https://github.com/hackedd/fiximports.git
+    rev: 19bd841
+    hooks:
+      - id: fiximports
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,5 +1,4 @@
 prune .github
-prune git-hooks
 prune releasenotes
 include guake *
 prune guake/tests
diff --git a/Makefile b/Makefile
@@ -181,7 +181,8 @@ compile-glib-schemas-dev: clean-schemas
 clean-schemas:
 	rm -f $(DEV_DATA_DIR)/gschemas.compiled
 
-style: black
+style:
+	PIPENV_IGNORE_VIRTUALENVS=1 pipenv run pre-commit run --all-files
 
 black:
 	PIPENV_IGNORE_VIRTUALENVS=1 pipenv run black $(MODULE)
@@ -312,15 +313,12 @@ freeze:
 	PIPENV_IGNORE_VIRTUALENVS=1 pipenv run pip freeze
 
 
-githook:
-	bash git-hooks/post-commit
-
 setup-githook:
 	rm -f .git/hooks/post-commit
-	cp -fv git-hooks/* .git/hooks/
+	PIPENV_IGNORE_VIRTUALENVS=1 pipenv run pre-commit install
 
 
-push: githook
+push:
 	git push origin --tags
 
 
diff --git a/Pipfile b/Pipfile
@@ -34,6 +34,7 @@ pew = "*"
 black = "==21.8b0"
 flakehell = "*"
 toml = "*"
+pre-commit = "==2.17.0"
 
 [packages]
 pbr = "*"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/docs/source/contributing/dev_env.rst b/docs/source/contributing/dev_env.rst
@@ -84,8 +84,8 @@ You can reinstall easily in your environment (only validated for Debian/Ubuntu)
 Git hook
 ========
 
-Please install this git hook if you want to beautify your patch before submission:
+This project uses `pre-commit <https://pre-commit.com/>` to automatically execute some codestyle tools. It should be automatically installed by the ``make dev`` command, you can use ``make style`` if you want to run it manually. If you want to pass more options, you can use:
 
 .. code-block:: bash
 
-    $ make setup-githook
+    $ pipenv run pre-commit run --all-files
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -45,7 +45,7 @@ Useful links
 - Source Code available on `GitHub <https://github.com/Guake/guake/>`_.
 - Official Homepage: http://guake-project.org
 - Online Documentation is hosted on `ReadTheDocs <http://guake.readthedocs.io/>`_.
-- If you are not a developer, you can still contribute to Guake by 
+- If you are not a developer, you can still contribute to Guake by
    `improving its translations in your language <https://hosted.weblate.org/projects/guake/guake/>`_.
    Guake users are welcome `to support Weblate <https://weblate.org/donate/>`_ in providing this
    service for free for OpenSource Projects.
diff --git a/git-hooks/post-commit b/git-hooks/post-commit
diff --git a/guake/callbacks.py b/guake/callbacks.py
@@ -5,11 +5,11 @@
 from gi.repository import Gtk
 from guake.about import AboutDialog
 from guake.dialogs import SaveTerminalDialog
+from guake.globals import ENGINES
 from guake.prefs import PrefsDialog
 from guake.utils import FullscreenManager
 from guake.utils import HidePrevention
 from guake.utils import get_server_time
-from guake.globals import ENGINES
 from urllib.parse import quote_plus
 
 
diff --git a/guake/data/guake.desktop.metainfo.xml b/guake/data/guake.desktop.metainfo.xml
@@ -9,12 +9,12 @@
 	<description>
 		<p>
 			Guake is a top-down terminal for Gnome, and is highly inspired by the famous terminal used in Quake.
-			You can instantaneously show and hide your terminal with a single key stroke, execute a command, and then go back to your previous task without breaking your workflow. 
+			You can instantaneously show and hide your terminal with a single key stroke, execute a command, and then go back to your previous task without breaking your workflow.
 		</p>
 		<p>
 			Imagine you are working in your favorite text editor and want to execute some commands, like execute the unit test of your code, check a man page, or edit some configuration file.
 			You can do it at lightning speed without leaving your keyboard.
-			Just press your predefined "Show Guake" hotkey, execute your command, and press it again to hide the terminal and go back to your work. 
+			Just press your predefined "Show Guake" hotkey, execute your command, and press it again to hide the terminal and go back to your work.
 		</p>
 	</description>
 
@@ -33,4 +33,3 @@
 	<url type="bugtracker">https://github.com/Guake/guake/issues</url>
 	<url type="translate">https://hosted.weblate.org/projects/guake/guake/</url>
 </component>
-
diff --git a/guake/keybindings.py b/guake/keybindings.py
@@ -24,8 +24,8 @@
 import gi
 
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk
 from gi.repository import Gdk
+from gi.repository import Gtk
 
 from guake import notifier
 from guake.common import pixmapfile
diff --git a/guake/prefs.py b/guake/prefs.py
@@ -45,10 +45,10 @@
 from guake.globals import ALIGN_RIGHT
 from guake.globals import ALIGN_TOP
 from guake.globals import ALWAYS_ON_PRIMARY
+from guake.globals import ENGINES
 from guake.globals import MAX_TRANSPARENCY
 from guake.globals import NAME
 from guake.globals import QUICK_OPEN_MATCHERS
-from guake.globals import ENGINES
 from guake.palettes import PALETTES
 from guake.paths import AUTOSTART_FOLDER
 from guake.paths import LOCALE_DIR
diff --git a/releasenotes/notes/[Add_open_link_under_terminal_cursor_accelerator]-6bd83e590f8403d9.yaml b/releasenotes/notes/[Add_open_link_under_terminal_cursor_accelerator]-6bd83e590f8403d9.yaml
@@ -4,4 +4,3 @@ release_summary: >
 features:
   - |
       - Add new accelerator to open a link or URL under the terminal cursor #2060
-
diff --git a/releasenotes/notes/bugfix-bfcece2fed005b98.yaml b/releasenotes/notes/bugfix-bfcece2fed005b98.yaml
@@ -4,4 +4,3 @@ release_summary: >
 fixes:
   - |
     fixed issue #1747. Now font size is not reset after a terminal split
-
diff --git a/releasenotes/notes/execute_in_new_tab-6161bba1822b644c.yaml b/releasenotes/notes/execute_in_new_tab-6161bba1822b644c.yaml
@@ -1,6 +1,6 @@
 release_summary: >
   -e command reinstated and now only runs in new tabs
-  
+
 security:
   - |
     guake with the -e flag now always opens a new tab to run commands in
diff --git a/releasenotes/notes/file_open_regex-1a6db403d54601e0.yaml b/releasenotes/notes/file_open_regex-1a6db403d54601e0.yaml
@@ -1,6 +1,6 @@
 release_summary: >
   Make file link matcher not match leading words.
-  
+
 fixes:
   - |
-      - Spec files not recognized as links #1032 
+      - Spec files not recognized as links #1032
diff --git a/releasenotes/notes/save_subterminals-4d086becd64ffcfb.yaml b/releasenotes/notes/save_subterminals-4d086becd64ffcfb.yaml
@@ -3,4 +3,4 @@ release_summary: >
 
 fixes:
   - |
-      - A closed subterminal returns back after restarting Guake #1686 
+      - A closed subterminal returns back after restarting Guake #1686
diff --git a/scripts/all-sitedirs-in-prefix.py b/scripts/all-sitedirs-in-prefix.py
@@ -1,5 +1,7 @@
 from __future__ import print_function
-import site, os
+
+import os
+import site
 
 prefix = os.getenv("PREFIX")
 for d in site.getsitepackages(None if not prefix else [prefix]):
diff --git a/scripts/test-exception.py b/scripts/test-exception.py
@@ -8,7 +8,7 @@ def func4():
 
 
 def func2():
-    func3()
+    func3()  # noqa: F821
 
 
 def func1():

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`prune .github`
`2`		`-prune git-hooks`
`3`	`2`	`prune releasenotes`
`4`	`3`	`include guake *`
`5`	`4`	`prune guake/tests`