configure isort, black & pre-commit

Author: syphar

.github/workflows/static.yml

@@ -35,13 +35,10 @@ jobs:
           python-version: '3.7'
           architecture: 'x64'
       - run: python -m pip install --upgrade pip setuptools jsonschema
-      - run: pip install -e .[pylint,pycodestyle,pyflakes]
-      - name: Pylint checks
-        run: pylint pylsp test
-      - name: Code style checks
-        run: pycodestyle pylsp test
-      - name: Pyflakes checks
-        run: pyflakes pylsp test
+      - run: pip install -e .[lint]
+      - name: run linters via pre-commit
+        run: |
+          pre-commit run --all --show-diff-on-failure --color=always
       - name: Validate JSON schema
         run: echo {} | jsonschema pylsp/config/schema.json
       - name: Ensure JSON schema and Markdown docs are in sync

.pre-commit-config.yaml

@@ -0,0 +1,40 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: debug-statements
+    -   id: check-added-large-files
+-   repo: local
+    hooks:
+    -   id: isort
+        name: isort
+        entry: isort
+        language: system
+        types:
+        - python
+    -   id: black
+        name: black
+        entry: black
+        language: system
+        types:
+        - python
+    -   id: pyflakes
+        name: pyflakes
+        entry: pyflakes
+        language: system
+        types:
+        - python
+    -   id: pylint
+        name: pylint
+        entry: pylint
+        language: system
+        types:
+        - python
+    -   id: pycodestyle
+        name: pycodestyle
+        entry: pycodestyle
+        language: system
+        types:
+        - python

README.md

@@ -161,6 +161,13 @@ To run the test suite:
 pip install ".[test]" && pytest
 ```
 
+To run the linters: 
+```sh 
+pip install ".[lint]" && pre-commit run --all
+```
+You can also locally run `pre-commit install` in your repo to run 
+linters on changed files when committing.
+
 After adding configuration options to `schema.json`, refresh the `CONFIGURATION.md` file with
 
 ```

pyproject.toml

@@ -40,7 +40,10 @@ all = [
 ]
 autopep8 = ["autopep8>=1.6.0,<1.7.0"]
 flake8 = ["flake8>=5.0.0,<7"]
+isort = ["isort>=5.11.4,<6"]
+black = ["black>=22.12.0,<23"]
 mccabe = ["mccabe>=0.7.0,<0.8.0"]
+pre-commit = ["pre-commit>=2.21.0,<3.0.0"]
 pycodestyle = ["pycodestyle>=2.9.0,<2.11.0"]
 pydocstyle = ["pydocstyle>=6.2.0,<6.3.0"]
 pyflakes = ["pyflakes>=2.5.0,<3.1.0"]
@@ -59,6 +62,14 @@ test = [
     "pyqt5",
     "flaky",
 ]
+lint = [
+    "isort",
+    "black",
+    "pre-commit",
+    "pylint",
+    "pycodestyle",
+    "pyflakes",
+]
 
 [project.entry-points.pylsp]
 autopep8 = "pylsp.plugins.autopep8_format"
@@ -105,3 +116,11 @@ addopts = "--cov-report html --cov-report term --junitxml=pytest.xml --cov pylsp
 [tool.coverage.run]
 concurrency = ["multiprocessing", "thread"]
 
+[tool.isort]
+profile = "black"
+src_paths = ["pylsp", "test"]
+line_length = 120
+
+[tool.black]
+line-length = 120
+target-version = ['py37']

setup.cfg

@@ -2,6 +2,6 @@
 # Copyright 2021- Python Language Server Contributors.
 
 [pycodestyle]
-ignore = E226, E722, W504
+ignore = E226, E722, W504, W503, E203
 max-line-length = 120
 exclude = test/plugins/.ropeproject,test/.ropeproject