Merge branch 'master' into patch-1

.gitignore

@@ -15,6 +15,7 @@ build/
 .vscode/
 .DS_Store
 fixtures/typings-test/*.js
+package-lock.json
 
 # Directories needed for code coverage
 /coverage/

.npmrc

@@ -0,0 +1 @@
+package-lock=false

AUTHORS

@@ -5,6 +5,7 @@ Aleksandr Andrienko <aandrienko@codenvy.com>
 Aleksandr Andriienko <oandriie@redhat.com>
 Alessandro Nadalin <alessandro.nadalin@gmail.com>
 Alexander Olsson <noseglid@gmail.com>
+Alexandre Petit-Pas <petitpasalexandre@gmail.com>
 Alexey Kontsevoy <alexey@gravitational.com>
 Andres Mejia <amejia004@gmail.com>
 Anish Athalye <me@anishathalye.com>
@@ -18,6 +19,7 @@ Austin Robertson <austinrobertson@gmail.com>
 ayapi <colors.aya@gmail.com>
 Ben Hall <ben@benhall.me.uk>
 Benjamin Fischer <benjamin.fischer@rwth-aachen.de>
+Benjamin Woodruff <github@benjam.info>
 Bill Church <billchurch@users.noreply.github.com>
 Bob Reid <bobreid@Bobs-MacBook-Pro.local>
 bottleofwater <nison.mael+bottleofwater@gmail.com>
@@ -32,6 +34,7 @@ Christopher Jeffrey <chjjeffrey@gmail.com>
 coderaiser <mnemonic.enemy@gmail.com>
 Damien Tournoud <damien@platform.sh>
 Dan Brown <jdanbrown@gmail.com>
+Daniel Griffen <dagriffe@microsoft.com>
 Daniel Griffen <daniel@griffen.io>
 Daniel Imms <daimms@microsoft.com>
 Daniel Risacher <drisacher@gmail.com>
@@ -43,6 +46,7 @@ Edgar Andrés Margffoy Tuay <andfoy@gmail.com>
 Elliot Saba <staticfloat@gmail.com>
 Exile <exile@chamber.ee>
 Felipe Gasper <felipe@felipegasper.com>
+Felix <30559812+felixse@users.noreply.github.com>
 ficristo <ficristo.work@gmail.com>
 Gary Ritchie <gary@rstudio.com>
 hiro-su <h.sugipon@gmail.com>
@@ -69,11 +73,13 @@ Lucian Buzzo <lucian.buzzo@gmail.com>
 Lukas Drgon <lukas.drgon@gmail.com>
 Maël Nison <nison.mael@gmail.com>
 Marc Dumais <marc.dumais@ericsson.com>
+Marek Libra <mlibra@redhat.com>
 Markus F.X.J. Oberhumer <markus@oberhumer.com>
 Martin Chloride <i@martincl2.me>
 Martin Koppehel <martin.koppehel@st.ovgu.de>
 Martin Wang <jiahaow@ca.ibm.com>
 Matt Bierner <matb@microsoft.com>
+Matthew James <matthew.d.james87@gmail.com>
 Michael Irwin <mikesir87@gmail.com>
 Mikko Karvonen <mikko.karvonen@arm.com>
 mofux <t.zilz@mofux.org>
@@ -83,6 +89,7 @@ Oleksandr Andriienko <oandriie@redhat.com>
 Paris Kasidiaris <pariskasidiaris@gmail.com>
 Paris Kasidiaris <paris@sourcelair.com>
 Peter Baumgarten <me@peterbaumgarten.com>
+Philip Olson <philip.olson@protonmail.ch>
 Rick Baker <rick@ricktbaker.com>
 runarberg <runar@greenqloud.com>
 Saad Malik <simfox3@gmail.com>

CONTRIBUTING.md

@@ -50,3 +50,7 @@ By contributing code to xterm.js you
    holder has explicitly granted the right to use it like this,
    through a compatible open source license or through a direct
    agreement with you.)
+
+### Third party dependencies
+
+We prefer to not include any non-dev third party dependencies in order to keep our code minimal, performant and secure. If you plan on adding a dependency on a third party library it's a good idea to discuss the need in an issue with the maintainers first.

Dockerfile

@@ -16,4 +16,4 @@ RUN npm install
 COPY . /usr/src/app
 
 # Run the tests and build, to make sure everything is working nicely
-RUN npm run build && npm run test
+RUN npm run build && npm run webpack && npm run test

README.md

@@ -76,6 +76,12 @@ var xterm = new Terminal();  // Instantiate the terminal
 xterm.fit();                 // Use the `fit` method, provided by the `fit` addon
 ```
 
+#### Third party addons
+
+There are also the following third party addons available:
+
+- [xterm-webfont](https://www.npmjs.com/package/xterm-webfont)
+
 ## Browser Support
 
 Since xterm.js is typically implemented as a developer tool, only modern browsers are supported officially. Here is a list of the versions we aim to support:
@@ -127,6 +133,7 @@ computational environment for Jupyter, supporting interactive data science and s
 - [**abstruse**](https://github.com/bleenco/abstruse): Abstruse CI is a continuous integration platform based on Node.JS and Docker.
 - [**Microsoft SQL Operations Studio**](https://github.com/Microsoft/sqlopsstudio): A data management tool that enables working with SQL Server, Azure SQL DB and SQL DW from Windows, macOS and Linux
 - [**FreeMAN**](https://github.com/matthew-matvei/freeman): A free, cross-platform file manager for power users
+- [**Fluent Terminal**](https://github.com/felixse/FluentTerminal): A terminal emulator based on UWP and web technologies.
 - [**Hyper**](https://hyper.is): A terminal built on web technologies
 
 Do you use xterm.js in your application as well? Please [open a Pull Request](https://github.com/sourcelair/xterm.js/pulls) to include it here. We would love to have it in our list.
@@ -145,7 +152,19 @@ Then open your project's [Public URL](https://help.sourcelair.com/projects/the-p
 
 ### Docker
 
-First, make sure you have Docker Engine 1.13.0 (or newer) and Docker Compose 1.10.0 (or newer). To run the demo and builder in parallel, run the following command in your terminal:
+First, make sure you have Docker Engine 1.13.0 (or newer) and Docker Compose 1.10.0 (or newer).
+
+Xterm.js [provides a pre-built Docker image](https://hub.docker.com/r/xtermjs/xterm.js/) to help run the demo easily (Git tags are built as [tagged Docker images](https://hub.docker.com/r/xtermjs/xterm.js/tags/) too).
+
+To run the just demo (with no editing access). run the following command in your terminal:
+
+```
+docker run -p 3000:3000 xtermjs/xterm.js
+```
+
+Then open http://0.0.0.0:3000 in a web browser to access the demo.
+
+To run the demo and builder in parallel, run the following command in your terminal:
 
 ```
 docker-compose up

demo/main.js

@@ -3,6 +3,7 @@ import * as attach from '../build/addons/attach/attach';
 import * as fit from '../build/addons/fit/fit';
 import * as fullscreen from '../build/addons/fullscreen/fullscreen';
 import * as search from '../build/addons/search/search';
+import * as webLinks from '../build/addons/webLinks/webLinks';
 import * as winptyCompat from '../build/addons/winptyCompat/winptyCompat';
 
 
@@ -10,6 +11,7 @@ Terminal.applyAddon(attach);
 Terminal.applyAddon(fit);
 Terminal.applyAddon(fullscreen);
 Terminal.applyAddon(search);
+Terminal.applyAddon(webLinks);
 Terminal.applyAddon(winptyCompat);
 
 
@@ -121,6 +123,7 @@ function createTerminal() {
 
   term.open(terminalContainer);
   term.winptyCompatInit();
+  term.webLinksInit();
   term.fit();
   term.focus();
 

demo/zmodem/app.js

@@ -7,16 +7,16 @@ var pty = require('node-pty');
 var terminals = {},
     logs = {};
 
-app.use('/build', express.static(__dirname + '/../../../../build'));
-app.use('/demo', express.static(__dirname + '/../../../../demo'));
-app.use('/zmodemjs', express.static(__dirname + '/../../../../node_modules/zmodem.js/dist'));
+app.use('/build', express.static(__dirname + '/../../build'));
+app.use('/demo', express.static(__dirname + '/../../demo'));
+app.use('/zmodemjs', express.static(__dirname + '/../../node_modules/zmodem.js/dist'));
 
 app.get('/', function(req, res){
   res.sendFile(__dirname + '/index.html');
 });
 
 app.get('/style.css', function(req, res){
-  res.sendFile(__dirname + '/style.css');
+  res.sendFile(__dirname + '../style.css');
 });
 
 app.get('/main.js', function(req, res){

demo/zmodem/main.js

@@ -6,6 +6,11 @@ var term,
     socket,
     pid;
 
+Terminal.applyAddon(fit);
+Terminal.applyAddon(attach);
+Terminal.applyAddon(zmodem);
+Terminal.applyAddon(search);
+
 var terminalContainer = document.getElementById('terminal-container'),
     actionElements = {
       findNext: document.querySelector('#find-next'),

docker-compose.yml

@@ -2,6 +2,7 @@ version: "3"
 
 services:
   web:
+    image: xtermjs/xterm.js:latest
     build: .
     volumes:
       - ./:/usr/src/app

gulpfile.js

@@ -23,7 +23,7 @@ const tsProject = ts.createProject('tsconfig.json');
 const srcDir = tsProject.config.compilerOptions.rootDir;
 let outDir = tsProject.config.compilerOptions.outDir;
 
-const addons = ['attach', 'fit', 'fullscreen', 'search', 'terminado', 'winptyCompat', 'zmodem'];
+const addons = fs.readdirSync(`${__dirname}/src/addons`);
 
 // Under some environments like TravisCI, this comes out at absolute which can
 // break the build. This ensures that the outDir is absolute.

jsdoc.json

@@ -1,26 +0,0 @@
-{
-  "source": {
-    "include": [
-      "src/"
-    ],
-    "exclude": [
-      "src/test/"
-    ],
-    "excludePattern": "src/.+\\.test\\.(js|ts)$"
-  },
-  "opts": {
-    "readme": "README.md",
-    "template": "node_modules/docdash",
-    "encoding": "utf8",
-    "destination": "docs/",
-    "recurse": true,
-    "verbose": true
-  },
-  "plugins": [
-    "plugins/markdown"
-  ],
-  "templates": {
-    "cleverLinks": false,
-    "monospaceLinks": false
-  }
-}

package.json

@@ -1,7 +1,7 @@
 {
   "name": "xterm",
   "description": "Full xterm terminal, in your browser",
-  "version": "3.1.0",
+  "version": "3.3.0",
   "ignore": [
     "demo",
     "test",
@@ -46,7 +46,6 @@
     "@types/text-encoding": "0.0.32",
     "browserify": "^13.3.0",
     "chai": "3.5.0",
-    "docdash": "0.4.0",
     "express": "4.13.4",
     "express-ws": "2.0.0-rc.1",
     "fs-extra": "^1.0.0",
@@ -65,6 +64,7 @@
     "merge-stream": "^1.0.1",
     "node-pty": "^0.7.2",
     "nodemon": "1.10.2",
+    "npm-run-all": "^4.1.2",
     "sorcery": "^0.10.0",
     "tslint": "^5.9.1",
     "typescript": "~2.7.1",
@@ -76,10 +76,10 @@
   },
   "scripts": {
     "start": "node demo/app",
-    "prestart-zmodem": "npm run build",
-    "start-zmodem": "node build/addons/zmodem/demo/app",
-    "lint": "tslint src/*.ts src/**/*.ts",
-    "test": "gulp test",
+    "start-zmodem": "node demo/zmodem/app",
+    "lint": "tslint src/*.ts src/**/*.ts src/addons/**/*.ts",
+    "test": "npm-run-all mocha lint",
+    "mocha": "gulp test",
     "build:docs": "jsdoc -c jsdoc.json",
     "tsc": "tsc",
     "build": "gulp build",

