index.ts

// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.

import {
  IRouter,
  JupyterFrontEnd,
  JupyterFrontEndPlugin
} from '@jupyterlab/application';

import { PageConfig } from '@jupyterlab/coreutils';

import { ITerminalTracker } from '@jupyterlab/terminal';

import { find } from '@lumino/algorithm';

/**
 * A plugin to open terminals in a new tab
 */
const opener: JupyterFrontEndPlugin<void> = {
  id: '@retrolab/terminal-extension:opener',
  requires: [IRouter],
  autoStart: true,
  activate: (app: JupyterFrontEnd, router: IRouter) => {
    const { commands } = app;
    const terminalPattern = new RegExp('/terminals/(.*)');

    const command = 'router:terminal';
    commands.addCommand(command, {
      execute: (args: any) => {
        const parsed = args as IRouter.ILocation;
        const matches = parsed.path.match(terminalPattern);
        if (!matches) {
          return;
        }
        const [, name] = matches;
        if (!name) {
          return;
        }

        commands.execute('terminal:open', { name });
      }
    });

    router.register({ command, pattern: terminalPattern });
  }
};

/**
 * Open terminals in a new tab.
 */
const redirect: JupyterFrontEndPlugin<void> = {
  id: '@retrolab/terminal-extension:redirect',
  requires: [ITerminalTracker],
  autoStart: true,
  activate: (app: JupyterFrontEnd, tracker: ITerminalTracker) => {
    const baseUrl = PageConfig.getBaseUrl();
    tracker.widgetAdded.connect((send, terminal) => {
      const widget = find(app.shell.widgets('main'), w => w.id === terminal.id);
      if (widget) {
        // bail if the terminal is already added to the main area
        return;
      }
      const name = terminal.content.session.name;
      window.open(`${baseUrl}retro/terminals/${name}`, '_blank');

      // dispose the widget since it is not used on this page
      terminal.dispose();
    });
  }
};

/**
 * Export the plugins as default.
 */
const plugins: JupyterFrontEndPlugin<any>[] = [opener, redirect];

export default plugins;