Rename the extension to jupyterlab-chat (#102)

* Rename the extension to jupyterlab-chat (javascript and python)

* lint

* Rename directories

* Rename the typescript classes and namespaces

* Rename HTML classes

* Fix documentation

Author: brichet

.github/workflows/build.yml

@@ -83,15 +83,15 @@ jobs:
     - name: Package extension
       run: |
         set -eux
-        pip install build python/jupyterlab-collaborative-chat
-        python -m build python/jupyterlab-collaborative-chat
-        pip uninstall -y "jupyterlab_collaborative_chat" jupyterlab
+        pip install build python/jupyterlab-chat
+        python -m build python/jupyterlab-chat
+        pip uninstall -y "jupyterlab_chat" jupyterlab
 
     - name: Upload package
       uses: actions/upload-artifact@v3
       with:
-        name: jupyterlab_collaborative_chat-artifacts
-        path: python/jupyterlab-collaborative-chat/dist/jupyterlab_collaborative_chat*
+        name: jupyterlab_chat-artifacts
+        path: python/jupyterlab-chat/dist/jupyterlab_chat*
         if-no-files-found: error
 
   integration-tests:
@@ -112,15 +112,15 @@ jobs:
     - name: Download extension package
       uses: actions/download-artifact@v3
       with:
-        name: jupyterlab_collaborative_chat-artifacts
+        name: jupyterlab_chat-artifacts
 
     - name: Install the extension
       run: |
         set -eux
-        python -m pip install "jupyterlab>=4.0.0,<5" jupyterlab_collaborative_chat*.whl
+        python -m pip install "jupyterlab>=4.0.0,<5" jupyterlab_chat*.whl
 
     - name: Install dependencies
-      working-directory: python/jupyterlab-collaborative-chat/ui-tests
+      working-directory: python/jupyterlab-chat/ui-tests
       env:
         YARN_ENABLE_IMMUTABLE_INSTALLS: 0
         PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1
@@ -135,21 +135,21 @@ jobs:
 
     - name: Install browser
       run: jlpm playwright install chromium
-      working-directory: python/jupyterlab-collaborative-chat/ui-tests
+      working-directory: python/jupyterlab-chat/ui-tests
 
     - name: Execute integration tests
-      working-directory: python/jupyterlab-collaborative-chat/ui-tests
+      working-directory: python/jupyterlab-chat/ui-tests
       run: |
         jlpm playwright test --retries=2
 
     - name: Upload Playwright Test report
       if: always()
       uses: actions/upload-artifact@v3
       with:
-        name: jupyterlab_collaborative_chat-playwright-tests
+        name: jupyterlab_chat-playwright-tests
         path: |
-          python/jupyterlab-collaborative-chat/ui-tests/test-results
-          python/jupyterlab-collaborative-chat/ui-tests/playwright-report
+          python/jupyterlab-chat/ui-tests/test-results
+          python/jupyterlab-chat/ui-tests/playwright-report
 
   check_links:
     name: Check Links

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

@@ -72,11 +72,11 @@ jobs:
         run: python -m pip install -U "jupyterlab>=4.0.0,<5"
 
       - name: Install extension
-        run: ./scripts/dev_install.sh collaborative
+        run: ./scripts/dev_install.sh
 
       - uses: jupyterlab/maintainer-tools/.github/actions/update-snapshots@v1
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           # Playwright knows how to start JupyterLab server
           start_server_script: 'null'
-          test_folder: python/jupyterlab-collaborative-chat/ui-tests
+          test_folder: python/jupyterlab-chat/ui-tests

.gitignore

@@ -15,11 +15,11 @@ python/**/_version.py
 
 # jest test reports
 packages/jupyter-chat/junit.xml
-packages/jupyterlab-collaborative-chat/junit.xml
+packages/jupyterlab-chat/junit.xml
 
 # Integration tests
-python/jupyterlab-collaborative-chat/ui-tests/test-results/
-python/jupyterlab-collaborative-chat/ui-tests/playwright-report/
+python/jupyterlab-chat/ui-tests/test-results/
+python/jupyterlab-chat/ui-tests/playwright-report/
 
 # Created by https://www.gitignore.io/api/python
 # Edit at https://www.gitignore.io/?templates=python

README.md

@@ -27,26 +27,26 @@ package named `@jupyter/chat`.
 This package provides a frontend library (using react), and is intended to be
 used by a jupyterlab extension to create a chat.
 
-#### jupyterlab-collaborative-chat
+#### jupyterlab-chat
 
-The typescript package is located in *packages/jupyterlab-collaborative-chat* and
-builds an NPM package named `jupyterlab-collaborative-chat`.
+The typescript package is located in *packages/jupyterlab-chat* and
+builds an NPM package named `jupyterlab-chat`.
 
 This package relies on `@jupyter/chat` and provides a typescript library.
-It is intended to be used by a jupyterlab extension to create a collaborative chat.
+It is intended to be used by a jupyterlab extension to create a chat.
 
 ### Jupyterlab extensions
 
-#### Chat extension based on shared document: *python/jupyterlab-collaborative-chat*
+#### Chat extension based on shared document: *python/jupyterlab-chat*
 
-This extension is an implementation of the `jupyter-collaborative-chat` package, relying
+This extension is an implementation of the `jupyter-chat` package, relying
 on shared document (see [jupyter_ydoc](https://github.com/jupyter-server/jupyter_ydoc)).
 
 It is composed of:
 
-- a Python package named `jupyterlab_collaborative_chat`, which register
+- a Python package named `jupyterlab_chat`, which register
   the `YChat` shared document in jupyter_ydoc
-- a NPM package named `jupyterlab-collaborative-chat-extension`.
+- a NPM package named `jupyterlab-chat-extension`.
 
 #### REMOVED - Chat extension based on websocket
 

binder/environment.yml

@@ -1,4 +1,4 @@
-name: jupyterlab-collaborative-chat
+name: jupyterlab-chat
 channels:
   - conda-forge
 dependencies:

binder/postBuild

@@ -3,8 +3,8 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
-# Install collaborative chat
-./scripts/dev_install.sh collaborative
+# Install chat extension
+./scripts/dev_install.sh
 
 jupyter troubleshoot
 jupyter notebook --show-config

docs/source/_static/images/collaboarative-chat.png renamed to docs/source/_static/images/chat-widgets.png

@@ -11,5 +11,5 @@ maxdepth: 2
 ---
 
 ./jupyter-chat
-./jupyterlab-collaborative-chat
+./jupyterlab-chat-extension
 ```

docs/source/developers/contributing/index.md

@@ -3,8 +3,7 @@
 The `@jupyter/chat` package is a frontend package (React) compatible with jupyterlab.
 It is not an extension, and cannot be used on its own. It is designed to be used in an
 extension.\
-In this repository, it is currently used in `jupyterlab-collaborative-chat` and
-`jupyterlab-ws-chat`.
+In this repository, it is currently used in `jupyterlab-chat` extension.
 
 ## Building the package
 

docs/source/developers/contributing/jupyter-chat.md

@@ -1,6 +1,6 @@
-# Collaborative chat
+# Jupyterlab chat
 
-The `jupyterlab-collaborative-chat` extension adds collaborative chats to jupyterlab.
+The `jupyterlab-chat` extension adds chats to jupyterlab based on collaborative documents.
 
 ## Development installation
 
@@ -17,21 +17,21 @@ The following commands install the extension in development mode:
 
 ```bash
 # Install the extension
-./scripts/dev_install.sh collaborative
+./scripts/dev_install.sh
 
 # Symlink the assets
-jupyter labextension develop --overwrite python/jupyterlab-collaborative-chat
+jupyter labextension develop --overwrite python/jupyterlab-chat
 ```
 
 To uninstall it, run:
 
 ```bash
-pip uninstall jupyterlab-collaborative-chat
+pip uninstall jupyterlab-chat
 ```
 
 ## Building the assets
 
-Changes in typescript sources of `@jupyter/chat` or `jupyterlab-collaborative-chat` must
+Changes in typescript sources of `@jupyter/chat` or `jupyterlab-chat` must
 be built again to be available in the jupyterlab.
 
 ```bash
@@ -40,31 +40,31 @@ jlpm build
 
 ## Testing locally the extension
 
-`jupyterlab-collaborative-chat` package has unit tests and integration tests.
+`jupyterlab-chat` package has unit tests and integration tests.
 
 ### Unit tests
 
-There are a few unit tests in *python/jupyterlab-collaborative-chat/src/\_\_tests\_\_*.
+There are a few unit tests in *python/jupyterlab-chat/src/\_\_tests\_\_*.
 
 They make use of [jest](https://jestjs.io/).
 
 The following commands run them:
 
 ```bash
-cd ./python/jupyterlab-collaborative-chat
+cd ./python/jupyterlab-chat
 jlpm test
 ```
 
 ### Integration tests
 
-The integration tests are located in *python/jupyterlab-collaborative-chat/ui-tests*.
+The integration tests are located in *python/jupyterlab-chat/ui-tests*.
 
 They make use of [playwright](https://playwright.dev/).
 
 The following commands run them:
 
 ```bash
-cd ./python/jupyterlab-collaborative-chat/ui-tests
+cd ./python/jupyterlab-chat/ui-tests
 
 # Install the tests dependencies
 jlpm install