Tablemark v4 is here

[haltcase]

Tablemark v4 is on the horizon has arrived—the most notable change is more complete support for things like emoji, ANSI styles, and CJK fullwidth forms by default. This allows for properly calculating the width of a column as well as proper wrapping of text styled by ANSI sequences. This enhanced text handling is slightly slower, but shouldn't be noticeable for most data. On larger datasets where the performance hit is undesirable, an option will allow switching to a "basic" text handling strategy that acts more like <= v3 (though not entirely).

Regarding ANSI styles, v4 does not count them as part of the cell's width by default so that the output renders nicely in a terminal. However, you can set countAnsiEscapeCodes: true to change this behavior, which would be useful for example when the output will be primarily rendered in a markdown document that doesn't interpret ANSI styles.

You can install v4 today:

pnpm add tablemark

Below are the changes for v4.

FEATURES

• support counting ANSI escapes (ee38d57)
• reduce minimum column width to 3 (75f8337)
• rewrite with extended text handling support (468e44d)
• require node v20+ (9f9e74f)

DEPRECATIONS

• options.caseHeaders is deprecated in favor of options.headerCase.
• options.wrapWidth is deprecated in favor of options.maxWidth.

These deprecated options will be removed in the next major version.

BREAKING CHANGES

• Node v20 is now the minimum required version since v18 is officially EOL.
• tablemark is now a named export instead of the default.
• If the input iterable is empty, an empty string is returned instead of
  an error.
• options.align no longer allows uppercase values like LEFT.
• options.toCellText now receives an object with key (object key)
  and value (cell content) properties, rather than just the string
  value.
• The minimum column width has been reduced to 3
  characters, which is the narrowest width that still allows for both left and
  right alignment characters and a single hyphen in the divider cell. This is a
  fairly innocuous change, but does change output table layouts.

[adamhl8]

I was about to type up a comment about how it would be nice if toCellText received the key as well as the value, but it looks like you already did that in 468e44d :).

Thanks for this library! It's really great.