@jupyterlite/terminal 1.0.0 → 1.1.0

package/README.md

@@ -1,7 +1,7 @@
-# jupyterlite-terminal
+# JupyterLite Terminal
 
 [![Github Actions Status](https://github.com/jupyterlite/terminal/workflows/Build/badge.svg)](https://github.com/jupyterlite/terminal/actions/workflows/build.yml)
-[![lite-badge](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)](https://jupyterlite-terminal.vercel.app/)
+[![lite-badge](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)](https://jupyterlite.github.io/terminal/)
 
 A terminal for JupyterLite.
 
@@ -11,7 +11,7 @@ A terminal for JupyterLite.
 
 ## Requirements
 
-- JupyterLite >= 0.6.0
+- JupyterLite >= 0.6.0, < 0.8.0
 
 ## Install
 
@@ -54,6 +54,7 @@ include imports from both `jupyterlite-terminal` and `cockle`, such as if you ar
 
 | `jupyterlite-terminal` | `cockle` | `jupyterlite-core` |
 | ---------------------- | -------- | ------------------ |
+| 1.0.1                  | 1.0.0    | >= 0.6, < 0.8      |
 | 1.0.0                  | 1.0.0    | >= 0.6, < 0.7      |
 | 0.2.2                  | 0.1.3    | >= 0.6, < 0.7      |
 
@@ -118,6 +119,25 @@ or:
 jupyter lite serve --LiteBuildConfig.extra_http_headers=Cross-Origin-Embedder-Policy=require-corp --LiteBuildConfig.extra_http_headers=Cross-Origin-Opener-Policy=same-origin
 ```
 
+### Building the documentation
+
+The project documentation includes a demo deployment, and is built on every PR so that the changes can be checked manually before merging. To build the documentation and demo locally use:
+
+```bash
+micromamba create -f docs/environment-docs.yml
+micromamba activate terminal-docs
+pip install -v .
+cd docs
+make html
+```
+
+To serve this locally use:
+
+```bash
+cd _build/html
+python -m http.server
+```
+
 ### Packaging the extension
 
 See [RELEASE](RELEASE.md)

package/lib/client.d.ts

@@ -1,5 +1,6 @@
 import { ServerConnection, Terminal } from '@jupyterlab/services';
 import { IExternalCommand, IStdinReply, IStdinRequest } from '@jupyterlite/cockle';
+import { ISignal } from '@lumino/signaling';
 import { ILiteTerminalAPIClient } from './tokens';
 export declare class LiteTerminalAPIClient implements ILiteTerminalAPIClient {
     constructor(options?: {
@@ -21,6 +22,7 @@ export declare class LiteTerminalAPIClient implements ILiteTerminalAPIClient {
     registerEnvironmentVariable(key: string, value: string | undefined): void;
     registerExternalCommand(options: IExternalCommand.IOptions): void;
     shutdown(name: string): Promise<void>;
+    get terminalDisposed(): ISignal<this, string>;
     themeChange(isDarkMode?: boolean): void;
     private get _models();
     private _nextAvailableName;
@@ -30,4 +32,5 @@ export declare class LiteTerminalAPIClient implements ILiteTerminalAPIClient {
     private _externalCommands;
     private _shellManager;
     private _shells;
+    private _terminalDisposed;
 }

package/lib/client.js

@@ -1,6 +1,7 @@
 import { PageConfig, URLExt } from '@jupyterlab/coreutils';
 import { ServerConnection } from '@jupyterlab/services';
 import { ShellManager } from '@jupyterlite/cockle';
+import { Signal } from '@lumino/signaling';
 import { Server as WebSocketServer } from 'mock-socket';
 import { Shell } from './shell';
 export class LiteTerminalAPIClient {
@@ -8,6 +9,7 @@ export class LiteTerminalAPIClient {
         var _a;
         this._externalCommands = [];
         this._shells = new Map();
+        this._terminalDisposed = new Signal(this);
         this.serverSettings =
             (_a = options.serverSettings) !== null && _a !== void 0 ? _a : ServerConnection.makeSettings();
         this._shellManager = new ShellManager();
@@ -83,6 +85,7 @@ export class LiteTerminalAPIClient {
         shell.disposed.connect(() => {
             this.shutdown(name);
             wsServer.close();
+            this._terminalDisposed.emit(shell.shellId);
         });
         return { name };
     }
@@ -114,11 +117,12 @@ export class LiteTerminalAPIClient {
             shell.dispose();
         }
     }
+    get terminalDisposed() {
+        return this._terminalDisposed;
+    }
     themeChange(isDarkMode) {
         for (const shell of this._shells.values()) {
-            // Can pass isDarkMode when cockle is released with PR #232.
-            //shell.themeChange(isDarkMode);
-            shell.themeChange();
+            shell.themeChange(isDarkMode);
         }
     }
     get _models() {

package/lib/tokens.d.ts

@@ -1,6 +1,7 @@
 import { Terminal } from '@jupyterlab/services';
 import { IExternalCommand, IStdinReply, IStdinRequest } from '@jupyterlite/cockle';
 import { Token } from '@lumino/coreutils';
+import { ISignal } from '@lumino/signaling';
 export declare const ILiteTerminalAPIClient: Token<ILiteTerminalAPIClient>;
 export interface ILiteTerminalAPIClient extends Terminal.ITerminalAPIClient {
     /**
@@ -26,6 +27,11 @@ export interface ILiteTerminalAPIClient extends Terminal.ITerminalAPIClient {
      * Register an external command that will be available in all terminals.
      */
     registerExternalCommand(options: IExternalCommand.IOptions): void;
+    /**
+     * Signal emitted when a terminal is disposed.
+     * The string argument is the terminal `name` which is the same as the Shell's `shellId`.
+     */
+    terminalDisposed: ISignal<this, string>;
     /**
      * Inform all terminals that the theme has changed so that they can react to it if they wish.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@jupyterlite/terminal",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "description": "A terminal for JupyterLite",
     "keywords": [
         "jupyter",
@@ -63,10 +63,11 @@
         "@jupyterlab/coreutils": "^6.4.3",
         "@jupyterlab/services": "^7.4.3",
         "@jupyterlab/settingregistry": "^4.4.3",
-        "@jupyterlite/cockle": "^1.0.0",
+        "@jupyterlite/cockle": "^1.2.0",
         "@jupyterlite/contents": "^0.6.0",
         "@jupyterlite/server": "^0.6.0",
-        "@lumino/coreutils": "^2.2.0",
+        "@lumino/coreutils": "^2.2.1",
+        "@lumino/signaling": "^2.1.4",
         "mock-socket": "^9.3.1"
     },
     "devDependencies": {

package/src/client.ts

@@ -8,6 +8,7 @@ import {
   ShellManager
 } from '@jupyterlite/cockle';
 import { JSONPrimitive } from '@lumino/coreutils';
+import { ISignal, Signal } from '@lumino/signaling';
 
 import {
   Server as WebSocketServer,
@@ -111,6 +112,7 @@ export class LiteTerminalAPIClient implements ILiteTerminalAPIClient {
     shell.disposed.connect(() => {
       this.shutdown(name);
       wsServer.close();
+      this._terminalDisposed.emit(shell.shellId);
     });
 
     return { name };
@@ -148,12 +150,13 @@ export class LiteTerminalAPIClient implements ILiteTerminalAPIClient {
     }
   }
 
+  get terminalDisposed(): ISignal<this, string> {
+    return this._terminalDisposed;
+  }
+
   themeChange(isDarkMode?: boolean): void {
     for (const shell of this._shells.values()) {
-      // Can pass isDarkMode when cockle is released with PR #232.
-      //shell.themeChange(isDarkMode);
-
-      shell.themeChange();
+      shell.themeChange(isDarkMode);
     }
   }
 
@@ -178,4 +181,5 @@ export class LiteTerminalAPIClient implements ILiteTerminalAPIClient {
   private _externalCommands: IExternalCommand.IOptions[] = [];
   private _shellManager: IShellManager;
   private _shells = new Map<string, Shell>();
+  private _terminalDisposed = new Signal<this, string>(this);
 }

package/src/tokens.ts

@@ -5,6 +5,7 @@ import {
   IStdinRequest
 } from '@jupyterlite/cockle';
 import { Token } from '@lumino/coreutils';
+import { ISignal } from '@lumino/signaling';
 
 export const ILiteTerminalAPIClient = new Token<ILiteTerminalAPIClient>(
   '@jupyterlite/terminal:client'
@@ -39,6 +40,12 @@ export interface ILiteTerminalAPIClient extends Terminal.ITerminalAPIClient {
    */
   registerExternalCommand(options: IExternalCommand.IOptions): void;
 
+  /**
+   * Signal emitted when a terminal is disposed.
+   * The string argument is the terminal `name` which is the same as the Shell's `shellId`.
+   */
+  terminalDisposed: ISignal<this, string>;
+
   /**
    * Inform all terminals that the theme has changed so that they can react to it if they wish.
    */