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

docs/source/developers/contributing/jupyterlab-collaborative-chat.md renamed to docs/source/developers/contributing/jupyterlab-chat-extension.md

@@ -11,5 +11,5 @@ maxdepth: 2
 ---
 
 ./extension-providing-chat
-./using-chat-extensions
+./using-chat-extension
 ```

docs/source/developers/developing_extensions/index.md

@@ -1,8 +1,6 @@
 # Using a chat extension in another extension
 
-## Collaborative chat
-
-The collaborative chat depends on [jupyter collaboration](https://jupyterlab-realtime-collaboration.readthedocs.io/en/latest/index.html)
+The chat extension depends on [jupyter collaboration](https://jupyterlab-realtime-collaboration.readthedocs.io/en/latest/index.html)
 to exchange the messages.
 
 As a very brief summary, jupyter collaboration allows jupyterlab users to share a
@@ -13,39 +11,39 @@ frontend or from the backend. The shared document has an object representation i
 Typescript (for the frontend) and in Python (for the backend). These representations
 can be accessed and used by external extensions.
 
-### Exposed token
+## Exposed token
 
-`jupyterlab-collaborative-chat` expose several tokens that allow external extensions to
+`jupyterlab-chat` expose several tokens that allow external extensions to
 interact with.
 
-#### IChatFactory
+### IChatFactory
 
 This token is composed of:
 
 - `widgetConfig` object, to retrieve and change the current [settings](#chat-settings)
 of all the chats
-- `tracker`, a widget tracker that allows to track all the collaborative chats, and to
+- `tracker`, a widget tracker that allows to track all the opened chats, and to
 retrieve the current one.
 
 ```{caution}
 Currently the widget tracker only tracks the main area widgets, not the ones opened in
 the side panel.
 ```
 
-#### IChatPanel
+### IChatPanel
 
 This token is a pointer to the left panel containing chats.\
 It can be used to programmatically open chat in the panel for example, or to list the
 opened chats.
 
-#### IAutocompletionRegistry
+### IAutocompletionRegistry
 
 This is the [autocompletion registry](#autocompletion-registry) used by the chat
 widgets.
 
 Autocompletion commands can be added to it, and then be used from the chat input.
 
-### Interact with the chat from the backend
+## Interact with the chat from the backend
 
 `jupyter_collaboration` provides a websocket server to handle every shared document
 on the server side. This websocket server allows to retrieve a shared document.
@@ -54,7 +52,7 @@ In addition, when a shared document is created, an event is emitted. We can use
 event to trigger a connection to the shared document.
 
 Here's an example of a server extension that responds to every message received in one
-of the collaborative chats:
+of the chats:
 
 ```python
 import jupyter_collaboration
@@ -85,7 +83,7 @@ class MyExtension(ExtensionApp):
     name = "my_extension"
     app_name = "My Extension"
     description = """
-    this extension interact with collaborative chats
+    this extension interact with chats
     """
 
     def initialize(self):
@@ -101,7 +99,7 @@ class MyExtension(ExtensionApp):
             and data["action"] == "initialize"\
             and data["msg"] == "Room initialized":
 
-            self.log.info(f"Collaborative chat server is listening for {data["room"]}")
+            self.log.info(f"Chat server is listening for {data["room"]}")
             chat = await self.get_chat(data["room"])
             callback = partial(self.on_change, chat)
             chat.ymessages.observe(callback)

docs/source/developers/developing_extensions/using-chat-extensions.md renamed to docs/source/developers/developing_extensions/using-chat-extension.md

@@ -7,7 +7,7 @@ This documentation includes several projects all together:
 - `@jupyter/chat`, a front-end package (typescript), including all the components
 required to build a chat. This package is designed to be used in an extension.
 
-- `jupyterlab-collaborative-chat`, an extension built on top of `@jupyter/chat`, using
+- `jupyterlab-chat`, an extension built on top of `@jupyter/chat`, using
 the collaborative edition as messaging system.
 
 ```{toctree}

docs/source/index.md

@@ -1,26 +1,26 @@
 # Users
 
-## Collaborative chat
+## Chat extension
 
-The `jupyterlab-collaborative-chat` extension adds collaborative chats to jupyterlab.
+The `jupyterlab-chat` extension adds chats to jupyterlab.
 
-![collaborative chat](../_static/images/collaboarative-chat.png)
+![chat widgets](../_static/images/chat-widgets.png)
 
 These chats use [jupyter_collaboration](https://jupyterlab-realtime-collaboration.readthedocs.io/en/latest/),
 the collaborative edition of documents in jupyterlab.
 
-### Install collaborative chat
+### Install chat extension
 
-The collaborative chat is available on [PyPI](https://pypi.org/project/jupyterlab-collaborative-chat/).
+The chat extension is available on [PyPI](https://pypi.org/project/jupyterlab-chat/).
 
 ```bash
-pip install jupyterlab-collaborative-chat
+pip install jupyterlab-chat
 ```
 
 To uninstall the package:
 
 ```bash
-pip uninstall jupyterlab-collaborative-chat
+pip uninstall jupyterlab-chat
 ```
 
 ### Create a chat

docs/source/users/index.md

@@ -23,7 +23,7 @@
   },
   "workspaces": [
     "packages/*",
-    "python/jupyterlab-collaborative-chat"
+    "python/jupyterlab-chat"
   ],
   "scripts": {
     "build": "lerna run build --stream",

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "jupyterlab-collaborative-chat",
+  "name": "jupyterlab-chat",
   "version": "0.5.0",
   "description": "The library to build a chat based on shared document",
   "keywords": [

packages/jupyterlab-collaborative-chat/babel.config.js renamed to packages/jupyterlab-chat/babel.config.js

@@ -7,7 +7,7 @@
  * Example of [Jest](https://jestjs.io/docs/getting-started) unit tests
  */
 
-describe('jupyterlab-collaborative-chat', () => {
+describe('jupyterlab-chat', () => {
   it('should be tested', () => {
     expect(1 + 1).toEqual(2);
   });