climt is a minimalist table renderer for CLI's with zero dependencies.
import { ClimtTable } from 'climt';
type Data = {
a?: number|null;
sub?: {
b: number
}
};
// Create table.
const table = new ClimtTable<Data>();
// Column bound to the a property
table.column('Alpha', 'a')
// Column bound to the sub.b property, with styling
table.column('Beta', 'sub.b', { align: 'right' })
// Column using a function for it's data.
table.column('Charlie', row => {
if (row.a && row.sub && row.sub.b) {
return (row.a + row.sub.b).toString();
}
});
// Formats header.
table.format((col, row, content) => {
if (row == -1) {
return content.toUpperCase();
}
else {
return content;
}
});
// Renders table with the data.
table.render([
{ a: 5, sub: { b: 5 } },
{ a: -1, sub: { b: 10 } },
{ a: 10, sub: { b: 2 } },
{ a: 15, sub: { b: -6 } },
{ a: null, sub: { b: 10 } },
{ a: 20 }
]);
ALPHA | BETA | CHARLIE
-------+------+---------
5 | 5 | 10
-1 | 10 | 9
10 | 2 | 12
15 | -6 | 9
| 10 |
20 | |