haltcase/tablemark

Generate markdown tables from JSON data.

tablemark's Issues

Params does not affect output

Trying to apply some prams as per example below, but seems does not work

import * as table from "tablemark";

const items = [
  { name: “a”, id: “1” },
  { name: “b”, id: “2” }
]
table(items, { caseHeaders: false, wrap: {width: 1, gutters: false}});

Any ideas?

super neat package; no issues

👌

Passing an empty array throws error

Hi,

tablemark([]) will throw:

TypeError: Cannot convert undefined or null to object

Maybe there's a reason for it but IMO it would be more convenient to return an empty string.

vscode extension

Nice tool! Any thoughts how this might be used in VS Code / MD-based note taking environment?

The use case I have in mind is referring to a local JSON file with some kind of tag, and import the the markdown output from tablemark within a markdown file.

Better newlines and long texts

The current method of converting to strings does not take newlines into consideration, which are probably not that uncommon. The current state of "newlines in markdown tables" seems pretty bad from a quick search on the internet.

Current:

echo '{"message":"Wr\nong"}' | tablemark
| Message |
| ------- |
| Wr
ong  |

Some options:

Replacing \n with <br />:

| Message     | Code  |
| ----------- | ----- |
| Wr<br />ong | 2     |

Message	Code
Wr ong	2

Extending the table downwards

Keeping gutters/separators

| Message | Code  |
| ------- | ----- |
| Wr      | 2     |
| ong     |       |
| Good    | 0     |

Message	Code
Wr	2
ong
Good	0

Without gutters/separators

| Message | Code  |
| ------- | ----- |
| Wr      | 2     |
  ong
| Good    | 0     |

Message	Code
Wr	2
ong
Good	0

Since only the first produces valid markdown (GitHub-usable), I think that should definitely be an option. Apart from that consideration, I'm mostly into the last one (wrapping and aligning but without gutters/separators).

My rough proposal is:
Wrap at newlines and after any 80 characters run. Do not add gutters and separators, but align content. Provide an option to tweak characters per line or disable automatic line wrapping. Provide an option to replace newlines with <br /> and disable any wrapping.

Release version

I'm missing the latest fixes :-)

Extra dash is generated when label is shorter than content (with padHeaderSeparator: true)

Hi and thanks for the great library,

I noticed

tablemark([{foo: null}, {foo: null}, {foo: null}], { padHeaderSeparator: true }) 

Will generate

| Foo   |
| :---- | // 4 dashes
| null  |
| null  |
| null  |

instead of

| Foo  |
| :--- | // 3 dashes
| null |
| null |
| null |

This triggers a reformat on VSC and Sublime.

Option for compact headers

Hello!

Nice little lib.

Unfortunately, WebStorm complains about the formatting of the headers:

| first name | how old | are they cool |
| :--------- | :-----: | :------------ |

It seems it would prefer:

| first name | how old | are they cool |
|:-----------|:-------:|:--------------|

Could we add an option for that?

Looking at the code, a post-generation regex around line 49 would probably be simplest option:

separator.replace(/ (:?\-+:?) /g, (all, inner) => inner.replace('-', '---'))

I'm happy to PR this.

Soften or remove `os` module dependency

The os module is only used to retrieve the system EOL, requiring a patch such as the one I commented on here to work in other environments:

plesk@3dbca4b#commitcomment-52865560

I'm thinking maybe make EOL configurable, then either wrap require('os') in a try/catch (would that prevent this error?) to get a default or get rid of it entirely and just default to \n.