Merge pull request #993 from elementary-data/ele-1315-add-script-for-…

…dealing-with-editable-installs

Added the script.

.github/workflows/run-precommit.yml

@@ -1,10 +1,6 @@
 name: Run pre-commit hooks
 on:
   push:
-    paths:
-      - '**.py'
-      - '.pre-commit-config.yaml'
-      - '.github/workflows/run-precommit.yml'
   workflow_dispatch:
 
 jobs:
@@ -17,7 +13,7 @@ jobs:
       - name: Set up Python
         uses: actions/[email protected]
         with:
-          python-version: '3.8'
+          python-version: "3.8"
 
       # mainly needed so mypy will have the dependencies it needs
       - name: Install elementary

scripts/install_develop.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# This script installs the package in editable mode in a way that allows static type checkers to work.
+# Information about the problem can be found in the following sources:
+#   - https://github.com/python/mypy/issues/13392
+#   - https://microsoft.github.io/pyright/#/import-resolution?id=editable-installs
+#   - https://setuptools.pypa.io/en/latest/userguide/development_mode.html#legacy-behavior
+
+pip install -e . --config-settings editable_mode=compat
+