Changelog#

1.6.0#

JupyterLite Terminal 1.6.0 adds a new coincident web worker which is used in deployments that are served cross-origin isolated, otherwise the default comlink web worker is used. The coincident web worker uses SharedArrayBuffer to access the JupyterLite shared drive whereas the comlink web worker uses the Service Worker. The JupyterLite pyodide and xeus kernels work in the same way. You can check which web worker is being used via cockle-config --worker or cockle-config -w. There is no functional change here for users of the JupyterLite terminal, but downstream developers who are inheriting from and modifying these libraries may have to make changes to support the choice of web worker.

The synchronous stdin options are kept separate to the choice of web worker. This means that the coincident worker supports stdin via both SharedArrayBuffer and Service Worker whereas the comlink worker only supports it via Service Worker.

(Full Changelog)

Enhancements made#

Implement shared drive using SharedArrayBuffer #124 (@ianthomas23, @juntyr)

Maintenance and upkeep improvements#

Prepare for 1.6.0 release #125 (@ianthomas23)
Switch from jupyterlab-builder to jupyter-builder #123 (@ianthomas23)

Contributors to this release#

The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.

(GitHub contributors page for this release)

@ianthomas23 (activity) | @juntyr (activity)

1.5.1#

JupyterLite Terminal 1.5.1 is a bug fix release to correctly support use of JupyterLite 0.7 and 0.8 in downstream projects.

(Full Changelog)

Bugs fixed#

Support both 0.7 and 0.8 jupyterlite npm packages #121 (@ianthomas23)

Maintenance and upkeep improvements#

Prepare for 1.5.1 release #122 (@ianthomas23)

Contributors to this release#

The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.

(GitHub contributors page for this release)

@ianthomas23 (activity)

1.5.0#

JupyterLite Terminal 1.5.0 adds JupyterLab commands so that terminal commands can be run programmatically from JupyterLab, and updates to Cockle 1.6.0.

(Full Changelog)

Enhancements made#

Update to cockle 1.6.0 #118 (@ianthomas23)
Support ability to subclass TerminalAPIClient to createShell #116 (@ianthomas23)
Update to cockle 1.5.2-a0 #112 (@ianthomas23)
Add JupyterLab commands for programmatic use #110 (@jtpio, @ianthomas23)

Maintenance and upkeep improvements#

Prepare for 1.5.0 release #120 (@ianthomas23)
Bump the actions group with 2 updates #119 (@ianthomas23)
Add eslint sort imports rule #117 (@ianthomas23)
Allow jupyterlite-core 0.8.0 #113 (@jtpio, @ianthomas23)
Bump Galata and Playwright #111 (@jtpio, @ianthomas23)

Contributors to this release#

The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.

(GitHub contributors page for this release)

@ianthomas23 (activity) | @jtpio (activity)

1.4.1#

This is a bug fix release to fix the use of backspace in WebAssembly commands, in particular nano and vim.

(Full Changelog)

Maintenance and upkeep improvements#

Update to cockle 1.5.1 #109 (@ianthomas23)
Remove pyodide kernel from demo deployments #108 (@ianthomas23)

Contributors to this release#

The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.

(GitHub contributors page for this release)

@ianthomas23 (activity)

1.4.0#

This release updates cockle to 1.5.0, which adds new commands du and unset, implements line vs character buffering on stdin, and introduces a yes/no prompt before displaying a large number of tab completion options. For the full cockle changelog see cockle releases.

(Full Changelog)

Maintenance and upkeep improvements#

Update to cockle 1.5.0 #107 (@ianthomas23)
Fix UI tests by requesting correct file format #106 (@ianthomas23)
Bump the actions group with 2 updates #104 (@ianthomas23)
Bump the actions group across 1 directory with 2 updates #103 (@ianthomas23)

Contributors to this release#

The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.

(GitHub contributors page for this release)

@ianthomas23 (activity)

1.3.1#

This is a bug fix release updating to cockle 1.4.1 to include two bug fixes:

Use comma to separate multiple channels in COCKLE_WASM_EXTRA_CHANNEL env var https://github.com/jupyterlite/cockle/pull/293
Keep arguments with wildcards if filename expansion has no matches https://github.com/jupyterlite/cockle/pull/291

(Full Changelog)

Maintenance and upkeep improvements#

Avoid jupyterlite 0.7.4 #102 (@ianthomas23)
Run main CI on weekly schedule, and on demand via workflow_dispatch #100 (@ianthomas23)
Update to cockle 1.4.1 #99 (@ianthomas23)
Bump the actions group with 2 updates #98 (@ianthomas23)

Contributors to this release#

The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.

(GitHub contributors page for this release)

@ianthomas23 (activity)

1.3.0#

This release updates cockle to 1.4.0 which switches from using WebAssembly command packages built using Emscripten 3.1.73 to Emscripten 4.0.9 that are available on the emscripten-forge-4x channel.

(Full Changelog)

