From aed94e53177d7797a63c2aa9bac11180821090d8 Mon Sep 17 00:00:00 2001 From: Daniel Imms <2193314+Tyriar@users.noreply.github.com> Date: Fri, 3 Nov 2023 11:45:21 -0700 Subject: [PATCH] xterm-addon-clipboard to scoped module --- .eslintrc.json | 4 ++-- README.md | 2 +- .../.gitignore | 0 .../.npmignore | 0 .../{xterm-addon-clipboard => addon-clipboard}/LICENSE | 0 .../README.md | 10 +++++----- .../package.json | 8 ++++---- .../src/ClipboardAddon.ts | 2 +- .../src/ClipboardProvider.ts | 2 +- .../src/tsconfig.json | 0 .../test/ClipboardAddon.api.ts | 0 .../test/tsconfig.json | 0 .../tsconfig.json | 0 .../typings/addon-clipboard.d.ts} | 2 +- .../webpack.config.js | 2 +- .../yarn.lock | 0 bin/publish.js | 2 +- demo/client.ts | 4 ++-- demo/tsconfig.json | 2 +- src/common/InputHandler.test.ts | 2 +- src/common/InputHandler.ts | 2 +- tsconfig.all.json | 2 +- 22 files changed, 23 insertions(+), 23 deletions(-) rename addons/{xterm-addon-clipboard => addon-clipboard}/.gitignore (100%) rename addons/{xterm-addon-clipboard => addon-clipboard}/.npmignore (100%) rename addons/{xterm-addon-clipboard => addon-clipboard}/LICENSE (100%) rename addons/{xterm-addon-clipboard => addon-clipboard}/README.md (81%) rename addons/{xterm-addon-clipboard => addon-clipboard}/package.json (77%) rename addons/{xterm-addon-clipboard => addon-clipboard}/src/ClipboardAddon.ts (95%) rename addons/{xterm-addon-clipboard => addon-clipboard}/src/ClipboardProvider.ts (93%) rename addons/{xterm-addon-clipboard => addon-clipboard}/src/tsconfig.json (100%) rename addons/{xterm-addon-clipboard => addon-clipboard}/test/ClipboardAddon.api.ts (100%) rename addons/{xterm-addon-clipboard => addon-clipboard}/test/tsconfig.json (100%) rename addons/{xterm-addon-clipboard => addon-clipboard}/tsconfig.json (100%) rename addons/{xterm-addon-clipboard/typings/xterm-addon-clipboard.d.ts => addon-clipboard/typings/addon-clipboard.d.ts} (95%) rename addons/{xterm-addon-clipboard => addon-clipboard}/webpack.config.js (92%) rename addons/{xterm-addon-clipboard => addon-clipboard}/yarn.lock (100%) diff --git a/.eslintrc.json b/.eslintrc.json index d1092b09..5baa9166 100644 --- a/.eslintrc.json +++ b/.eslintrc.json @@ -18,8 +18,8 @@ "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/addon-clipboard/src/tsconfig.json", + "addons/addon-clipboard/test/tsconfig.json", "addons/addon-fit/src/tsconfig.json", "addons/addon-fit/test/tsconfig.json", "addons/addon-image/src/tsconfig.json", diff --git a/README.md b/README.md index 9ac2c009..7f7dc832 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,7 @@ 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/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-clipboard`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-clipboard): Access the browser's clipboard - [`@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 diff --git a/addons/xterm-addon-clipboard/.gitignore b/addons/addon-clipboard/.gitignore similarity index 100% rename from addons/xterm-addon-clipboard/.gitignore rename to addons/addon-clipboard/.gitignore diff --git a/addons/xterm-addon-clipboard/.npmignore b/addons/addon-clipboard/.npmignore similarity index 100% rename from addons/xterm-addon-clipboard/.npmignore rename to addons/addon-clipboard/.npmignore diff --git a/addons/xterm-addon-clipboard/LICENSE b/addons/addon-clipboard/LICENSE similarity index 100% rename from addons/xterm-addon-clipboard/LICENSE rename to addons/addon-clipboard/LICENSE diff --git a/addons/xterm-addon-clipboard/README.md b/addons/addon-clipboard/README.md similarity index 81% rename from addons/xterm-addon-clipboard/README.md rename to addons/addon-clipboard/README.md index 4515d191..087cf099 100644 --- a/addons/xterm-addon-clipboard/README.md +++ b/addons/addon-clipboard/README.md @@ -1,18 +1,18 @@ -## xterm-addon-clipboard +## @xterm/addon-clipboard An addon for [xterm.js](https://github.com/xtermjs/xterm.js) that enables accessing the system clipboard. This addon requires xterm.js v4+. ### Install ```bash -npm install --save xterm-addon-clipboard +npm install --save @xterm/addon-clipboard ``` ### Usage ```ts import { Terminal } from 'xterm'; -import { ClipboardAddon } from 'xterm-addon-clipboard'; +import { ClipboardAddon } from '@xterm/addon-clipboard'; const terminal = new Terminal(); const clipboardAddon = new ClipboardAddon(); @@ -23,7 +23,7 @@ To use a custom clipboard provider ```ts import { Terminal, IClipboardProvider, ClipboardSelection } from 'xterm'; -import { ClipboardAddon } from 'xterm-addon-clipboard'; +import { ClipboardAddon } from '@xterm/addon-clipboard'; function b64Encode(data: string): string { // Base64 encode impl @@ -49,4 +49,4 @@ const clipboardAddon = new ClipboardAddon(new MyCustomClipboardProvider()); terminal.loadAddon(clipboardAddon); ``` -See the full [API](https://github.com/xtermjs/xterm.js/blob/master/addons/xterm-addon-clipboard/typings/xterm-addon-clipboard.d.ts) for more advanced usage. +See the full [API](https://github.com/xtermjs/xterm.js/blob/master/addons/addon-clipboard/typings/addon-clipboard.d.ts) for more advanced usage. diff --git a/addons/xterm-addon-clipboard/package.json b/addons/addon-clipboard/package.json similarity index 77% rename from addons/xterm-addon-clipboard/package.json rename to addons/addon-clipboard/package.json index ccdbf599..2e7cd1eb 100644 --- a/addons/xterm-addon-clipboard/package.json +++ b/addons/addon-clipboard/package.json @@ -1,13 +1,13 @@ { - "name": "xterm-addon-clipboard", + "name": "@xterm/addon-clipboard", "version": "0.1.0", "author": { "name": "The xterm.js authors", "url": "https://xtermjs.org/" }, - "main": "lib/xterm-addon-clipboard.js", - "types": "typings/xterm-addon-clipboard.d.ts", - "repository": "https://github.com/xtermjs/xterm.js/tree/master/addons/xterm-addon-clipboard", + "main": "lib/addon-clipboard.js", + "types": "typings/addon-clipboard.d.ts", + "repository": "https://github.com/xtermjs/xterm.js/tree/master/addons/addon-clipboard", "license": "MIT", "keywords": [ "terminal", diff --git a/addons/xterm-addon-clipboard/src/ClipboardAddon.ts b/addons/addon-clipboard/src/ClipboardAddon.ts similarity index 95% rename from addons/xterm-addon-clipboard/src/ClipboardAddon.ts rename to addons/addon-clipboard/src/ClipboardAddon.ts index 51c113db..ccb75545 100644 --- a/addons/xterm-addon-clipboard/src/ClipboardAddon.ts +++ b/addons/addon-clipboard/src/ClipboardAddon.ts @@ -4,7 +4,7 @@ */ import { ClipboardProvider } from './ClipboardProvider'; -import { IClipboardProvider, IDisposable, ITerminalAddon, Terminal } from 'xterm'; +import { IClipboardProvider, IDisposable, ITerminalAddon, Terminal } from '@xterm/xterm'; export class ClipboardAddon implements ITerminalAddon { private _disposable: IDisposable | undefined; diff --git a/addons/xterm-addon-clipboard/src/ClipboardProvider.ts b/addons/addon-clipboard/src/ClipboardProvider.ts similarity index 93% rename from addons/xterm-addon-clipboard/src/ClipboardProvider.ts rename to addons/addon-clipboard/src/ClipboardProvider.ts index e7f9ff8a..c14dbe57 100644 --- a/addons/xterm-addon-clipboard/src/ClipboardProvider.ts +++ b/addons/addon-clipboard/src/ClipboardProvider.ts @@ -4,7 +4,7 @@ */ import { Base64 } from 'js-base64'; -import { ClipboardSelectionType, IClipboardProvider } from 'xterm'; +import { ClipboardSelectionType, IClipboardProvider } from '@xterm/xterm'; export class ClipboardProvider implements IClipboardProvider { constructor( diff --git a/addons/xterm-addon-clipboard/src/tsconfig.json b/addons/addon-clipboard/src/tsconfig.json similarity index 100% rename from addons/xterm-addon-clipboard/src/tsconfig.json rename to addons/addon-clipboard/src/tsconfig.json diff --git a/addons/xterm-addon-clipboard/test/ClipboardAddon.api.ts b/addons/addon-clipboard/test/ClipboardAddon.api.ts similarity index 100% rename from addons/xterm-addon-clipboard/test/ClipboardAddon.api.ts rename to addons/addon-clipboard/test/ClipboardAddon.api.ts diff --git a/addons/xterm-addon-clipboard/test/tsconfig.json b/addons/addon-clipboard/test/tsconfig.json similarity index 100% rename from addons/xterm-addon-clipboard/test/tsconfig.json rename to addons/addon-clipboard/test/tsconfig.json diff --git a/addons/xterm-addon-clipboard/tsconfig.json b/addons/addon-clipboard/tsconfig.json similarity index 100% rename from addons/xterm-addon-clipboard/tsconfig.json rename to addons/addon-clipboard/tsconfig.json diff --git a/addons/xterm-addon-clipboard/typings/xterm-addon-clipboard.d.ts b/addons/addon-clipboard/typings/addon-clipboard.d.ts similarity index 95% rename from addons/xterm-addon-clipboard/typings/xterm-addon-clipboard.d.ts rename to addons/addon-clipboard/typings/addon-clipboard.d.ts index c64cf625..651e0a9a 100644 --- a/addons/xterm-addon-clipboard/typings/xterm-addon-clipboard.d.ts +++ b/addons/addon-clipboard/typings/addon-clipboard.d.ts @@ -5,7 +5,7 @@ import { Terminal, ITerminalAddon, IClipboardProvider, ClipboardSelection as ClipboardSelectionType } from 'xterm'; -declare module 'xterm-addon-clipboard' { +declare module '@xterm/addon-clipboard' { export class ClipboardProvider implements IClipboardProvider{ public readText(selection: ClipboardSelectionType): Promise; public writeText(selection: ClipboardSelectionType, data: string): Promise; diff --git a/addons/xterm-addon-clipboard/webpack.config.js b/addons/addon-clipboard/webpack.config.js similarity index 92% rename from addons/xterm-addon-clipboard/webpack.config.js rename to addons/addon-clipboard/webpack.config.js index 0def5bbc..c00191ab 100644 --- a/addons/xterm-addon-clipboard/webpack.config.js +++ b/addons/addon-clipboard/webpack.config.js @@ -6,7 +6,7 @@ const path = require('path'); const addonName = 'ClipboardAddon'; -const mainFile = 'xterm-addon-clipboard.js'; +const mainFile = 'addon-clipboard.js'; module.exports = { entry: `./out/${addonName}.js`, diff --git a/addons/xterm-addon-clipboard/yarn.lock b/addons/addon-clipboard/yarn.lock similarity index 100% rename from addons/xterm-addon-clipboard/yarn.lock rename to addons/addon-clipboard/yarn.lock diff --git a/bin/publish.js b/bin/publish.js index 989b849d..fdf9f497 100644 --- a/bin/publish.js +++ b/bin/publish.js @@ -29,7 +29,7 @@ if (changedFiles.some(e => e.search(/^addons\//) === -1)) { const addonPackageDirs = [ path.resolve(__dirname, '../addons/addon-attach'), path.resolve(__dirname, '../addons/addon-canvas'), - path.resolve(__dirname, '../addons/xterm-addon-clipboard'), + path.resolve(__dirname, '../addons/addon-clipboard'), path.resolve(__dirname, '../addons/addon-fit'), path.resolve(__dirname, '../addons/addon-image'), path.resolve(__dirname, '../addons/addon-ligatures'), diff --git a/demo/client.ts b/demo/client.ts index f88dcff1..99ac0836 100644 --- a/demo/client.ts +++ b/demo/client.ts @@ -12,7 +12,7 @@ import { Terminal } from '../out/browser/public/Terminal'; import { AttachAddon } from '../addons/addon-attach/out/AttachAddon'; import { CanvasAddon } from '../addons/addon-canvas/out/CanvasAddon'; -import { ClipboardAddon } from '../addons/xterm-addon-clipboard/out/ClipboardAddon'; +import { ClipboardAddon } from '../addons/addon-clipboard/out/ClipboardAddon'; import { FitAddon } from '../addons/addon-fit/out/FitAddon'; import { SearchAddon, ISearchOptions } from '../addons/addon-search/out/SearchAddon'; import { SerializeAddon } from '../addons/addon-serialize/out/SerializeAddon'; @@ -33,7 +33,7 @@ if ('WebAssembly' in window) { // Use webpacked version (yarn package) // import { Terminal } from '../lib/xterm'; // import { AttachAddon } from '@xterm/addon-attach'; -// import { ClipboardAddon } from 'xterm-addon-clipboard'; +// import { ClipboardAddon } from '@xterm/addon-clipboard'; // import { FitAddon } from '@xterm/addon-fit'; // import { ImageAddon } from '@xterm/addon-image'; // import { SearchAddon, ISearchOptions } from '@xterm/addon-search'; diff --git a/demo/tsconfig.json b/demo/tsconfig.json index ac318daa..2e72c501 100644 --- a/demo/tsconfig.json +++ b/demo/tsconfig.json @@ -7,7 +7,7 @@ "baseUrl": ".", "paths": { "addon-attach": ["../addons/addon-attach"], - "xterm-addon-clipboard": ["../addons/xterm-addon-clipboard"], + "xterm-addon-clipboard": ["../addons/addon-clipboard"], "addon-fit": ["../addons/addon-fit"], "addon-image": ["../addons/addon-image"], "addon-search": ["../addons/addon-search"], diff --git a/src/common/InputHandler.test.ts b/src/common/InputHandler.test.ts index f5bf1dde..7815cef5 100644 --- a/src/common/InputHandler.test.ts +++ b/src/common/InputHandler.test.ts @@ -17,7 +17,7 @@ import { DEFAULT_OPTIONS } from 'common/services/OptionsService'; import { clone } from 'common/Clone'; import { BufferService } from 'common/services/BufferService'; import { CoreService } from 'common/services/CoreService'; -import { ClipboardSelectionType } from 'xterm'; +import { ClipboardSelectionType } from '@xterm/xterm'; function getCursor(bufferService: IBufferService): number[] { return [ diff --git a/src/common/InputHandler.ts b/src/common/InputHandler.ts index b38bffa1..8bc725fc 100644 --- a/src/common/InputHandler.ts +++ b/src/common/InputHandler.ts @@ -22,7 +22,7 @@ import { OscHandler } from 'common/parser/OscParser'; import { DcsHandler } from 'common/parser/DcsParser'; import { IBuffer } from 'common/buffer/Types'; import { parseColor } from 'common/input/XParseColor'; -import { ClipboardSelectionType } from 'xterm'; +import { ClipboardSelectionType } from '@xterm/xterm'; /** * Map collect to glevel. Used in `selectCharset`. diff --git a/tsconfig.all.json b/tsconfig.all.json index 2092992c..d40761f3 100644 --- a/tsconfig.all.json +++ b/tsconfig.all.json @@ -9,7 +9,7 @@ { "path": "./test/playwright" }, { "path": "./addons/addon-attach" }, { "path": "./addons/addon-canvas" }, - { "path": "./addons/xterm-addon-clipboard" }, + { "path": "./addons/addon-clipboard" }, { "path": "./addons/addon-fit" }, { "path": "./addons/addon-image" }, { "path": "./addons/addon-ligatures" },