Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/plesk/tablemark
Generate markdown tables from JSON data.
https://github.com/plesk/tablemark
Last synced: 6 days ago
JSON representation
Generate markdown tables from JSON data.
- Host: GitHub
- URL: https://github.com/plesk/tablemark
- Owner: plesk
- License: mit
- Fork: true (haltcase/tablemark)
- Created: 2021-06-25T11:15:16.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-06-29T11:18:16.000Z (over 3 years ago)
- Last Synced: 2024-10-30T13:16:31.314Z (11 days ago)
- Language: JavaScript
- Homepage:
- Size: 60.5 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: license
Awesome Lists containing this project
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](https://github.com/citycide/tablemark) library which can be used in NX/React/ReduxToolkit/TypeScript stack.
## installation
```sh
yarn add @plesk-tools/tablemark
```
## usage
```js
const tablemark = require('tablemark')
```
```js
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
```js
tablemark(input[, options = {}])
```
> **Arguments**
- `{Array} input`: the data to table-ify
- `{Object} [options = {}]`
| key | type | default | description |
| :------------: | :----------: | :--------: | ---------------------------------------------- |
| `columns` | `` | - | Array of column descriptors. |
| `caseHeaders` | `` | `true` | Sentence case headers derived from keys. |
| `stringify` | `` | - | Provide a custom "toString" function. |
| `wrap.width` | `` | `Infinity` | Wrap texts at this length. |
| `wrap.gutters` | `` | `false` | Add sides (`\| \|`) 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`
```js
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`
```js
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](https://github.github.com/gfm/) a
cell must not contain newlines. Consider replacing those with `
` (e.g.
using the `stringify` option).
Set the `wrap.width` option to wrap any content at that length onto a new
adjacent line:
```js
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:
```js
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`](https://github.com/citycide/tablemark-cli) – use this module from the command line
## contributing
Search the [issues](https://github.com/citycide/tablemark) 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](https://help.github.com/articles/about-pull-requests/).
Contributions of any kind are welcome in this project.
The following people have already contributed their time and effort:
* Thomas Jensen (**[@tjconcept](https://github.com/tjconcept)**)
Thank you!
## license
MIT © Bo Lingen / citycide