add JS lint workflow (#230)

* Fixes error and omission in config files * Changes after running jlpm lint once * Modifies eslint config * Ignores dotfiles * Fix lint errors * Fixes or ignores eslint warnings * Add new workflow * Fix error in config * Runs linting only on Linux * Uses standard GitHub action for setup-node * Force yarn used for caching * Simplify test config * Adds reopen trigger * fix lint workflow --------- Co-authored-by: David L. Qiu <david@qiu.dev>
jupyterlab · Jun 21, 2023 · 4470155 · 4470155
1 parent f32c699
commit 4470155
Show file tree

Hide file tree

Showing 25 changed files with 175 additions and 134 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -0,0 +1,19 @@
+name: JS Lint
+on:
+  - pull_request
+
+jobs:
+  js_lint:
+    name: JS Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+        with:
+          python_version: "3.10.x"
+      - name: Install JupyterLab
+        run: pip install jupyterlab~=3.6
+      - name: Install JS dependencies
+        run: jlpm
+      - name: Run JS Lint
+        run: jlpm lerna run lint:check
diff --git a/packages/jupyter-ai/.eslintignore b/packages/jupyter-ai/.eslintignore
@@ -6,3 +6,5 @@ tests
 
 **/__tests__
 ui-tests
+
+.*.js
diff --git a/packages/jupyter-ai/.eslintrc.js b/packages/jupyter-ai/.eslintrc.js
@@ -7,6 +7,7 @@ module.exports = {
   ],
   parser: '@typescript-eslint/parser',
   parserOptions: {
+    tsconfigRootDir: __dirname,
     project: './tsconfig.json'
   },
   plugins: ['@typescript-eslint'],
@@ -35,7 +36,9 @@ module.exports = {
     eqeqeq: 'error',
     'prefer-arrow-callback': 'error'
   },
-  overrides: {
-    files: ['src/**/*']
-  }
+  overrides: [
+    {
+      files: ['src/**/*']
+    }
+  ]
 };
diff --git a/packages/jupyter-ai/.stylelintrc b/packages/jupyter-ai/.stylelintrc
@@ -6,6 +6,7 @@
   ],
   "rules": {
     "property-no-vendor-prefix": null,
+    "selector-class-pattern": null,
     "selector-no-vendor-prefix": null,
     "value-no-vendor-prefix": null
   }

