# clifflite

> CLi out format lite

Latest version **0.0.4** (published 2020-11-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install clifflite
pnpm add clifflite
yarn add clifflite
bun add clifflite
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2020-11-19 |
| First published | 2020-10-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 13.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | shudingbo |
| Maintainers | shudingbo |
| Keywords | cliff |

## Links

- npm: https://www.npmjs.com/package/clifflite
- Repository: https://github.com/shudingbo/clifflite
- Homepage: https://github.com/shudingbo/clifflite#readme
- Issues: https://github.com/shudingbo/clifflite/issues
- npm.io page: https://npm.io/package/clifflite

## Dependencies (2)

- [eyes](https://npm.io/package/eyes.md) ~0.1.8
- [colors](https://npm.io/package/colors.md) ^1.4.0

## Recent versions

- 0.0.4 (latest) — 2020-11-19
- 0.0.3 — 2020-10-28
- 0.0.2 — 2020-10-28
- 0.0.1 — 2020-10-28

## README

# clifflite

CLI output formatting tools: "Your CLI Formatting Friend".


### Installing clifflite
```
  [sudo] npm install clifflite
```

## Usage
There are a number of methods available in Cliff for common logging tasks in command-line tools. If you're looking for more usage, checkout the [examples in this repository][3]:

1. Logging rows of data
2. Inspecting Objects

### Logging rows of data

**cliff.stringifyRows(rows[, colors])**

Takes a set of Arrays and row headers and returns properly formatted and padded rows. Here's a sample:

``` js
  var cliff = require('../lib/cliff');

  var rows = [
    ['Name',  'Flavor',    'Dessert'],
    ['Alice', 'cherry',    'yogurt'],
    ['Bob',   'carmel',    'apples'],
    ['Joe',   'chocolate', 'cake'],
    ['Nick',  'vanilla',   'ice cream']
  ];

  console.log(cliff.stringifyRows(rows, ['red', 'blue', 'green']));
```

![output from string-rows.js][string-rows]

**cliff.putRows(level, rows[, colors])**

The `putRows` method is a simple helper that takes a set of Arrays and row headers and logs properly formatted and padded rows (logs `stringifyRows` to [winston][0]). Here's a quick sample:

``` js
  var cliff = require('../lib/cliff');

  var rows = [
    ['Name',  'Flavor',    'Dessert'],
    ['Alice', 'cherry',    'yogurt'],
    ['Bob',   'carmel',    'apples'],
    ['Joe',   'chocolate', 'cake'],
    ['Nick',  'vanilla',   'ice cream']
  ];

  cliff.putRows('data', rows, ['red', 'blue', 'green']);
```

The resulting output on the command-line would be:

![output from put-rows.js][put-rows]

**cliff.stringifyObjectRows(objs, properties[, colors])**
*used to be: cliff.rowifyObjects(objs, properties, colors)*

Takes a set of Objects and the properties to extract from them and returns properly formatted and padded rows. Here's a sample:

``` js
  var cliff = require('../lib/cliff');

  var objs = [], obj = {
    name: "bazz",
    address: "1234 Nowhere Dr.",
  };

  for (var i = 0; i < 10; i++) {
    objs.push({
      name: obj.name,
      address: obj.address,
      id: Math.random().toString()
    });
  }

  console.log(cliff.stringifyObjectRows(objs, ['id', 'name', 'address'], ['red', 'blue', 'green']));
```

![output from string-object-rows.js][string-object-rows]

**cliff.putObjectRows(level, objs, properties[, colors])**

Takes a set of Objects and the properties to extract from them and it will log to the console. (it prints `stringifyObjectRows` with [winston][0]). Here's a sample:

``` js
  var cliff = require('../lib/cliff');

  var objs = [], obj = {
    name: "bazz",
    address: "1234 Nowhere Dr.",
  };

  for (var i = 0; i < 10; i++) {
    objs.push({
      name: obj.name,
      address: obj.address,
      id: Math.random().toString()
    });
  }

  cliff.putObjectRows('data', objs, ['id', 'name', 'address']);
```

![output from string-object-rows.js][string-object-rows]

**Colors Parameter**

The `colors` parameter is an array that colors the first row. It uses the [colors.js][2]. You can use any of those.

``` js
  var cliff = require('../lib/cliff');

  var rows = [
    ['Name',        'Flavor',              'Dessert'],
    ['Alice'.grey,  'cherry'.cyan,         'yogurt'.yellow],
    ['Bob'.magenta, 'carmel'.rainbow,      'apples'.white],
    ['Joe'.italic,  'chocolate'.underline, 'cake'.inverse],
    ['Nick'.bold,   'vanilla',             'ice cream']
  ];

  cliff.putRows('data', rows, ['red', 'blue', 'green']);
```

The resulting output on the command-line would be:

![output from puts-rows-colors.js][put-rows-colors]

## Run Tests

All of the cliff tests are written in [vows][4], and cover all of the use cases described above.

```
  npm test
```

## Motivation

Clifflite is the swiss army knife of CLI formatting tools. It is based on highly flexible and powerful libraries: 


* [colors][0]: Get colors in your node.js console like what 


#### Author: [Charlie Robbins](http://twitter.com/indexzero)

[0]: http://github.com/marak/colors.js

[put-object-rows]: https://github.com/flatiron/cliff/raw/master/assets/put-object-rows.png
[put-object]: https://github.com/flatiron/cliff/raw/master/assets/put-object.png
[put-rows-colors]: https://github.com/flatiron/cliff/raw/master/assets/put-rows-colors.png
[put-rows]: https://github.com/flatiron/cliff/raw/master/assets/put-rows.png
[string-object-rows]: https://github.com/flatiron/cliff/raw/master/assets/string-object-rows.png
[string-rows]: https://github.com/flatiron/cliff/raw/master/assets/string-rows.png

---
_Source: https://npm.io/package/clifflite · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._