Maintenance and upkeep improvements#

Update README for 1.3.0 release #97 (@ianthomas23)
Add basic git2cpp tests #96 (@ianthomas23)
Update to cockle 1.4.0 #95 (@ianthomas23)
Update snapshots bot checkout and permission check #94 (@martinRenou, @ianthomas23)
Fix dependabot label #92 (@ianthomas23)
Bump the actions group with 3 updates #91 (@ianthomas23)
Bump the actions group with 7 updates #90 (@ianthomas23)
Add dependabot for github actions #89 (@ianthomas23)
Update README following 1.2.0 release #88 (@ianthomas23)

Contributors to this release#

The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.

(GitHub contributors page for this release)

@ianthomas23 (activity) | @martinRenou (activity)

1.2.0#

This release updates to jupyterlite 0.7.0 and cockle 1.3.0. The latter includes a fix for a significant bug when using the service worker for stdin when running interactive commands such as vim. For full details see the Cockle changelog.

(Full Changelog)

Enhancements made#

Update cockle from 1.2.0 to 1.3.0 #85 (@ianthomas23)
Add git2cpp to deployment #76 (@ianthomas23)

Maintenance and upkeep improvements#

Update to jupyterlite 0.7.0 #87 (@ianthomas23)
Make ui-tests more robust #86 (@ianthomas23)
Add python 3.14, remove 3.9 #84 (@ianthomas23)
Enforce type imports #82 (@ianthomas23)
Update to jupyterlite 0.7.0rc0 and jupyterlab 4.5.0 #81 (@ianthomas23)

Documentation improvements#

Update README for 1.1.0 release #80 (@ianthomas23)

Contributors to this release#

(GitHub contributors page for this release)

@github-actions | @ianthomas23

1.1.0#

This updates from cockle 1.0.0 to 1.2.0 bringing the following enhancements:

Support termios settings in JavaScript and External commands.
New environment variable COCKLE_DARK_MODE to indicate if terminal is currently dark or light mode.
Include shellId in all run and tab completion contexts.
Various improvements to tab completion.

For full details see the Cockle changelog.

(Full Changelog)

Enhancements made#

Update to cockle 1.2.0 #77 (@ianthomas23)
Pass on themeChanged boolean to cockle #75 (@ianthomas23)
Add terminalDisposed Signal to ILiteTerminalAPIClient #74 (@ianthomas23)
Support use of lite_dir when deploying #70 (@ianthomas23)

Maintenance and upkeep improvements#

Update to cockle 1.1.0 #72 (@ianthomas23)
Add github action containing link to Read the Docs PR preview #71 (@ianthomas23)
Remove use of vercel for demo deployment #69 (@ianthomas23)

Documentation improvements#

Add log and favicon to docs #73 (@ianthomas23)
Add infrastructure for project docs #68 (@ianthomas23)
Update docs for 1.0.1 release #66 (@ianthomas23)

Contributors to this release#

(GitHub contributors page for this release)

@github-actions | @ianthomas23 | @jtpio | @vercel

1.0.1#

This is a maintenance release to support JupyterLite 0.7 as well as 0.6.

(Full Changelog)

Maintenance and upkeep improvements#

Run CI on earliest and latest supported jupyterlite-core #65 (@ianthomas23)
Allow for JupyterLite 0.7 pre-releases #64 (@jtpio)

Contributors to this release#

(GitHub contributors page for this release)

@ianthomas23 | @jtpio | @vercel

1.0.0#

This is a major release introducing support for tab completion in built-in, external and javascript commands via CommandArguments classes. There are also new built-in commands false, true, help and which, and support for handling theme changes.

The changes in external commands, command contexts and command argument classes are backwards incompatible, hence the major version bump.

(Full Changelog)

Enhancements made#

Update to cockle 1.0.0 #63 (@ianthomas23)
Pass on theme change to cockle #62 (@ianthomas23)

Contributors to this release#

(GitHub contributors page for this release)

@ianthomas23 | @vercel

0.2.2#

This release adds support for the less command (with limitations), various enhancements to external commands (TypeScript commands that run in the main UI thread), and initial support to determine the terminal background color to identify dark mode.

(Full Changelog)

Enhancements made#

Update to cockle 0.1.2 #61 (@ianthomas23)

Bugs fixed#

Revert PR 57 #58 (@ianthomas23)
Disable jupyterlab’s terminal-manager extension #57 (@ianthomas23)

Maintenance and upkeep improvements#

Add UI tests for nano and vim commands #60 (@ianthomas23)

Contributors to this release#

(GitHub contributors page for this release)

@ianthomas23 | @jtpio | @vercel

0.2.1#

This is a bug fix release to fix bugs in URLs and the use of ServiceWorker for stdin from cockle 0.1.1.

(Full Changelog)

Maintenance and upkeep improvements#

Bump cockle to 0.1.1 #56 (@ianthomas23)

Contributors to this release#

(GitHub contributors page for this release)

0.2.0#

