Ninja Pirate Mutants

    split-shell-buffer
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.9 • Public • Published

    Split Shell Buffer

    Splitting shell strings while preserving SGR escape sequences

    Motivation

    When I was creating catls, I needed to spawn a program and prints output (stdout and/or stderr) of said program to process.stdout with some prefix (e.g. indentation, bullets, numbers, etc.) whilst preserving some of UNIX control sequences (specifically, sequences that control colors).

    Preview

    Run one of the commands below (in top-level folder of this repository):

    pnpx execute runPreloadedNode test/split-shell-buffer/preview.ts
    pnpx execute runPreloadedNode test/split-shell-buffer/preview.discrete.ts

    Usage Example

    NOTE: Documentation is lacking (because I'm lazy), pull requests are welcomed.

    NOTE: The following code snippets are executed in async context.

    fromChildProcess

    The code below spawns a program and prints output (stdout + stderr) of said program with indent.

    const { stdout } = require('process')
    const { spawn } = require('child_process')
    const { fromChildProcess, writeln } = require('split-shell-buffer')
     
    const cp = spawn('myprogram')
    const splitter = fromChildProcess(cp).withIndent(4)
     
    await writeln(stdout, splitter)

    License

    MIT © Hoàng Văn Khải

    Install

    npm i split-shell-buffer

    DownloadsWeekly Downloads

    7

    Version

    2.0.9

    License

    MIT

    Unpacked Size

    37.7 kB

    Total Files

    68

    Last publish

    Collaborators

    • khai96_