Common web links sources

addons/xterm-addon-web-links/.editorconfig

@@ -0,0 +1,17 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+end_of_line = lf
+
+[*.{j,t}s]
+max_line_length = 100
+
+[*.css]
+indent_size = 4
+
+[*.md]
+trim_trailing_whitespace = false

addons/xterm-addon-web-links/.gitignore

@@ -0,0 +1,3 @@
+lib
+node_modules
+test/dist

addons/xterm-addon-web-links/.npmignore

@@ -0,0 +1,7 @@
+lib/**/*.test.js
+lib/**/*.js.map
+src/
+test/
+node_modules/
+tsconfig.json
+.editorconfig

addons/xterm-addon-web-links/.yarnrc

@@ -0,0 +1 @@
+--modules-folder "../../node_modules"

addons/xterm-addon-web-links/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2017, The xterm.js authors (https://github.com/xtermjs/xterm.js)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

addons/xterm-addon-web-links/README.md

@@ -0,0 +1,23 @@
+## xterm-addon-web-links
+
+[![Build Status](https://dev.azure.com/xtermjs/xterm-addon-web-links/_apis/build/status/xtermjs.xterm-addon-web-links?branchName=master)](https://dev.azure.com/xtermjs/xterm-addon-web-links/_build/latest?definitionId=5&branchName=master)
+
+An addon for [xterm.js](https://github.com/xtermjs/xterm.js) that enabled web links. This addon requires xterm.js 3.14+.
+
+### Install
+
+```bash
+npm install --save xterm-addon-web-links
+```
+
+### Usage
+
+```ts
+import { Terminal } from 'xterm';
+import { WebLinksAddon } from 'xterm-addon-web-links';
+
+const terminal = new Terminal();
+terminal.loadAddon(new WebLinksAddon());
+```
+
+You can also specify a custom handler and options, see the [API](https://github.com/xtermjs/xterm-addon-web-links/blob/master/typings/web-links.d.ts) for more details.

addons/xterm-addon-web-links/azure-pipelines.yml

@@ -0,0 +1,24 @@
+jobs:
+- job: Linux
+  pool:
+    vmImage: 'ubuntu-16.04'
+  steps:
+  - task: NodeTool@0
+    inputs:
+      versionSpec: '8.x'
+    displayName: 'Install Node.js'
+  - task: geeklearningio.gl-vsts-tasks-yarn.yarn-installer-task.YarnInstaller@2
+    inputs:
+      versionSpec: "1.9.4"
+    displayName: 'Install Yarn'
+  - script: |
+      yarn
+    displayName: 'Install dependencies and build'
+  - script: |
+      yarn lint
+    displayName: 'Lint'
+  - script: |
+      yarn start &
+      sleep 5
+      yarn test --headless
+    displayName: 'Tests'

addons/xterm-addon-web-links/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "xterm-addon-web-links",
+  "version": "0.1.0-beta7",
+  "author": {
+    "name": "The xterm.js authors",
+    "url": "https://xtermjs.org/"
+  },
+  "main": "lib/WebLinksAddon.js",
+  "types": "typings/web-links.d.ts",
+  "license": "MIT",
+  "scripts": {
+    "watch": "tsc -w -p src",
+    "prepublish": "tsc -p src",
+    "test": "mocha \"lib/**/*.test.js\""
+  },
+  "peerDependencies": {
+    "xterm": "^3.13.0"
+  }
+}

addons/xterm-addon-web-links/src/WebLinksAddon.test.ts

@@ -0,0 +1,89 @@
+/**
+ * Copyright (c) 2019 The xterm.js authors. All rights reserved.
+ * @license MIT
+ */
+
+import * as puppeteer from 'puppeteer';
+import { assert } from 'chai';
+import { ITerminalOptions } from 'xterm';
+
+const APP = 'http://127.0.0.1:3000';
+
+let browser: puppeteer.Browser;
+let page: puppeteer.Page;
+const width = 800;
+const height = 600;
+
+describe('API Integration Tests', () => {
+  before(async function(): Promise<any> {
+    this.timeout(10000);
+    browser = await puppeteer.launch({
+      headless: process.argv.indexOf('--headless') !== -1,
+      slowMo: 80,
+      args: [`--window-size=${width},${height}`]
+    });
+    page = (await browser.pages())[0];
+    await page.setViewport({ width, height });
+  });
+
+  after(async () => {
+    await browser.close();
+  });
+
+  beforeEach(async function(): Promise<any> {
+    this.timeout(5000);
+    await page.goto(APP);
+  });
+
+  it('.com', async function(): Promise<any> {
+    this.timeout(20000);
+    await testHostName('foo.com');
+  });
+
+  it('.com.au', async function(): Promise<any> {
+    this.timeout(20000);
+    await testHostName('foo.com.au');
+  });
+
+  it('.io', async function(): Promise<any> {
+    this.timeout(20000);
+    await testHostName('foo.io');
+  });
+});
+
+async function testHostName(hostname: string): Promise<void> {
+  await openTerminal({ rendererType: 'dom' });
+  await page.evaluate(`window.term.loadAddon(new window.WebLinksAddon())`);
+  await page.evaluate(`
+    window.term.writeln('  http://${hostname}  ');
+    window.term.writeln('  http://${hostname}/a~b#c~d?e~f  ');
+    window.term.writeln('  http://${hostname}/colon:test  ');
+    window.term.writeln('  http://${hostname}/colon:test:  ');
+    window.term.writeln('"http://${hostname}/"');
+    window.term.writeln('\\'http://${hostname}/\\'');
+    window.term.writeln('http://${hostname}/subpath/+/id');
+  `);
+  assert.equal(await getLinkAtCell(3, 1), `http://${hostname}`);
+  assert.equal(await getLinkAtCell(3, 2), `http://${hostname}/a~b#c~d?e~f`);
+  assert.equal(await getLinkAtCell(3, 3), `http://${hostname}/colon:test`);
+  assert.equal(await getLinkAtCell(3, 4), `http://${hostname}/colon:test`);
+  assert.equal(await getLinkAtCell(2, 5), `http://${hostname}/`);
+  assert.equal(await getLinkAtCell(2, 6), `http://${hostname}/`);
+  assert.equal(await getLinkAtCell(1, 7), `http://${hostname}/subpath/+/id`);
+}
+
+async function openTerminal(options: ITerminalOptions = {}): Promise<void> {
+  await page.evaluate(`window.term = new Terminal(${JSON.stringify(options)})`);
+  await page.evaluate(`window.term.open(document.querySelector('#terminal'))`);
+  if (options.rendererType === 'dom') {
+    await page.waitForSelector('.xterm-rows');
+  } else {
+    await page.waitForSelector('.xterm-text-layer');
+  }
+}
+
+async function getLinkAtCell(col: number, row: number): Promise<string> {
+  const rowSelector = `.xterm-rows > :nth-child(${row})`;
+  await page.hover(`${rowSelector} > :nth-child(${col})`);
+  return await page.evaluate(`Array.prototype.reduce.call(document.querySelectorAll('${rowSelector} > span[style]'), (a, b) => a + b.textContent, '');`);
+}

addons/xterm-addon-web-links/src/WebLinksAddon.ts

@@ -0,0 +1,59 @@
+/**
+ * Copyright (c) 2017 The xterm.js authors. All rights reserved.
+ * @license MIT
+ */
+
+import { Terminal, ILinkMatcherOptions } from 'xterm';
+
+// TODO: This is temporary, link to xterm when the new version is published
+export interface ITerminalAddon {
+  activate(terminal: Terminal): void;
+  dispose(): void;
+}
+
+const protocolClause = '(https?:\\/\\/)';
+const domainCharacterSet = '[\\da-z\\.-]+';
+const negatedDomainCharacterSet = '[^\\da-z\\.-]+';
+const domainBodyClause = '(' + domainCharacterSet + ')';
+const tldClause = '([a-z\\.]{2,6})';
+const ipClause = '((\\d{1,3}\\.){3}\\d{1,3})';
+const localHostClause = '(localhost)';
+const portClause = '(:\\d{1,5})';
+const hostClause = '((' + domainBodyClause + '\\.' + tldClause + ')|' + ipClause + '|' + localHostClause + ')' + portClause + '?';
+const pathCharacterSet = '(\\/[\\/\\w\\.\\-%~:+]*)*([^:"\'\\s])';
+const pathClause = '(' + pathCharacterSet + ')?';
+const queryStringHashFragmentCharacterSet = '[0-9\\w\\[\\]\\(\\)\\/\\?\\!#@$%&\'*+,:;~\\=\\.\\-]*';
+const queryStringClause = '(\\?' + queryStringHashFragmentCharacterSet + ')?';
+const hashFragmentClause = '(#' + queryStringHashFragmentCharacterSet + ')?';
+const negatedPathCharacterSet = '[^\\/\\w\\.\\-%]+';
+const bodyClause = hostClause + pathClause + queryStringClause + hashFragmentClause;
+const start = '(?:^|' + negatedDomainCharacterSet + ')(';
+const end = ')($|' + negatedPathCharacterSet + ')';
+const strictUrlRegex = new RegExp(start + protocolClause + bodyClause + end);
+
+function handleLink(event: MouseEvent, uri: string): void {
+  window.open(uri, '_blank');
+}
+
+export class WebLinksAddon implements ITerminalAddon {
+  private _linkMatcherId: number | undefined;
+  private _terminal: Terminal | undefined;
+
+  constructor(
+    private _handler: (event: MouseEvent, uri: string) => void = handleLink,
+    private _options: ILinkMatcherOptions = {}
+  ) {
+    this._options.matchIndex = 1;
+  }
+
+  public activate(terminal: Terminal): void {
+    this._terminal = terminal;
+    this._linkMatcherId = this._terminal.registerLinkMatcher(strictUrlRegex, this._handler, this._options);
+  }
+
+  public dispose(): void {
+    if (this._linkMatcherId !== undefined && this._terminal !== undefined) {
+      this._terminal.deregisterLinkMatcher(this._linkMatcherId);
+    }
+  }
+}

addons/xterm-addon-web-links/src/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "es5",
+    "lib": [
+      "dom",
+      "es5",
+      "es2015"
+    ],
+    "rootDir": ".",
+    "outDir": "../lib",
+    "sourceMap": true,
+    "removeComments": true,
+    "strict": true
+  }
+}

addons/xterm-addon-web-links/tslint.json

@@ -0,0 +1,113 @@
+{
+  "rulesDirectory": [
+    "tslint-consistent-codestyle"
+  ],
+  "rules": {
+    "array-type": [
+      true,
+      "array"
+    ],
+    "class-name": true,
+    "comment-format": [
+      true,
+      "check-space"
+    ],
+    "curly": [
+      true,
+      "ignore-same-line"
+    ],
+    "indent": [
+      true,
+      "spaces"
+    ],
+    "interface-name": [
+      true,
+      "always-prefix"
+    ],
+    "interface-over-type-literal": true,
+    "typedef": [
+      true,
+      "call-signature",
+      "parameter"
+    ],
+    "eofline": true,
+    "new-parens": true,
+    "no-duplicate-imports": true,
+    "no-eval": true,
+    "no-internal-module": true,
+    "no-trailing-whitespace": true,
+    "one-variable-per-declaration": true,
+    "no-unsafe-finally": true,
+    "no-var-keyword": true,
+    "prefer-const": true,
+    "quotemark": [
+      true,
+      "single"
+    ],
+    "semicolon": [
+      true,
+      "always"
+    ],
+    "trailing-comma": [
+      true,
+      {
+        "multiline": {
+          "objects": "never",
+          "arrays": "never",
+          "functions": "never",
+          "typeLiterals": "ignore"
+        },
+        "esSpecCompliant": true
+      }
+    ],
+    "triple-equals": true,
+    "typedef-whitespace": [
+      true,
+      {
+        "call-signature": "nospace",
+        "index-signature": "nospace",
+        "parameter": "nospace",
+        "property-declaration": "nospace",
+        "variable-declaration": "nospace"
+      }
+    ],
+    "variable-name": [
+      true,
+      "ban-keywords",
+      "check-format",
+      "allow-leading-underscore"
+    ],
+    "whitespace": [
+      true,
+      "check-branch",
+      "check-decl",
+      "check-module",
+      "check-operator",
+      "check-rest-spread",
+      "check-separator",
+      "check-type",
+      "check-type-operator",
+      "check-preblock"
+    ],
+
+    "naming-convention": [
+      true,
+      {"type": "default", "format": "camelCase", "leadingUnderscore": "forbid"},
+      {"type": "type", "format": "PascalCase"},
+      {"type": "class", "format": "PascalCase"},
+      {"type": "property", "modifiers": ["const"], "format": "UPPER_CASE"},
+      {"type": "member", "modifiers": ["protected"], "format": "camelCase", "leadingUnderscore": "allow"},
+      // TODO: Change allow to require when there aren't many PRs out
+      // {"type": "member", "modifiers": ["protected"], "format": "camelCase", "leadingUnderscore": "require"},
+      {"type": "member", "modifiers": ["private"], "format": "camelCase", "leadingUnderscore": "require"},
+      {"type": "variable", "modifiers": ["const"], "format": ["camelCase", "UPPER_CASE"]},
+      {"type": "interface", "prefix": "I"}
+    ],
+    "no-else-after-return": {
+      "options": "allow-else-if"
+    },
+    "prefer-const-enum": [
+      true
+    ]
+  }
+}

addons/xterm-addon-web-links/typings/web-links.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Copyright (c) 2017 The xterm.js authors. All rights reserved.
+ * @license MIT
+ */
+
+
+import { Terminal, IDisposable, ILinkMatcherOptions } from 'xterm';
+
+declare module 'xterm-addon-web-links' {
+  // TODO: This is temporary, link to xterm when the new version is published
+  export interface ITerminalAddon extends IDisposable {
+    activate(terminal: Terminal): void;
+  }
+
+  /**
+   * An xterm.js addon that enables web links.
+   */
+  export class WebLinksAddon implements ITerminalAddon {
+    /**
+     * Creates a new web links addon.
+     * @param handler The callback when the link is called.
+     * @param options Options for the link matcher.
+     */
+    constructor(handler?: (event: MouseEvent, uri: string) => void, options?: ILinkMatcherOptions);
+
+    /**
+     * Activates the addon
+     * @param terminal The terminal the addon is being loaded in.
+     */
+    public activate(terminal: Terminal): void;
+
+    /**
+     * Disposes the addon.
+     */
+    public dispose(): void;
+  }
+}