@plesk-tools/tablemark
v2.0.1
Published
Generate markdown tables from JSON data.
Downloads
3
Readme
tablemark
Generate markdown tables from JSON data.
Parses arrays of objects into markdown tables, complete with configuration for renaming columns and left, center, or right-aligning them.
This is a patched version of citycide/tablemark library which can be used in NX/React/ReduxToolkit/TypeScript stack.
installation
yarn add @plesk-tools/tablemark
usage
const tablemark = require('tablemark')
tablemark([
{ name: 'Bob', age: 21, isCool: false },
{ name: 'Sarah', age: 22, isCool: true },
{ name: 'Lee', age: 23, isCool: true }
])
// | Name | Age | Is cool |
// | ----- | ----- | ------- |
// | Bob | 21 | false |
// | Sarah | 22 | true |
// | Lee | 23 | true |
... displays as:
| Name | Age | Is cool | | ----- | ----- | ------- | | Bob | 21 | false | | Sarah | 22 | true | | Lee | 23 | true |
api
tablemark(input[, options = {}])
Arguments
{Array<Object>} input
: the data to table-ify{Object} [options = {}]
| key | type | default | description |
| :------------: | :----------: | :--------: | ---------------------------------------------- |
| columns
| <Array>
| - | Array of column descriptors. |
| caseHeaders
| <Boolean>
| true
| Sentence case headers derived from keys. |
| stringify
| <Function>
| - | Provide a custom "toString" function. |
| wrap.width
| <Number>
| Infinity
| Wrap texts at this length. |
| wrap.gutters
| <Boolean>
| false
| Add sides (\| <content> \|
) to wrapped rows. |
The columns
array can either contain objects, in which case their
name
and align
properties will be used to alter the display of
the column in the table, or any other type which will be coerced
to a string if necessary and used as a replacement for the column
name.
columns
tablemark([
{ name: 'Bob', age: 21, isCool: false },
{ name: 'Sarah', age: 22, isCool: true },
{ name: 'Lee', age: 23, isCool: true }
], {
columns: [
'first name',
{ name: 'how old', align: 'center' },
'are they cool'
]
})
// | first name | how old | are they cool |
// | ---------- | :-----: | ------------- |
// | Bob | 21 | false |
// | Sarah | 22 | true |
// | Lee | 23 | true |
... displays as:
| first name | how old | are they cool | | ---------- | :-----: | ------------- | | Bob | 21 | false | | Sarah | 22 | true | | Lee | 23 | true |
stringify
tablemark([
{ name: 'Bob', pet_owner: true, studying: false },
{ name: 'Sarah', pet_owner: false, studying: true },
{ name: 'Sarah', pet_owner: true, studying: true }
], {
stringify,
columns: [
{ align: 'left' },
{ align: 'center' },
{ align: 'center' }
]
})
function stringify (v) {
if (v === true) return '✔'
if (!v) return ''
return v
}
// | Name | Pet owner | Studying |
// | :---- | :-------: | :------: |
// | Bob | ✔︎ | |
// | Sarah | | ✔ |
// | Lee | ✔ | ✔ |
wrap
To output valid GitHub Flavored Markdown a
cell must not contain newlines. Consider replacing those with <br />
(e.g.
using the stringify
option).
Set the wrap.width
option to wrap any content at that length onto a new
adjacent line:
tablemark([
{ star: false, name: 'Benjamin' },
{ star: true, name: 'Jet Li' }
], { wrap: { width: 5 } })
// | Star | Name |
// | ----- | ----- |
// | false | Benja |
// min
// | true | Jet |
// Li
Enable wrap.gutters
to add pipes on all lines:
tablemark([
{ star: false, name: 'Benjamin' },
{ star: true, name: 'Jet Li' }
], { wrap: { width: 5, gutters: true } })
// | Star | Name |
// | ----- | ----- |
// | false | Benja |
// | | min |
// | true | Jet |
// | | Li |
see also
tablemark-cli
– use this module from the command line
contributing
Search the issues if you come across any trouble, open a new one if it hasn't been posted, or, if you're able, open a pull request. Contributions of any kind are welcome in this project.
The following people have already contributed their time and effort:
- Thomas Jensen (@tjconcept)
Thank you!
license
MIT © Bo Lingen / citycide