Merge remote-tracking branch 'upstream/master' into pr/aymanbagabas/4220

.eslintrc.json

@@ -14,31 +14,31 @@
       "test/api/tsconfig.json",
       "test/benchmark/tsconfig.json",
       "test/playwright/tsconfig.json",
-      "addons/xterm-addon-attach/src/tsconfig.json",
-      "addons/xterm-addon-attach/test/tsconfig.json",
-      "addons/xterm-addon-canvas/src/tsconfig.json",
-      "addons/xterm-addon-canvas/test/tsconfig.json",
+      "addons/addon-attach/src/tsconfig.json",
+      "addons/addon-attach/test/tsconfig.json",
+      "addons/addon-canvas/src/tsconfig.json",
+      "addons/addon-canvas/test/tsconfig.json",
       "addons/xterm-addon-clipboard/src/tsconfig.json",
       "addons/xterm-addon-clipboard/test/tsconfig.json",
-      "addons/xterm-addon-fit/src/tsconfig.json",
-      "addons/xterm-addon-fit/test/tsconfig.json",
-      "addons/xterm-addon-image/src/tsconfig.json",
-      "addons/xterm-addon-image/test/tsconfig.json",
-      "addons/xterm-addon-ligatures/src/tsconfig.json",
-      "addons/xterm-addon-search/src/tsconfig.json",
-      "addons/xterm-addon-search/test/tsconfig.json",
-      "addons/xterm-addon-serialize/src/tsconfig.json",
-      "addons/xterm-addon-serialize/test/tsconfig.json",
-      "addons/xterm-addon-serialize/benchmark/tsconfig.json",
-      "addons/xterm-addon-unicode11/src/tsconfig.json",
-      "addons/xterm-addon-unicode11/test/tsconfig.json",
-      "addons/xterm-addon-unicode-graphemes/src/tsconfig.json",
-      "addons/xterm-addon-unicode-graphemes/test/tsconfig.json",
-      "addons/xterm-addon-unicode-graphemes/benchmark/tsconfig.json",
-      "addons/xterm-addon-web-links/src/tsconfig.json",
-      "addons/xterm-addon-web-links/test/tsconfig.json",
-      "addons/xterm-addon-webgl/src/tsconfig.json",
-      "addons/xterm-addon-webgl/test/tsconfig.json"
+      "addons/addon-fit/src/tsconfig.json",
+      "addons/addon-fit/test/tsconfig.json",
+      "addons/addon-image/src/tsconfig.json",
+      "addons/addon-image/test/tsconfig.json",
+      "addons/addon-ligatures/src/tsconfig.json",
+      "addons/addon-search/src/tsconfig.json",
+      "addons/addon-search/test/tsconfig.json",
+      "addons/addon-serialize/src/tsconfig.json",
+      "addons/addon-serialize/test/tsconfig.json",
+      "addons/addon-serialize/benchmark/tsconfig.json",
+      "addons/addon-unicode11/src/tsconfig.json",
+      "addons/addon-unicode11/test/tsconfig.json",
+      "addons/addon-unicode-graphemes/src/tsconfig.json",
+      "addons/addon-unicode-graphemes/test/tsconfig.json",
+      "addons/addon-unicode-graphemes/benchmark/tsconfig.json",
+      "addons/addon-web-links/src/tsconfig.json",
+      "addons/addon-web-links/test/tsconfig.json",
+      "addons/addon-webgl/src/tsconfig.json",
+      "addons/addon-webgl/test/tsconfig.json"
     ],
     "sourceType": "module"
   },

.github/workflows/ci.yml

