vercel/hyper

Add a way for plugins to add xterm addons

Open

#2.903 aberto em 22 de abr. de 2018

Ver no GitHub
 (1 comment) (5 reactions) (0 assignees)TypeScript (44.582 stars) (3.558 forks)batch import
help wanted🛠 Type: Feature Request

Description

xtermjs offers a way to enhance its API: https://xtermjs.org/docs/guides/using-addons/

We need to find a way to let plugins add some addons.

Proposal:

// Plugin side
import * as zmodem from 'xterm/lib/addons/zmodem/zmodem';

exports.getXtermAddons() {
  return zmodem // [zmodem] will work too
}

On Hyper side, we need to execute this method for all plugins (each time they've changed) to get all these addons and apply them with:

  Terminal.applyAddon(pluginAddon);

Guia do colaborador

Pilha de tecnologia
typescriptjavascript
Domain
frontend
Tipo Issue
feature
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
Understanding of Hyper's plugin systemFamiliarity with xterm.js addons
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60
Direção de pesquisa
The issue proposes adding a method for plugins to contribute xterm addons. The Hyper side needs to call Terminal.applyAddon for each plugin's addons. Investigate how Hyper currently loads plugins and where the terminal instance is exposed. Look at the existing plugin API to see if a new export like `getXtermAddons` can be integrated. See comments for any additional discussion.