src/AccessibilityManager.ts

@@ -11,7 +11,6 @@ import { addDisposableListener } from './utils/Dom';
 import { IDisposable } from 'xterm';
 
 const MAX_ROWS_TO_READ = 20;
-const ACTIVE_ITEM_ID_PREFIX = 'xterm-active-item-';
 
 enum BoundaryPosition {
   Top,
@@ -21,7 +20,7 @@ enum BoundaryPosition {
 export class AccessibilityManager implements IDisposable {
   private _accessibilityTreeRoot: HTMLElement;
   private _rowContainer: HTMLElement;
-  private _rowElements: HTMLElement[] = [];
+  private _rowElements: HTMLElement[];
   private _liveRegion: HTMLElement;
   private _liveRegionLineCount: number = 0;
 
@@ -49,6 +48,7 @@ export class AccessibilityManager implements IDisposable {
 
     this._rowContainer = document.createElement('div');
     this._rowContainer.classList.add('xterm-accessibility-tree');
+    this._rowElements = [];
     for (let i = 0; i < this._terminal.rows; i++) {
       this._rowElements[i] = this._createAccessibilityTreeNode();
       this._rowContainer.appendChild(this._rowElements[i]);
@@ -93,14 +93,10 @@ export class AccessibilityManager implements IDisposable {
   }
 
   public dispose(): void {
-    this._terminal.element.removeChild(this._accessibilityTreeRoot);
     this._disposables.forEach(d => d.dispose());
-    this._disposables = null;
-    this._accessibilityTreeRoot = null;
-    this._rowContainer = null;
-    this._liveRegion = null;
-    this._rowContainer = null;
-    this._rowElements = null;
+    this._disposables.length = 0;
+    this._terminal.element.removeChild(this._accessibilityTreeRoot);
+    this._rowElements.length = 0;
   }
 
   private _onBoundaryFocus(e: FocusEvent, position: BoundaryPosition): void {
@@ -125,10 +121,10 @@ export class AccessibilityManager implements IDisposable {
     let bottomBoundaryElement: HTMLElement;
     if (position === BoundaryPosition.Top) {
       topBoundaryElement = boundaryElement;
-      bottomBoundaryElement = this._rowElements.pop();
+      bottomBoundaryElement = this._rowElements.pop()!;
       this._rowContainer.removeChild(bottomBoundaryElement);
     } else {
-      topBoundaryElement = this._rowElements.shift();
+      topBoundaryElement = this._rowElements.shift()!;
       bottomBoundaryElement = boundaryElement;
       this._rowContainer.removeChild(topBoundaryElement);
     }
@@ -174,7 +170,7 @@ export class AccessibilityManager implements IDisposable {
     }
     // Shrink rows as required
     while (this._rowElements.length > rows) {
-      this._rowContainer.removeChild(this._rowElements.pop());
+      this._rowContainer.removeChild(this._rowElements.pop()!);
     }
 
     // Add bottom boundary listener
@@ -218,7 +214,7 @@ export class AccessibilityManager implements IDisposable {
 
       // Only detach/attach on mac as otherwise messages can go unaccounced
       if (isMac) {
-        if (this._liveRegion.textContent.length > 0 && !this._liveRegion.parentNode) {
+        if (this._liveRegion.textContent && this._liveRegion.textContent.length > 0 && !this._liveRegion.parentNode) {
           setTimeout(() => {
             this._accessibilityTreeRoot.appendChild(this._liveRegion);
           }, 0);
@@ -265,7 +261,6 @@ export class AccessibilityManager implements IDisposable {
     if (!this._terminal.renderer.dimensions.actualCellHeight) {
       return;
     }
-    const buffer: IBuffer = this._terminal.buffer;
     for (let i = 0; i < this._terminal.rows; i++) {
       this._refreshRowDimensions(this._rowElements[i]);
     }

src/Buffer.test.ts

@@ -188,4 +188,28 @@ describe('Buffer', () => {
       assert.equal(buffer.lines.maxLength, INIT_ROWS / 2);
     });
   });
+
+  describe('addMarker', () => {
+    it('should adjust a marker line when the buffer is trimmed', () => {
+      terminal.options.scrollback = 0;
+      buffer = new Buffer(terminal, true);
+      buffer.fillViewportRows();
+      const marker = buffer.addMarker(buffer.lines.length - 1);
+      assert.equal(marker.line, buffer.lines.length - 1);
+      buffer.lines.emit('trim', 1);
+      assert.equal(marker.line, buffer.lines.length - 2);
+    });
+    it('should dispose of a marker if it is trimmed off the buffer', () => {
+      terminal.options.scrollback = 0;
+      buffer = new Buffer(terminal, true);
+      buffer.fillViewportRows();
+      assert.equal(buffer.markers.length, 0);
+      const marker = buffer.addMarker(0);
+      assert.equal(marker.isDisposed, false);
+      assert.equal(buffer.markers.length, 1);
+      buffer.lines.emit('trim', 1);
+      assert.equal(marker.isDisposed, true);
+      assert.equal(buffer.markers.length, 0);
+    });
+  });
 });

src/Buffer.ts

@@ -5,6 +5,8 @@
 
 import { CircularList } from './utils/CircularList';
 import { LineData, CharData, ITerminal, IBuffer } from './Types';
+import { EventEmitter } from './EventEmitter';
+import { IDisposable, IMarker } from 'xterm';
 
 export const CHAR_DATA_ATTR_INDEX = 0;
 export const CHAR_DATA_CHAR_INDEX = 1;
@@ -31,6 +33,7 @@ export class Buffer implements IBuffer {
   public tabs: any;
   public savedY: number;
   public savedX: number;
+  public markers: Marker[] = [];
 
   /**
    * Create a new Buffer.
@@ -303,4 +306,49 @@ export class Buffer implements IBuffer {
     while (!this.tabs[++x] && x < this._terminal.cols);
     return x >= this._terminal.cols ? this._terminal.cols - 1 : x < 0 ? 0 : x;
   }
+
+  public addMarker(y: number): Marker {
+    const marker = new Marker(y);
+    this.markers.push(marker);
+    marker.disposables.push(this._lines.addDisposableListener('trim', amount => {
+      marker.line -= amount;
+      // The marker should be disposed when the line is trimmed from the buffer
+      if (marker.line < 0) {
+        marker.dispose();
+      }
+    }));
+    marker.on('dispose', () => this._removeMarker(marker));
+    return marker;
+  }
+
+  private _removeMarker(marker: Marker): void {
+    // TODO: This could probably be optimized by relying on sort order and trimming the array using .length
+    this.markers.splice(this.markers.indexOf(marker), 1);
+  }
+}
+
+export class Marker extends EventEmitter implements IMarker {
+  private static NEXT_ID = 1;
+
+  private _id: number = Marker.NEXT_ID++;
+  public isDisposed: boolean = false;
+  public disposables: IDisposable[] = [];
+
+  public get id(): number { return this._id; }
+
+  constructor(
+    public line: number
+  ) {
+    super();
+  }
+
+  public dispose(): void {
+    if (this.isDisposed) {
+      return;
+    }
+    this.isDisposed = true;
+    this.disposables.forEach(d => d.dispose());
+    this.disposables.length = 0;
+    this.emit('dispose');
+  }
 }

src/CharWidth.ts

@@ -49,7 +49,7 @@ export const wcwidth = (function(opts: {nul: number, control: number}): (ucs: nu
       [0x206A, 0x206F], [0x20D0, 0x20EF], [0x302A, 0x302F],
       [0x3099, 0x309A], [0xA806, 0xA806], [0xA80B, 0xA80B],
       [0xA825, 0xA826], [0xFB1E, 0xFB1E], [0xFE00, 0xFE0F],
-      [0xFE20, 0xFE23], [0xFEFF, 0xFEFF], [0xFFF9, 0xFFFB],
+      [0xFE20, 0xFE23], [0xFEFF, 0xFEFF], [0xFFF9, 0xFFFB]
     ];
     const COMBINING_HIGH = [
       [0x10A01, 0x10A03], [0x10A05, 0x10A06], [0x10A0C, 0x10A0F],

src/CompositionHelper.test.ts

@@ -17,7 +17,7 @@ describe('CompositionHelper', () => {
     compositionView = {
       classList: {
         add: () => {},
-        remove: () => {},
+        remove: () => {}
       },
       getBoundingClientRect: () => {
         return { width: 0 };