vercel / vercel/hyper

Add a way for plugins to add xterm addons

Open
#2,903 2 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

🛠 Type: Feature Request help wanted
Dominant language
TypeScript
Stars
44.7k
Forks
3.6k
Avg merge
21m
Merged PRs (30d)
1

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);

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the plugin lifecycle where plugins are loaded or changed, then trace the Hyper entry point that creates the xterm Terminal. Compare the proposed plugin-side getXtermAddons() result with xterm's Terminal.applyAddon(pluginAddon) API. Done means every changed plugin can provide one or more addons and Hyper applies them without breaking existing plugins.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.