Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shinnn/tty-width-frame

Generate simple framed text fitting for the current text terminal
https://github.com/shinnn/tty-width-frame

Last synced: 26 days ago
JSON representation

Generate simple framed text fitting for the current text terminal

Host: GitHub
URL: https://github.com/shinnn/tty-width-frame
Owner: shinnn
License: isc
Created: 2018-10-17T04:25:08.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2019-07-04T16:29:34.000Z (over 5 years ago)
Last Synced: 2024-04-15T00:04:41.110Z (7 months ago)
Language: JavaScript
Size: 84 KB
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# tty-width-frame

[![npm version](https://img.shields.io/npm/v/tty-width-frame.svg)](https://www.npmjs.com/package/tty-width-frame)
[![Build Status](https://travis-ci.com/shinnn/tty-width-frame.svg?branch=master)](https://travis-ci.com/shinnn/tty-width-frame)
[![Coverage Status](https://img.shields.io/coveralls/shinnn/tty-width-frame.svg)](https://coveralls.io/github/shinnn/tty-width-frame?branch=master)

Generate simple framed text fitting for the current text terminal

```javascript
const ttyWidthFrame = require('tty-width-frame');

console.log(ttyWidthFrame(`tty-width-frame
Generate simple framed text from a string`));
```

```
┌──────────────────────────────────────────────────────────────────────────┐
│ │
│ tty-width-frame │
│ Generate simple framed text from a string │
│ │
└──────────────────────────────────────────────────────────────────────────┘
```

* No configuration, a single tidy default
* Single-line border
* 1 padding between text and borders
* 2 horizontal spaces on both side of the box
* Left-aligned text
* Automatic box width adjustment for the current terminal width
* Automatic line breaking for long text

## Installation

[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/about-npm/).

```
npm install tty-width-frame
```

## API

```javascript
const ttyWidthFrame = require('tty-width-frame');
```

### ttyWidthFrame(*input*)

*input*: `string`
Return: `string`

```javascript
// When the terminal width is 30

ttyWidthFrame('abcdefghijklmnopqrstuvwxyz');
/* =>
┌────────────────────────┐
│ │
│ abcdefghijklmnopqrstuv │
│ wxyz │
│ │
└────────────────────────┘
*/

// When the terminal width is 20

ttyWidthFrame('abcdefghijklmnopqrstuvwxyz');
/* =>
┌──────────────┐
│ │
│ abcdefghijkl │
│ mnopqrstuvwx │
│ yz │
│ │
└──────────────┘
*/
```

When the terminal window is too narrow, or more specifically, its width is less than 15, it just returns the original `string`.

```javascript
// When the terminal width is 14

ttyWidthFrame('abcdefghijklmnopqrstuvwxyz'); //=> 'abcdefghijklmnopqrstuvwxyz'
```

On a [non-interactive](https://www.tldp.org/LDP/abs/html/intandnonint.html) script, it throws an `Error` instead.

## Related project

* [neat-frame](https://github.com/shinnn/neat-frame) – works on both TTY and non-TTY environments, in exchange for larger dependency size

## License