https://github.com/larswaechter/voici.js

A Node.js library for pretty printing your data on the terminal🎨
https://github.com/larswaechter/voici.js

console data-science javascript shell terminal tty typescript

Last synced: about 2 months ago
JSON representation

A Node.js library for pretty printing your data on the terminal🎨

• Host: GitHub
• URL: https://github.com/larswaechter/voici.js
• Owner: larswaechter
• License: mit
• Created: 2022-03-07T19:03:15.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-06-17T04:54:14.000Z (over 1 year ago)
• Last Synced: 2024-07-16T20:06:41.862Z (2 months ago)
• Topics: console, data-science, javascript, shell, terminal, tty, typescript
• Language: TypeScript
• Homepage: https://voici.larswaechter.dev
• Size: 625 KB
• Stars: 333
• Watchers: 2
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# voici.js

A Node.js library for pretty printing your data on the terminal🎨

[![npm version](https://img.shields.io/npm/v/voici.js.svg?style=flat)](https://www.npmjs.com/package/voici.js/)

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/larswaechter/voici.js/blob/main/LICENSE)

[![Documentation](https://img.shields.io/badge/GitBook-Docu-lightblue)](https://voici.larswaechter.dev/)

![Tests](https://github.com/larswaechter/voici.js/actions/workflows/tests.yaml/badge.svg)

![Linter](https://github.com/larswaechter/voici.js/actions/workflows/linter.yaml/badge.svg)

![](./preview.png)

## 📍 Introduction

voici.js (_speak_: [/vwasi/](https://dictionary.cambridge.org/dictionary/french-english/voici)) is an open source Node.js library written in TypeScript for beautifully displaying datasets in tabular form on the terminal, including features like:

- Text & column & row styling

- Highlighting & filtering

- Dynamic columns

- Column sizing

- Accumulation

- Table export

- Type System

- Sorting

and many more!

Check out the [GitBook](https://voici.larswaechter.dev/) for more features or create an [issue](https://github.com/larswaechter/voici.js/issues) if you're missing one.

## 💻 Installation

Install via npm:

```bash

npm i --save voici.js

```

## 🔨 Usage

```js

import { Table } from 'voici.js';

const data = [

  { firstname: 'Homer', lastname: 'Simpson', age: 39 },

  { firstname: 'Marge', lastname: 'Simpson', age: 36 },

  { firstname: 'Bart', lastname: 'Simpson', age: 10 },

  { firstname: 'Lisa', lastname: 'Simpson', age: 8 },

  { firstname: 'Maggie', lastname: 'Simpson', age: 1 }

];

const table = new Table(data);

table.print();

```

The console output:

```

  firstname    lastname    age

================================

  Homer        Simpson     39

  Marge        Simpson     36

  Bart         Simpson     10

  Lisa         Simpson     8

  Maggie       Simpson     1

```

You can find many more examples [here](https://voici.larswaechter.dev/examples).

## 📚 Documentation

The following documentations are available:

- [GitBook](https://voici.larswaechter.dev/)

- [TypeDoc](https://larswaechter.github.io/voici.js/)

Otherwise check out the [tests](https://github.com/larswaechter/voici.js/blob/master/tests/) for more examples.

## 🧩 Contributing

Any contribution is appreciated! See [CONTRIBUTING.md](https://github.com/larswaechter/voici.js/blob/master/CONTRIBUTING.md)

## 🔑 License

voici.js is released under [MIT](https://github.com/larswaechter/voici.js/blob/master/LICENSE) license.