Typing (#106)

* Move ui-tests directory to root

* Add mypy chack

* Fix workflow, licence and import

Author: brichet

.github/workflows/build.yml

@@ -120,7 +120,7 @@ jobs:
         python -m pip install "jupyterlab>=4.0.0,<5" jupyterlab_chat*.whl
 
     - name: Install dependencies
-      working-directory: python/jupyterlab-chat/ui-tests
+      working-directory: ui-tests
       env:
         YARN_ENABLE_IMMUTABLE_INSTALLS: 0
         PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1
@@ -135,10 +135,10 @@ jobs:
 
     - name: Install browser
       run: jlpm playwright install chromium
-      working-directory: python/jupyterlab-chat/ui-tests
+      working-directory: ui-tests
 
     - name: Execute integration tests
-      working-directory: python/jupyterlab-chat/ui-tests
+      working-directory: ui-tests
       run: |
         jlpm playwright test --retries=2
 
@@ -148,8 +148,27 @@ jobs:
       with:
         name: jupyterlab_chat-playwright-tests
         path: |
-          python/jupyterlab-chat/ui-tests/test-results
-          python/jupyterlab-chat/ui-tests/playwright-report
+          ui-tests/test-results
+          ui-tests/playwright-report
+
+  typing-tests:
+    name: Typing test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Base Setup
+        uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+
+      - name: Install extension dependencies and build the extension
+        run: ./scripts/dev_install.sh
+
+      - name: Run mypy
+        run: |
+          set -eux
+          mypy --version
+          mypy python/jupyterlab-chat
 
   check_links:
     name: Check Links

.github/workflows/update-integration-tests.yml

@@ -79,4 +79,4 @@ jobs:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           # Playwright knows how to start JupyterLab server
           start_server_script: 'null'
-          test_folder: python/jupyterlab-chat/ui-tests
+          test_folder: ui-tests

.gitignore

@@ -18,8 +18,8 @@ packages/jupyter-chat/junit.xml
 packages/jupyterlab-chat/junit.xml
 
 # Integration tests
-python/jupyterlab-chat/ui-tests/test-results/
-python/jupyterlab-chat/ui-tests/playwright-report/
+ui-tests/test-results/
+ui-tests/playwright-report/
 
 # Created by https://www.gitignore.io/api/python
 # Edit at https://www.gitignore.io/?templates=python

.licenserc.yaml

@@ -8,6 +8,7 @@ header:
       Distributed under the terms of the Modified BSD License.
 
   paths-ignore:
+    - '**/*.typed'
     - '**/*.ipynb'
     - '**/*.json'
     - '**/*.md'

docs/source/developers/contributing/jupyterlab-chat-extension.md

@@ -110,8 +110,7 @@
     "coverage",
     "**/*.d.ts",
     "tests",
-    "**/__tests__",
-    "ui-tests"
+    "**/__tests__"
   ],
   "eslintConfig": {
     "extends": [

packages/jupyter-chat/package.json

@@ -114,8 +114,7 @@
     "coverage",
     "**/*.d.ts",
     "tests",
-    "**/__tests__",
-    "ui-tests"
+    "**/__tests__"
   ],
   "eslintConfig": {
     "extends": [

packages/jupyterlab-chat/package.json

@@ -54,3 +54,6 @@ before-bump-version = [
 
 [tool.check-wheel-contents]
 ignore = ["W002"]
+
+[tool.mypy]
+check_untyped_defs = true