escape-codes v0.4.2

escape-codes

A Node.js package providing an extensive collection of ANSI escape codes for enhanced command-line interface (CLI) styling and interaction. It allows for sophisticated text formatting, color manipulation, cursor control, and provides utilities for reading and writing in terminal applications.

Features

• ANSI Escape Codes: Constants for text formatting, cursor movement, color setting, and more.
• Control Keys: Key codes for common control characters and actions.
• Text Formatting: Methods for styling CLI output with bold, italic, underline, blinking text, etc.
• Cursor Control: Functions to manipulate the cursor position in the terminal.
• Color Codes: Easy-to-use foreground and background color settings.
• ASCII Control Characters: Mapped ASCII control characters for various control actions.
• CLI Interaction: Utilities for synchronous and asynchronous terminal I/O operations.

Installation

To install Escape Codes, run the following command in your project directory:

npm install escape-codes

Usage

After installation, import the module into your project to access its functionalities:

import { ansi, ascii, cli } from 'escape-codes';

Then use the codes to control and format the terminal.

cli.write([ansi.foreground.blue, "Hello, Blue!", ansi.format.reset])
cli.write(`${ansi.format.bold}I am bold!${ansi.format.reset}`)
cli.write(ansi.cursor.left(1))

Or read input from the terminal.

cli.read((stroke, stop) => {
  switch (stroke) {
    case ansi.key.exit:
      process.exit()
    case ansi.key.enter:
      stop() // stop reading key strokes
      break
    default:
      if (/^[a-zA-Z0-9 .,!?;:'"()-]*$/.test(stroke)) {
        console.log(`You pressed: ${stroke}`)
      }
  }
})

API

Below is the detailed API documentation for the Escape Codes package:

ANSI Codes

ANSI escape codes for various CLI styling and control:

Control Keys

Usage: ansi.key.tab

Formatting Codes

Usage: ansi.format.reset

Cursor Control Codes

Usage: ansi.cursor.up(3) or ansi.cursor.save

Foreground Color Codes

Usage: ansi.foreground.blue

Background Color Codes

Usage: ansi.background.red

ASCII Control Characters

Usage: ascii.ctrlA (note the ascii instead of ansi)

CLI Interaction

Utility functions for terminal I/O operations:

cli.write

Writes data to the standard output.

cli.write(data: string | string[]);

cli.read

Reads input from the standard input, character by character.

cli.read(cb: (data: string, stop: () => void) => void);

cli.input

Asynchronously captures a single line of input from the standard input.

async cli.input(): Promise<string>;

Contributions

We welcome contributions from the community. If you'd like to contribute, please fork the repository, make your changes, and submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Support

For questions, issues, or feature requests, please submit an issue on the GitHub repository.