diff --git a/packages/jupyter-ai/README.md b/packages/jupyter-ai/README.md
@@ -34,7 +34,7 @@ First, install [conda](https://conda.io/projects/conda/en/latest/user-guide/inst
 
 If you are using an Apple Silicon-based Mac (M1, M1 Pro, M2, etc.), you need to uninstall the `pip` provided version of `grpcio` and install the version provided by `conda` instead.
 
-    $ pip uninstall grpcio; conda install grpcio 
+    $ pip uninstall grpcio; conda install grpcio
 
 ## Uninstall
 

diff --git a/packages/jupyter-ai/src/chat_handler.ts b/packages/jupyter-ai/src/chat_handler.ts
@@ -14,7 +14,7 @@ export class ChatHandler implements IDisposable {
   /**
    * ID of the connection. Requires `await initialize()`.
    */
-  id: string = '';
+  id = '';
 
   /**
    * Create a new chat handler.
@@ -29,11 +29,10 @@ export class ChatHandler implements IDisposable {
    * resolved when server acknowledges connection and sends the client ID. This
    * must be awaited before calling any other method.
    */
-  public async initialize() {
+  public async initialize(): Promise<void> {
     await this._initialize();
   }
 
-
   /**
    * Sends a message across the WebSocket. Promise resolves to the message ID
    * when the server sends the same message back, acknowledging receipt.
@@ -141,13 +140,13 @@ export class ChatHandler implements IDisposable {
   > = {};
 
   private _onClose(e: CloseEvent, reject: any) {
-    reject(new Error("Chat UI websocket disconnected"))
-    console.error("Chat UI websocket disconnected")
+    reject(new Error('Chat UI websocket disconnected'));
+    console.error('Chat UI websocket disconnected');
     // only attempt re-connect if there was an abnormal closure
     // WebSocket status codes defined in RFC 6455: https://www.rfc-editor.org/rfc/rfc6455.html#section-7.4.1
     if (e.code === 1006) {
-      const delaySeconds = 1
-      console.info(`Will try to reconnect in ${delaySeconds} s.`)
+      const delaySeconds = 1;
+      console.info(`Will try to reconnect in ${delaySeconds} s.`);
       setTimeout(async () => await this._initialize(), delaySeconds * 1000);
     }
   }
@@ -157,28 +156,28 @@ export class ChatHandler implements IDisposable {
       if (this.isDisposed) {
         return;
       }
-      console.log("Creating a new websocket connection for chat...");
+      console.log('Creating a new websocket connection for chat...');
       const { token, WebSocket, wsUrl } = this.serverSettings;
       const url =
         URLExt.join(wsUrl, CHAT_SERVICE_URL) +
         (token ? `?token=${encodeURIComponent(token)}` : '');
-      
-        const socket = (this._socket = new WebSocket(url));
-        socket.onclose = (e) => this._onClose(e, reject);
-        socket.onerror = (e) => reject(e);
-        socket.onmessage = msg =>
-          msg.data && this._onMessage(JSON.parse(msg.data));
-        
-        const listenForConnection = (message: AiService.Message) => {
-          if (message.type !== 'connection') {
-            return;
-          }
-          this.id = message.client_id;
-          resolve();
-          this.removeListener(listenForConnection);
-        };
-  
-        this.addListener(listenForConnection);
+
+      const socket = (this._socket = new WebSocket(url));
+      socket.onclose = e => this._onClose(e, reject);
+      socket.onerror = e => reject(e);
+      socket.onmessage = msg =>
+        msg.data && this._onMessage(JSON.parse(msg.data));
+
+      const listenForConnection = (message: AiService.Message) => {
+        if (message.type !== 'connection') {
+          return;
+        }
+        this.id = message.client_id;
+        resolve();
+        this.removeListener(listenForConnection);
+      };
+
+      this.addListener(listenForConnection);
     });
   }
 

diff --git a/packages/jupyter-ai/src/components/chat-code-view.tsx b/packages/jupyter-ai/src/components/chat-code-view.tsx
@@ -83,7 +83,7 @@ export function ChatCodeView({
   inline,
   className,
   ...props
-}: ChatCodeViewProps) {
+}: ChatCodeViewProps): JSX.Element {
   const match = /language-(\w+)/.exec(className || '');
   return inline ? (
     <ChatCodeInline {...props} />

diff --git a/packages/jupyter-ai/src/components/chat-input.tsx b/packages/jupyter-ai/src/components/chat-input.tsx
@@ -27,53 +27,59 @@ type ChatInputProps = {
 };
 
 export function ChatInput(props: ChatInputProps): JSX.Element {
-
   function handleKeyDown(event: React.KeyboardEvent<HTMLInputElement>) {
-    if (event.key === 'Enter' && (
-      (props.sendWithShiftEnter && event.shiftKey)
-      || (!props.sendWithShiftEnter && !event.shiftKey)
-    )) {
+    if (
+      event.key === 'Enter' &&
+      ((props.sendWithShiftEnter && event.shiftKey) ||
+        (!props.sendWithShiftEnter && !event.shiftKey))
+    ) {
       props.onSend();
       event.stopPropagation();
       event.preventDefault();
     }
   }
 
   // Set the helper text based on whether Shift+Enter is used for sending.
-  const helperText = props.sendWithShiftEnter
-    ? <span>Press <b>Shift</b>+<b>Enter</b> to send message</span>
-    : <span>Press <b>Shift</b>+<b>Enter</b> to add a new line</span>;
+  const helperText = props.sendWithShiftEnter ? (
+    <span>
+      Press <b>Shift</b>+<b>Enter</b> to send message
+    </span>
+  ) : (
+    <span>
+      Press <b>Shift</b>+<b>Enter</b> to add a new line
+    </span>
+  );
 
   return (
     <Box sx={props.sx}>
-      <Box sx={{ display: 'flex'}}>
+      <Box sx={{ display: 'flex' }}>
         <TextField
           value={props.value}
           onChange={e => props.onChange(e.target.value)}
           fullWidth
           variant="outlined"
           multiline
           onKeyDown={handleKeyDown}
-          placeholder='Ask Jupyternaut anything'
+          placeholder="Ask Jupyternaut anything"
           InputProps={{
             endAdornment: (
-               <InputAdornment position="end">
-                  <IconButton
-                    size="small"
-                    color="primary"
-                    onClick={props.onSend}
-                    disabled={!props.value.trim().length}
-                    title='Send message (SHIFT+ENTER)'
-                  >
-                    <SendIcon />
-                  </IconButton>
-               </InputAdornment>
+              <InputAdornment position="end">
+                <IconButton
+                  size="small"
+                  color="primary"
+                  onClick={props.onSend}
+                  disabled={!props.value.trim().length}
+                  title="Send message (SHIFT+ENTER)"
+                >
+                  <SendIcon />
+                </IconButton>
+              </InputAdornment>
             )
-         }}
-         FormHelperTextProps={{
-          sx: {marginLeft: 'auto', marginRight: 0}
-         }}
-         helperText={props.value.length > 2 ? helperText : ' '}
+          }}
+          FormHelperTextProps={{
+            sx: { marginLeft: 'auto', marginRight: 0 }
+          }}
+          helperText={props.value.length > 2 ? helperText : ' '}
         />
       </Box>
       {props.hasSelection && (

diff --git a/packages/jupyter-ai/src/components/chat-messages.tsx b/packages/jupyter-ai/src/components/chat-messages.tsx
@@ -22,7 +22,7 @@ type ChatMessageHeaderProps = {
   sx?: SxProps<Theme>;
 };
 
-export function ChatMessageHeader(props: ChatMessageHeaderProps) {
+export function ChatMessageHeader(props: ChatMessageHeaderProps): JSX.Element {
   const collaborators = useCollaboratorsContext();
 
   const sharedStyles: SxProps<Theme> = {
@@ -101,25 +101,24 @@ export function ChatMessageHeader(props: ChatMessageHeaderProps) {
   );
 }
 
-export function ChatMessages(props: ChatMessagesProps) {
+export function ChatMessages(props: ChatMessagesProps): JSX.Element {
   const [timestamps, setTimestamps] = useState<Record<string, string>>({});
 
   /**
    * Effect: update cached timestamp strings upon receiving a new message.
    */
   useEffect(() => {
     const newTimestamps: Record<string, string> = { ...timestamps };
-    let timestampAdded: boolean = false;
+    let timestampAdded = false;
 
     for (const message of props.messages) {
       if (!(message.id in newTimestamps)) {
         // Use the browser's default locale
-        newTimestamps[message.id] =
-          new Date(message.time * 1000) // Convert message time to milliseconds
-            .toLocaleTimeString([], {
-              hour: 'numeric', // Avoid leading zero for hours; we don't want "03:15 PM"
-              minute: '2-digit'
-            });
+        newTimestamps[message.id] = new Date(message.time * 1000) // Convert message time to milliseconds
+          .toLocaleTimeString([], {
+            hour: 'numeric', // Avoid leading zero for hours; we don't want "03:15 PM"
+            minute: '2-digit'
+          });
 
         timestampAdded = true;
       }

diff --git a/packages/jupyter-ai/src/components/chat-settings.tsx b/packages/jupyter-ai/src/components/chat-settings.tsx
@@ -74,7 +74,7 @@ function fromRegistryProvider(
  * provider is not a registry provider. Otherwise, it is set to
  * `<provider-id>:*`.
  */
-export function ChatSettings() {
+export function ChatSettings(): JSX.Element {
   const [state, setState] = useState<ChatSettingsState>(
     ChatSettingsState.Loading
   );

diff --git a/packages/jupyter-ai/src/components/chat.tsx b/packages/jupyter-ai/src/components/chat.tsx
@@ -21,10 +21,13 @@ import { ScrollContainer } from './scroll-container';
 
 type ChatBodyProps = {
   chatHandler: ChatHandler;
-  setChatView: (view: ChatView) => void
+  setChatView: (view: ChatView) => void;
 };
 
-function ChatBody({ chatHandler, setChatView: chatViewHandler }: ChatBodyProps): JSX.Element {
+function ChatBody({
+  chatHandler,
+  setChatView: chatViewHandler
+}: ChatBodyProps): JSX.Element {
   const [messages, setMessages] = useState<AiService.ChatMessage[]>([]);
   const [showWelcomeMessage, setShowWelcomeMessage] = useState<boolean>(false);
   const [includeSelection, setIncludeSelection] = useState(true);
@@ -106,9 +109,9 @@ function ChatBody({ chatHandler, setChatView: chatViewHandler }: ChatBodyProps):
   };
 
   const openSettingsView = () => {
-    setShowWelcomeMessage(false)
-    chatViewHandler(ChatView.Settings)
-  }
+    setShowWelcomeMessage(false);
+    chatViewHandler(ChatView.Settings);
+  };
 
   if (showWelcomeMessage) {
     return (
@@ -127,13 +130,13 @@ function ChatBody({ chatHandler, setChatView: chatViewHandler }: ChatBodyProps):
             model to chat with from the settings panel. You will also likely
             need to provide API credentials, so be sure to have those handy.
           </p>
-          <Button 
-            variant="contained" 
-            startIcon={<SettingsIcon />} 
+          <Button
+            variant="contained"
+            startIcon={<SettingsIcon />}
             size={'large'}
             onClick={() => openSettingsView()}
-            >
-              Start Here
+          >
+            Start Here
           </Button>
         </Stack>
       </Box>
@@ -175,15 +178,15 @@ export type ChatProps = {
   selectionWatcher: SelectionWatcher;
   chatHandler: ChatHandler;
   globalAwareness: Awareness | null;
-  chatView?: ChatView
+  chatView?: ChatView;
 };
 
 enum ChatView {
   Chat,
   Settings
 }
 
-export function Chat(props: ChatProps) {
+export function Chat(props: ChatProps): JSX.Element {
   const [view, setView] = useState<ChatView>(props.chatView || ChatView.Chat);
 
   return (
@@ -221,7 +224,7 @@ export function Chat(props: ChatProps) {
             </Box>
             {/* body */}
             {view === ChatView.Chat && (
-              <ChatBody chatHandler={props.chatHandler} setChatView={setView}/>
+              <ChatBody chatHandler={props.chatHandler} setChatView={setView} />
             )}
             {view === ChatView.Settings && <ChatSettings />}
           </Box>

diff --git a/packages/jupyter-ai/src/components/jl-theme-provider.tsx b/packages/jupyter-ai/src/components/jl-theme-provider.tsx
@@ -3,7 +3,9 @@ import React, { useState, useEffect } from 'react';
 import { Theme, ThemeProvider, createTheme } from '@mui/material/styles';
 import { getJupyterLabTheme } from '../theme-provider';
 
-export function JlThemeProvider(props: { children: React.ReactNode }) {
+export function JlThemeProvider(props: {
+  children: React.ReactNode;
+}): JSX.Element {
   const [theme, setTheme] = useState<Theme>(createTheme());
 
   useEffect(() => {