Add formatters, configs and pre-commit hook. Modify ci_pileline

Author: andsimakov

.editorconfig

@@ -0,0 +1,35 @@
+# http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{py,rst,ini,json,sh}]
+indent_style = space
+indent_size = 4
+
+[*.py]
+line_length=120
+known_first_party=cover_agent,tests_integration
+multi_line_output=3
+default_section=THIRDPARTY
+
+[*.{html,css,scss,js}]
+indent_style = space
+indent_size = 2
+
+[*.yml]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+
+[Makefile]
+indent_style = tab
+
+[makefile-local]
+indent_style = tab

.github/workflows/ci_pipeline.yml

@@ -35,11 +35,12 @@ jobs:
       - uses: actions/checkout@v2
         with:
           fetch-depth: 0 # Ensures we fetch all history for all branches
+
       - name: Set up Python
         uses: actions/setup-python@v2
         with:
           python-version: '3.12'
-      
+
       # Step to cache Poetry dependencies
       - name: Cache Poetry dependencies
         uses: actions/cache@v4
@@ -53,18 +54,28 @@ jobs:
 
       - name: Install Poetry
         run: pip install poetry
+
       - name: Install dependencies using Poetry
         run: poetry install
+
+      - name: Check import sorting with isort
+        run: poetry run isort --check-only --diff .
+
+      - name: Check code formatting with black
+        run: poetry run black --check .
+
       - name: Run tests and generate reports
         env:
           OPENAI_API_KEY: "This_is_a_fake_API_key"
         run: make test
+
       - name: Upload test report
         uses: actions/upload-artifact@v4
         if: always()
         with:
           name: test-reports
           path: testLog.xml
+
       - name: Upload coverage report
         uses: actions/upload-artifact@v4
         if: always()
@@ -84,7 +95,7 @@ jobs:
         uses: actions/setup-python@v2
         with:
           python-version: '3.12'
-      
+
       # Step to cache Poetry dependencies
       - name: Cache Poetry dependencies
         uses: actions/cache@v4
@@ -105,7 +116,7 @@ jobs:
           poetry build
           pip install dist/*.whl
           cd /tmp
-          cover-agent --help        
+          cover-agent --help
 
   build:
     needs: [test, changes]
@@ -121,7 +132,7 @@ jobs:
       uses: actions/setup-python@v2
       with:
         python-version: '3.12'
-    
+
     # Step to cache Poetry dependencies
     - name: Cache Poetry dependencies
       uses: actions/cache@v4
@@ -215,7 +226,7 @@ jobs:
     # - There are relevant changes outside 'README.md' and the 'docs/' folder
     needs: [build, changes, e2e-test]
     if: >
-      github.event_name == 'push' && 
+      github.event_name == 'push' &&
       github.ref == 'refs/heads/main' &&
       needs.changes.outputs.version_changed == 'true' &&
       needs.changes.outputs.relevant_changes == 'true'

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+- repo: https://github.com/psf/black
+  rev: 25.1.0
+  hooks:
+    - id: black
+      language_version: python3.12
+      args: ["--check"]
+      exclude: ^(templated_tests|cover_agent/lsp_logic)/
+
+- repo: https://github.com/pycqa/isort
+  rev: 6.0.1
+  hooks:
+    - id: isort
+      args: ["--check-only", "--diff"]
+      exclude: ^(templated_tests|cover_agent/lsp_logic)/

docs/pre_commit_hook.md

@@ -0,0 +1,36 @@
+## qodo-cover: Pre-commit hooks #
+
+To run additional checks before making commit we use [Pre-commit](https://pre-commit.com/) hooks.
+
+`pre-commit` package is installed with backend requirements, so there is no need of [manual installation](https://pre-commit.com/#install).
+But you need to generate the actual git pre-commit hook. It should be done only once during the project setup:
+
+```bash
+poetry run pre-commit install
+```
+
+Keep in mind, code formatters are configured separately for the pre-commit hook in the `.pre-commit-config.yaml` file. Pre-commit runs tools on staged files, not as part of your project that's why it requires a separate configuration. However it should be synced with those settings in `pyproject.toml` file.
+
+
+### Usage 
+To run pre-commit hooks manually:
+
+```bash
+poetry run pre-commit run --all-files
+```
+
+Check staged files only:
+```bash
+poetry run pre-commit run
+```
+
+To run specific hook:
+
+```bash
+poetry run pre-commit run <hook_id>
+```
+
+See more info in official documentation:
+
+* [Usage](https://pre-commit.com/#usage)
+* [Adding new hooks](https://pre-commit.com/#plugins)