@@ -26,28 +26,28 @@ jobs:
         zip -r compressed-build \
           ./out/* \
           ./out-test/* \
-          ./addons/xterm-addon-attach/out/* \
-          ./addons/xterm-addon-attach/out-test/* \
-          ./addons/xterm-addon-canvas/out/* \
-          ./addons/xterm-addon-canvas/out-test/* \
-          ./addons/xterm-addon-fit/out/* \
-          ./addons/xterm-addon-fit/out-test/* \
-          ./addons/xterm-addon-image/out/* \
-          ./addons/xterm-addon-image/out-test/* \
-          ./addons/xterm-addon-ligatures/out/* \
-          ./addons/xterm-addon-ligatures/out-test/* \
-          ./addons/xterm-addon-search/out/* \
-          ./addons/xterm-addon-search/out-test/* \
-          ./addons/xterm-addon-serialize/out/* \
-          ./addons/xterm-addon-serialize/out-test/* \
-          ./addons/xterm-addon-unicode11/out/* \
-          ./addons/xterm-addon-unicode11/out-test/* \
-          ./addons/xterm-addon-unicode-graphemes/out/* \
-          ./addons/xterm-addon-unicode-graphemes/out-test/* \
-          ./addons/xterm-addon-web-links/out/* \
-          ./addons/xterm-addon-web-links/out-test/* \
-          ./addons/xterm-addon-webgl/out/* \
-          ./addons/xterm-addon-webgl/out-test/*
+          ./addons/addon-attach/out/* \
+          ./addons/addon-attach/out-test/* \
+          ./addons/addon-canvas/out/* \
+          ./addons/addon-canvas/out-test/* \
+          ./addons/addon-fit/out/* \
+          ./addons/addon-fit/out-test/* \
+          ./addons/addon-image/out/* \
+          ./addons/addon-image/out-test/* \
+          ./addons/addon-ligatures/out/* \
+          ./addons/addon-ligatures/out-test/* \
+          ./addons/addon-search/out/* \
+          ./addons/addon-search/out-test/* \
+          ./addons/addon-serialize/out/* \
+          ./addons/addon-serialize/out-test/* \
+          ./addons/addon-unicode11/out/* \
+          ./addons/addon-unicode11/out-test/* \
+          ./addons/addon-unicode-graphemes/out/* \
+          ./addons/addon-unicode-graphemes/out-test/* \
+          ./addons/addon-web-links/out/* \
+          ./addons/addon-web-links/out-test/* \
+          ./addons/addon-webgl/out/* \
+          ./addons/addon-webgl/out-test/*
     - name: Upload artifacts
       uses: actions/upload-artifact@v3
       with:
@@ -265,10 +265,10 @@ jobs:
       run: yarn build-demo
     - name: Integration tests (core) # Tests use 50% workers to reduce flakiness
       run: yarn test-playwright-${{ matrix.browser }} --workers=50% --forbid-only --suite=core
-    - name: Integration tests (xterm-addon-canvas)
-      run: yarn test-playwright-${{ matrix.browser }} --workers=50% --forbid-only --suite=xterm-addon-canvas
-    - name: Integration tests (xterm-addon-webgl)
-      run: yarn test-playwright-${{ matrix.browser }} --workers=50% --forbid-only --suite=xterm-addon-webgl
+    - name: Integration tests (addon-canvas)
+      run: yarn test-playwright-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-canvas
+    - name: Integration tests (addon-webgl)
+      run: yarn test-playwright-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-webgl
 
   test-api:
     needs: build
@@ -306,3 +306,41 @@ jobs:
         ls -R
     - name: Integration tests (${{ matrix.browser }})
       run: yarn test-api-${{ matrix.browser }} --headless --forbid-only
+
+  release-dry-run:
+    needs: build
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}.x
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}.x
+        cache: 'yarn'
+    - name: Install dependencies
+      run: |
+        yarn --frozen-lockfile
+        yarn install-addons
+    - name: Install playwright
+      run: npx playwright install
+    - uses: actions/download-artifact@v3
+      with:
+        name: build-artifacts
+    - name: Unzip artifacts
+      shell: bash
+      run: |
+        if [ "$RUNNER_OS" == "Windows" ]; then
+          pwsh -Command "7z x compressed-build.zip -aoa -o${{ github.workspace }}"
+        else
+          unzip -o compressed-build.zip
+        fi
+        ls -R
+    - name: Package headless
+      run: |
+        yarn package-headless
+        node ./bin/package_headless.js
+    - name: Publish to npm (dry run)
+      run: node ./bin/publish.js --dry

README.md

@@ -49,7 +49,7 @@ To start using xterm.js on your browser, add the `xterm.js` and `xterm.css` to t
 The recommended way to load xterm.js is via the ES6 module syntax:
 
 ```javascript
-import { Terminal } from 'xterm';
+import { Terminal } from '@xterm/xterm';
 ```
 
 ### Addons
@@ -59,14 +59,14 @@ import { Terminal } from 'xterm';
 Addons are separate modules that extend the `Terminal` by building on the [xterm.js API](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts). To use an addon, you first need to install it in your project:
 
 ```bash
-npm i -S xterm-addon-web-links
+npm i -S @xterm/addon-web-links
 ```
 
 Then import the addon, instantiate it and call `Terminal.loadAddon`:
 
 ```ts
-import { Terminal } from 'xterm';
-import { WebLinksAddon } from 'xterm-addon-web-links';
+import { Terminal } from '@xterm/xterm';
+import { WebLinksAddon } from '@xterm/addon-web-links';
 
 const terminal = new Terminal();
 // Load WebLinksAddon on terminal, this is all that's needed to get web links
@@ -76,11 +76,16 @@ terminal.loadAddon(new WebLinksAddon());
 
 The xterm.js team maintains the following addons, but anyone can build them:
 
-- [`xterm-addon-attach`](https://github.com/xtermjs/xterm.js/tree/master/addons/xterm-addon-attach): Attaches to a server running a process via a websocket
+- [`@xterm/addon-attach`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-attach): Attaches to a server running a process via a websocket
+- [`@xterm/addon-canvas`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-canvas): Renders xterm.js using a `canvas` element's 2d context
 - [`xterm-addon-clipboard`](https://github.com/xtermjs/xterm.js/tree/master/addons/xterm-addon-clipboard): Access the browser's clipboard
-- [`xterm-addon-fit`](https://github.com/xtermjs/xterm.js/tree/master/addons/xterm-addon-fit): Fits the terminal to the containing element
-- [`xterm-addon-search`](https://github.com/xtermjs/xterm.js/tree/master/addons/xterm-addon-search): Adds search functionality
-- [`xterm-addon-web-links`](https://github.com/xtermjs/xterm.js/tree/master/addons/xterm-addon-web-links): Adds web link detection and interaction
+- [`@xterm/addon-fit`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-fit): Fits the terminal to the containing element
+- [`@xterm/addon-image`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-image): Adds image support
+- [`@xterm/addon-search`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-search): Adds search functionality
+- [`@xterm/addon-serialize`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-serialize): Serializes the terminal's buffer to a VT sequences or HTML
+- [`@xterm/addon-unicode11`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-unicode11): Updates character widths to their unicode11 values
+- [`@xterm/addon-web-links`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-web-links): Adds web link detection and interaction
+- [`@xterm/addon-webgl`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-webgl): Renders xterm.js using a `canvas` element's webgl2 context
 
 ## Browser Support
 

addons/xterm-addon-attach/README.md → addons/addon-attach/README.md

@@ -1,22 +1,22 @@
-## xterm-addon-attach
+## @xterm/addon-attach
 
 An addon for [xterm.js](https://github.com/xtermjs/xterm.js) that enables attaching to a web socket. This addon requires xterm.js v4+.
 
 ### Install
 
 ```bash
-npm install --save xterm-addon-attach
+npm install --save @xterm/addon-attach
 ```
 
 ### Usage
 
 ```ts
-import { Terminal } from 'xterm';
-import { AttachAddon } from 'xterm-addon-attach';
+import { Terminal } from '@xterm/xterm';
+import { AttachAddon } from '@xterm/addon-attach';
 
 const terminal = new Terminal();
 const attachAddon = new AttachAddon(webSocket);
 terminal.loadAddon(attachAddon);
 ```
 
-See the full [API](https://github.com/xtermjs/xterm.js/blob/master/addons/xterm-addon-attach/typings/xterm-addon-attach.d.ts) for more advanced usage.
+See the full [API](https://github.com/xtermjs/xterm.js/blob/master/addons/addon-attach/typings/addon-attach.d.ts) for more advanced usage.

addons/xterm-addon-attach/package.json → addons/addon-attach/package.json

@@ -1,13 +1,13 @@
 {
-  "name": "xterm-addon-attach",
+  "name": "@xterm/addon-attach",
   "version": "0.9.0",
   "author": {
     "name": "The xterm.js authors",
     "url": "https://xtermjs.org/"
   },
-  "main": "lib/xterm-addon-attach.js",
-  "types": "typings/xterm-addon-attach.d.ts",
-  "repository": "https://github.com/xtermjs/xterm.js/tree/master/addons/xterm-addon-attach",
+  "main": "lib/addon-attach.js",
+  "types": "typings/addon-attach.d.ts",
+  "repository": "https://github.com/xtermjs/xterm.js/tree/master/addons/addon-attach",
   "license": "MIT",
   "keywords": [
     "terminal",
@@ -21,6 +21,6 @@
     "prepublishOnly": "npm run package"
   },
   "peerDependencies": {
-    "xterm": "^5.0.0"
+    "@xterm/xterm": "^5.0.0"
   }
 }

addons/xterm-addon-attach/src/AttachAddon.ts → addons/addon-attach/src/AttachAddon.ts

@@ -5,13 +5,14 @@
  * Implements the attach method, that attaches the terminal to a WebSocket stream.
  */
 