This release is a significant rewrite to work with JupyterLite 0.6.0 and to add support for using the JupyterLite ServiceWorker to provide stdin whilst commands are running, as an alternative to the existing SharedArrayBuffer implementation. Use of a ServiceWorker means it is no longer necessary to serve the terminal extension using cross-origin headers.

If served with cross-origin headers both the SharedArrayBuffer and ServiceWorker stdin implementations will be available, with SharedArrayBuffer used by default. The user can switch between them at runtime using the shell command cockle-config -s.

(Full Changelog)

Enhancements made#

Update to cockle 0.1.0 #55 (@ianthomas23)
Add experimental support for registering external commands #54 (@ianthomas23)
Implement extension using ITerminalAPIClient #53 (@ianthomas23)
Support use of service worker to handle stdin #51 (@ianthomas23)
Rewrite as JupyterLab frontend plugin #49 (@ianthomas23)
Update to cockle 0.0.18 to support nano and sed commands #48 (@ianthomas23)

Maintenance and upkeep improvements#

Update to jupyterlite 0.6.0 #52 (@ianthomas23)
Remove micromamba pin in CI #50 (@ianthomas23)

Contributors to this release#

(GitHub contributors page for this release)

@ianthomas23 | @jtpio | @vercel

0.2.0a0#

(Full Changelog)

Enhancements made#

Rewrite as JupyterLab frontend plugin #49 (@ianthomas23)
Update to cockle 0.0.18 to support nano and sed commands #48 (@ianthomas23)

Maintenance and upkeep improvements#

Remove micromamba pin in CI #50 (@ianthomas23)

Contributors to this release#

(GitHub contributors page for this release)

@ianthomas23 | @jtpio | @vercel

0.1.6#

(Full Changelog)

Enhancements made#

Build and use own shell web worker using DriveFS #47 (@ianthomas23)

Contributors to this release#

(GitHub contributors page for this release)

0.1.5#

(Full Changelog)

Enhancements made#

Implement terminal shutdown #41 (@ianthomas23)
Rename Terminals to TerminalManager #40 (@ianthomas23)
Update to jupyterlite 0.5.0 and jupyterlab 4.3.4 #39 (@ianthomas23)

Maintenance and upkeep improvements#

Update to cockle 0.0.15 #45 (@ianthomas23)
Update to cockle 0.0.13 #38 (@ianthomas23)

Contributors to this release#

(GitHub contributors page for this release)

@ianthomas23 | @vercel

0.1.4#

(Full Changelog)

Enhancements made#

Update to cockle 0.0.12, adding tree and vim commands #37 (@ianthomas23)
Add some file system tests #34 (@ianthomas23)
Add some playwright ui tests #33 (@ianthomas23)

Contributors to this release#

(GitHub contributors page for this release)

@ianthomas23 | @jtpio | @vercel

0.1.3#

(Full Changelog)

Enhancements made#

Support use of em-forge wasm files in standalone JupyterLite deployment #31 (@ianthomas23)

Contributors to this release#

(GitHub contributors page for this release)

0.1.2#

(Full Changelog)

Enhancements made#

Update to cockle 0.0.10 #30 (@ianthomas23)
Obtain wasm packages from emscripten-forge when building deployment #27 (@ianthomas23)

Maintenance and upkeep improvements#

Add config files to deploy to Vercel with the COOP / COEP headers #28 (@jtpio)

Documentation improvements#

Update link to the demo, add demo files #29 (@jtpio)
Add use of static-handler to README #26 (@ianthomas23)
Update readme with screenshot and extra http headers #25 (@ianthomas23)
Add better screenshot #24 (@ianthomas23)

Contributors to this release#

(GitHub contributors page for this release)

@ianthomas23 | @jtpio | @vercel

0.1.1#

(Full Changelog)

Enhancements made#

Remove WebWorker code that is now in cockle #21 (@ianthomas23)
Replace postMessage from webworker with comlink callback #16 (@ianthomas23)
Use WASM commands running in webworker #15 (@ianthomas23)

Bugs fixed#

Fix listing of terminals #11 (@jtpio)

Maintenance and upkeep improvements#

Update jupyterlite to 0.4.0 and cockle to 0.0.5 #18 (@ianthomas23)
Support JupyterLite 0.4.0 packages #14 (@jtpio)

Documentation improvements#

Add JupyterLite badge to the README #10 (@jtpio)
Add workflow for deploying a demo to GitHub Pages #9 (@jtpio)

Contributors to this release#

(GitHub contributors page for this release)

@ianthomas23 | @jtpio

0.1.0#

(Full Changelog)

Enhancements made#

Add missing dependencies and handling of terminal clients #2 (@jtpio)
Skip the browser check for now #1 (@jtpio)

Maintenance and upkeep improvements#

Reset version for initial release #8 (@jtpio)
Rename package to @jupyterlite/terminal #7 (@jtpio)

Contributors to this release#

(GitHub contributors page for this release)