Add chat command for user mention

Author: brichet

python/jupyterlab-chat/src/chat-commands/providers/user-mention.ts

@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+
+import { JupyterFrontEndPlugin } from '@jupyterlab/application';
+import {
+  IChatCommandProvider,
+  IChatCommandRegistry,
+  ChatCommand,
+  IInputModel
+} from '@jupyter/chat';
+import { LabChatModel } from 'jupyterlab-chat';
+import { JSONObject } from '@lumino/coreutils';
+
+export class MentionCommandProvider implements IChatCommandProvider {
+  public id: string = 'jupyter-chat:mention-commands';
+
+  // regex used to test the current word
+  private _regex: RegExp = /^@[\w-]*:?/;
+
+  async getChatCommands(inputModel: IInputModel, chatModel: LabChatModel) {
+    const match = inputModel.currentWord?.match(this._regex)?.[0];
+    if (!match) {
+      return [];
+    }
+
+    // Get the user list from the chat file.
+    const users = Object.values(chatModel.sharedModel.users).map(user => {
+      user = user as JSONObject;
+      return (user.display_name ?? user.name ?? user.username) as string;
+    });
+
+    // Add the users connected to the chat (even if they never sent a message).
+    chatModel.sharedModel.awareness.getStates().forEach(value => {
+      const user = value.user;
+      if (!user) {
+        return;
+      }
+      const username = (user.display_name ??
+        user.name ??
+        user.username) as string;
+      if (username && !users.includes(username)) {
+        users.push(username);
+      }
+    });
+
+    // Build the commands for each user.
+    const commands = users
+      .sort()
+      .filter(user => `@${user.replace(/ /g, '-')}`.startsWith(match))
+      .map(user => {
+        return {
+          name: `@${user.replace(/ /g, '-')}`,
+          replaceWith: `@${user}`,
+          providerId: this.id
+        };
+      });
+    return commands;
+  }
+
+  async handleChatCommand(
+    command: ChatCommand,
+    inputModel: IInputModel,
+    chatModel: LabChatModel
+  ): Promise<void> {
+    // no handling needed because `replaceWith` is set in each command.
+    return;
+  }
+}
+
+export const mentionCommandsPlugin: JupyterFrontEndPlugin<void> = {
+  id: 'jupyterlab-chat-extension:mentionCommandsPlugin',
+  description: 'Plugin which adds user mention commands.',
+  autoStart: true,
+  requires: [IChatCommandRegistry],
+  activate: (app, registry: IChatCommandRegistry) => {
+    registry.addProvider(new MentionCommandProvider());
+  }
+};

python/jupyterlab-chat/src/index.ts

@@ -64,6 +64,7 @@ import {
 } from 'jupyterlab-chat';
 import { chatCommandRegistryPlugin } from './chat-commands/plugins';
 import { emojiCommandsPlugin } from './chat-commands/providers/emoji';
+import { mentionCommandsPlugin } from './chat-commands/providers/user-mention';
 
 const FACTORY = 'Chat';
 
@@ -799,5 +800,6 @@ export default [
   docFactories,
   selectionWatcher,
   chatCommandRegistryPlugin,
-  emojiCommandsPlugin
+  emojiCommandsPlugin,
+  mentionCommandsPlugin
 ];