-import { Terminal, IDisposable, ITerminalAddon } from 'xterm';
+import type { Terminal, IDisposable, ITerminalAddon } from '@xterm/xterm';
+import type { AttachAddon as IAttachApi } from '@xterm/addon-attach';
 
 interface IAttachOptions {
   bidirectional?: boolean;
 }
 
-export class AttachAddon implements ITerminalAddon {
+export class AttachAddon implements ITerminalAddon , IAttachApi {
   private _socket: WebSocket;
   private _bidirectional: boolean;
   private _disposables: IDisposable[] = [];

addons/xterm-addon-attach/src/tsconfig.json → addons/addon-attach/src/tsconfig.json

@@ -13,7 +13,12 @@
     "strict": true,
     "types": [
       "../../../node_modules/@types/mocha"
-    ]
+    ],
+    "paths": {
+      "@xterm/addon-attach": [
+        "../typings/addon-attach.d.ts"
+      ]
+    }
   },
   "include": [
     "./**/*",

addons/xterm-addon-attach/typings/xterm-addon-attach.d.ts → addons/addon-attach/typings/addon-attach.d.ts

@@ -3,9 +3,9 @@
  * @license MIT
  */
 
-import { Terminal, ITerminalAddon } from 'xterm';
+import { Terminal, ITerminalAddon } from '@xterm/xterm';
 
-declare module 'xterm-addon-attach' {
+declare module '@xterm/addon-attach' {
   export interface IAttachOptions {
     /**
      * Whether input should be written to the backend. Defaults to `true`.

addons/xterm-addon-attach/webpack.config.js → addons/addon-attach/webpack.config.js

@@ -6,7 +6,7 @@
 const path = require('path');
 
 const addonName = 'AttachAddon';
-const mainFile = 'xterm-addon-attach.js';
+const mainFile = 'addon-attach.js';
 
 module.exports = {
   entry: `./out/${addonName}.js`,

addons/addon-canvas/README.md

@@ -0,0 +1,28 @@
+## @xterm/addon-canvas
+
+An addon for [xterm.js](https://github.com/xtermjs/xterm.js) that enables a canvas-based renderer using a 2d context to draw. This addon requires xterm.js v5+.
+
+The purpose of this addon is to be used as a fallback for the [webgl addon](https://www.npmjs.com/package/@xterm/addon-webgl) when better performance is desired over the default DOM renderer, but WebGL2 isn't supported or performant for some reason.
+
+### Install
+
+```bash
+npm install --save @xterm/addon-canvas
+```
+
+### Usage
+
+```ts
+import { Terminal } from '@xterm/xterm';
+import { CanvasAddon } from '@xterm/addon-canvas';
+
+const terminal = new Terminal();
+terminal.open(element);
+terminal.loadAddon(new CanvasAddon());
+```
+
+See the full [API](https://github.com/xtermjs/xterm.js/blob/master/addons/addon-canvas/typings/addon-canvas.d.ts) for more advanced usage.
+
+### See also
+
+- [@xterm/addon-webgl](https://www.npmjs.com/package/@xterm/addon-webgl) A renderer for xterm.js that uses WebGL

addons/xterm-addon-canvas/package.json → addons/addon-canvas/package.json

@@ -1,13 +1,13 @@
 {
-  "name": "xterm-addon-canvas",
+  "name": "@xterm/addon-canvas",
   "version": "0.5.0",
   "author": {
     "name": "The xterm.js authors",
     "url": "https://xtermjs.org/"
   },
-  "main": "lib/xterm-addon-canvas.js",
-  "types": "typings/xterm-addon-canvas.d.ts",
-  "repository": "https://github.com/xtermjs/xterm.js/tree/master/addons/xterm-addon-canvas",
+  "main": "lib/addon-canvas.js",
+  "types": "typings/addon-canvas.d.ts",
+  "repository": "https://github.com/xtermjs/xterm.js/tree/master/addons/addon-canvas",
   "license": "MIT",
   "keywords": [
     "terminal",
@@ -23,6 +23,6 @@
     "start-server-only": "node ../../demo/start-server-only"
   },
   "peerDependencies": {
-    "xterm": "^5.0.0"
+    "@xterm/xterm": "^5.0.0"
   }
 }