Add dev install script

.github/workflows/test.yml

@@ -68,13 +68,7 @@ jobs:
 
       - name: Install dependencies
         run: |
-          pip install "jupyterlab>=4.0.0,<5"
-          pip install -e .
-          pip install -e projects/jupyter-collaboration-ui -e projects/jupyter-docprovider -e projects/jupyter-server-ydoc
-          jupyter labextension develop --overwrite projects/jupyter-collaboration-ui
-          jupyter labextension develop --overwrite projects/jupyter-docprovider
-          jlpm
-          jlpm build
+          yarn dev
 
       - name: Run Tests
         run: |
@@ -107,8 +101,8 @@ jobs:
       - name: Install the Python dependencies
         run: |
           python -m pip install "jupyterlab>=4.0.0,<5"
-          python -m pip install -e ".[test]" codecov
-          python -m pip install -e projects/jupyter-collaboration-ui -e projects/jupyter-docprovider -e "projects/jupyter-server-ydoc[test]"
+          python -m pip install codecov
+          yarn dev
 
       - name: List installed packages
         run: |
@@ -162,8 +156,7 @@ jobs:
 
       - name: Install the Python dependencies
         run: |
-          pip install -e ".[test]"
-          pip install -e projects/jupyter-collaboration-ui -e projects/jupyter-docprovider -e "projects/jupyter-server-ydoc[test]"
+          yarn dev
 
       - name: Run the unit tests
         run: |
@@ -183,8 +176,7 @@ jobs:
 
       - name: Install the Python dependencies
         run: |
-          pip install -e ".[test]"
-          pip install -e projects/jupyter-collaboration-ui -e projects/jupyter-docprovider -e "projects/jupyter-server-ydoc[test]"
+          yarn dev
 
       - name: List installed packages
         run: |

.yarnrc.yml

@@ -1,2 +1 @@
 nodeLinker: node-modules
-enableImmutableInstalls: false

docs/source/developer/contributing.rst

@@ -37,13 +37,8 @@ Once you have installed the dependencies above, use the following steps:
 
     git clone https://github.com/jupyterlab/jupyter-collaboration.git
     cd jupyter-collaboration
-    # install monorepo
-    pip install -e ".[dev,test]"
-    # install local dependencies as editable
-    pip install -e projects/jupyter-collaboration-ui -e projects/jupyter-docprovider -e projects/jupyter-server-ydoc
-    # link lab extensions
-    jupyter labextension develop --overwrite projects/jupyter-collaboration-ui
-    jupyter labextension develop --overwrite projects/jupyter-docprovider
+    # install monorepo in dev mode
+    python scripts/dev_install.py
 
 
 If you are using a system-wide Python installation and you only want to install the server for you,

package.json

@@ -25,6 +25,7 @@
     "packages/*"
   ],
   "scripts": {
+    "dev": "python scripts/dev_install.py",
     "build": "lerna run build",
     "build:prod": "lerna run build:prod",
     "build:test": "lerna run build:test",

scripts/dev_install.py

@@ -0,0 +1,37 @@
+import subprocess
+from pathlib import Path
+from typing import Optional
+
+
+def execute(cmd: str, cwd: Optional[Path] = None) -> None:
+    subprocess.run(cmd.split(" "), check=True, cwd=cwd)
+
+
+def install_dev() -> None:
+    install_build_deps = "python -m pip install jupyterlab>=4,<5"
+    install_js_deps = "jlpm install"
+
+    python_package_prefix = "projects"
+    python_packages = ["jupyter-collaboration-ui", "jupyter-docprovider", "jupyter-server-ydoc"]
+
+    execute(install_build_deps)
+    execute(install_js_deps)
+
+    for py_package in python_packages:
+        real_package_name = py_package.replace("-", "_")
+        execute(f"pip uninstall {real_package_name} -y")
+        execute(f"pip install -e {python_package_prefix}/{py_package}[test]")
+
+        # List of server extensions
+        if py_package in ["jupyter-server-ydoc"]:
+            execute(f"jupyter server extension enable {real_package_name}")
+
+        # List of jupyterlab extensions
+        if py_package in ["jupyter-collaboration-ui", "jupyter-docprovider"]:
+            execute(
+                f"jupyter labextension develop --overwrite {python_package_prefix}/{py_package} --overwrite"
+            )
+
+
+if __name__ == "__main__":
+    install_dev()