https://github.com/bertrandom/press-enter

BBS-style ANSI color enter prompts for Node.js modules or the CLI
https://github.com/bertrandom/press-enter

Last synced: 23 days ago
JSON representation

BBS-style ANSI color enter prompts for Node.js modules or the CLI

• Host: GitHub
• URL: https://github.com/bertrandom/press-enter
• Owner: bertrandom
• Created: 2015-01-03T05:57:08.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-01-07T18:25:48.000Z (almost 10 years ago)
• Last Synced: 2024-11-07T20:22:17.039Z (about 2 months ago)
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/press-enter
• Size: 294 KB
• Stars: 15
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# press-enter

BBS-style ANSI color enter prompts for Node.js modules or the CLI

![image](https://raw.githubusercontent.com/bertrandom/press-enter/gh-pages/demo.gif)

There are 9 animated prompts and 6 static prompts.

The animated prompts were ported from an old PCBoard PPE ([EPE1PWA.ZIP](http://cd.textfiles.com/ppes/E/EPE1PWA.ZIP)) originally released on February 17, 1994, a little over twenty years ago.

![image](https://raw.githubusercontent.com/bertrandom/press-enter/gh-pages/file_id.diz.png)

The static prompts were extracted from the default install of Iniquity BBS software v1.01, released on July 26, 1997.

![image](https://raw.githubusercontent.com/bertrandom/press-enter/gh-pages/iniquity.png)

Here's are the prompts in use in their corresponding software:

### Animated prompt in PCBoard

![image](https://raw.githubusercontent.com/bertrandom/press-enter/gh-pages/pcboard.gif)

### Static prompt in Iniquity

![image](https://raw.githubusercontent.com/bertrandom/press-enter/gh-pages/iniquity_enter.png)

Static prompts:

![image](https://raw.githubusercontent.com/bertrandom/press-enter/gh-pages/static.gif)

# Installation

`npm install -g press-enter`

# Usage

To use `press-enter`, your terminal must support ANSI colors with bright settings. I use iTerm2 with the Report Terminal Type setting at `xterm-256color` and colors set to the `Dark Background` preset.

## CLI usage

```

press-enter [style] [color]

  style: 0-13

  color: red, yellow, green, blue, cyan, magenta, grey

```

For example, if you want to use the 4th prompt in Red, you can type

```

press-enter 4 red

```

or specify that in your shell scripts.

0-8 are animated prompts, 9-13 are static.

Running `press-enter` by itself will default to the 3rd style in the color blue.

## Node usage

You can use `press-enter` anywhere where you want to control flow. The callback fires after the user presses enter.

### pressEnter([options], callback)

Options is an optional hash, you can omit it:

```

var pressEnter = require('press-enter');

pressEnter(function() {

	process.exit();

});

```

| Option | Description |

| ------------ | ------------- |

| style | Style from 0-13, 0-8 are animated, 9-13 are static |

| color | red, yellow, green, blue, cyan, magenta, grey. Defaults to blue. |

| centered | Whether or not to try to detect the number of columns in the terminal and center the prompt. Defaults to true. |

| input | Node.js stream, defaults to stdin |

| output | Node.js stream, defaults to stdout |

Example specifying options:

```

var pressEnter = require('press-enter');

pressEnter({style: 3, color: red}, function() {

	process.exit();

});

```

## License

MIT