npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

get-pty-output

v0.8.2

Published

Execute an external command with a PTY, from Node

Downloads

5,302

Readme

get-pty-output

https://github.com/CyriacBr/get-pty-output/actions

An alternative to child_process.exec with PTY support

Node doesn't natively support creating pseudo-terminals. When running an external command with child_process.spawn or exec, ansi colors are lost because most of CLIs disable colors when they aren't run inside a TTY environment. You can make your child inherit the parent stdio, thus allowing colors, but this results in the inability to properly capture outputs.

Some packages like node-pty aim to solve this problem, but they rely on node-gyp, and doesn't support newer Node versions. This package leverage Rust's portable-pty(unix) and conpty(windows) crates with n-api-rs for bindings, allowing way better cross-platform support and easier installation.

Install

yarn add get-pty-output

Usage

import { exec, execSync } from 'get-pty-output'

const res = await exec('node -e console.log(100)')
res.output // in color! ✨

Options

exec(cmd, {
  cwd: 'path-to-desired-wd',
  /**
   * Close the pty after a timeout.
   */
  timeout: 10,
  /**
   * Close the pty after a timeout since the command became idle.
   * A command is considered idle when it has stopped writing on stdout.
   * Only works on UNIX platforms for now.
   */
  idleTimeout: 5,
  /**
   * Remove cursor transformations from the output.
   * Defaults to true. You may disable this if you notice your output is weirdly truncated.
   * If the command you're executing transforms the terminal cursor (spinners, progress bars, etc),
   * you likely want to keep this to true
   */
  purify: true
})

Output is truncated when a timeout happens. res.truncated; // true

Publishing

  • Remove all optional deps
  • Bump version if needed
  • Run prepare-release
  • Push or manually start CI workflow
  • Download CI artifacts and put them under ./npm in their respective directory
  • Run npm publish

Credits & Thanks