Package Health Score

63 / 100

security
No known security issues
popularity
Limited
maintenance
Sustainable
community
Limited

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
1.1.2	\|	11/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.7	\|	04/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (782)

GitHub Stars: 22
Forks: 9
Contributors: 3

Direct Usage Popularity

The npm package xterm-readline receives a total of 782 downloads a week. As such, we scored xterm-readline popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package xterm-readline, we found that it has been starred 22 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 3
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like xterm-readline is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

No Recent Commits

Open Issues: 7
Open PR: 0
Last Release: 7 days ago
Last Commit: 2 years ago

Further analysis of the maintenance status of xterm-readline based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that xterm-readline demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 3 years
Dependencies: 1 Direct
Versions: 12
Install Size: 107 kB
Dist-tags: 1
# of Files: 46
Maintainers: 1
TS Typings: No

xterm-readline has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Xterm.js Readline

This is an xterm-js addon that provides a readline like capability to xterm-js. It allows the creation of cli or repl like interfaces on top of xterm-js.

Large parts of this source are inspired / derived / ported from the MIT licensed rustyline project.

Features

Multi-line prompt and input
Extendable syntax highlighting
Unicode / multi column-width character support

Example

This is a multi-line example that treats any line ending with '&&' as a continuation.

import "xterm/css/xterm.css";
import { Terminal } from 'xterm';
import { Readline } from "xterm-readline";

const term = new Terminal({
  theme: {
        background: "#191A19",
        foreground: "#F5F2E7",
  },
  cursorBlink: true,
  cursorStyle: "block"
});

const rl = new Readline();

term.loadAddon(rl);
term.open(document.getElementById('terminal'));
term.focus();

rl.setCheckHandler((text) => {
  let trimmedText = text.trimEnd();
  if (trimmedText.endsWith("&&")) {
    return false;
  }
  return true;
});

function readLine() {
  rl.read(">")
    .then(processLine);
}

function processLine(text) {
  rl.println("you entered: " + text);
  setTimeout(readLine);
}

readLine();

Keyboard Shortcuts

Key	Action
Home	Move cursor to the beginning of line
End	Move cursor to end of line
Left	Move cursor one character left
Right	Move cursor one character right
Up	Move cursor up (multi-line edit)
Down	Move cursor down (multi-line edit)
Ctrl-C	Cancel line in progress (additionally call ctrl-c callback if registered)
Ctrl-D, Del	Delete the character under the cursor
Enter	Apply the line, or begin a new line in multiline mode
Alt/Shift Enter	Force add \n to the input
Ctrl-U	Clear line
Ctrl-K	Delete text from cursor to end of line

Real World Uses

Marwood

License Agreement

If you contribute code to this project, you implicitly allow your code to be distributed under the MIT license.

xterm-readline dependencies

string-width

xterm-readline development dependencies

@types/jest @types/node @typescript-eslint/eslint-plugin @typescript-eslint/parser @xterm/xterm babel-jest eslint jest jest-environment-jsdom nodemon prettier ts-jest ts-node typescript

FAQs

What is xterm-readline?

xterm-js readline addon. Visit Snyk Advisor to see a full health score report for xterm-readline, including popularity, security, maintenance & community analysis.

Is xterm-readline popular?

The npm package xterm-readline receives a total of 782 weekly downloads. As such, xterm-readline popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is xterm-readline well maintained?

We found indications that xterm-readline maintenance is sustainable demonstrating some project activity. We saw a total of 3 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is xterm-readline safe to use?

The npm package xterm-readline was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 17 November-2024, at 14:57 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

xterm-readline