@arcanis/slice-ansi

What is @arcanis/slice-ansi?

@arcanis/slice-ansi is an npm package designed to handle ANSI escape codes in strings, allowing you to slice strings containing these codes without breaking the formatting.

What are @arcanis/slice-ansi's main functionalities?

Slicing ANSI strings

This feature allows you to slice a string containing ANSI escape codes without breaking the formatting. In this example, the string 'Hello World' is sliced to 'Hello' while preserving the red color formatting.

const sliceAnsi = require('@arcanis/slice-ansi');
const input = '\u001b[31mHello\u001b[39m World';
const output = sliceAnsi(input, 0, 5);
console.log(output); // '\u001b[31mHello\u001b[39m'

Handling multi-byte characters

This feature ensures that multi-byte characters are handled correctly when slicing. In this example, the Chinese characters '你好，世界' are sliced to '你好' while preserving the red color formatting.

const sliceAnsi = require('@arcanis/slice-ansi');
const input = '\u001b[31m你好，世界\u001b[39m';
const output = sliceAnsi(input, 0, 2);
console.log(output); // '\u001b[31m你好\u001b[39m'

Other packages similar to @arcanis/slice-ansi

slice-ansi

The 'slice-ansi' package provides similar functionality to '@arcanis/slice-ansi' by allowing you to slice strings containing ANSI escape codes without breaking the formatting. It is a well-maintained and widely used package in the community.

string-width

The 'string-width' package calculates the visual width of a string, taking into account ANSI escape codes and wide characters. While it does not provide slicing functionality, it can be used in conjunction with slicing packages to handle string widths accurately.

strip-ansi

The 'strip-ansi' package removes ANSI escape codes from strings. While it does not provide slicing functionality, it can be useful for cleaning up strings before or after slicing operations.

README

@arcanis/slice-ansi

Slice strings while preserving ansi characters

Installation

yarn add @arcanis/slice-ansi

Why

Unlike the Chalk version, this completely different implementation:

• Supports terminal hyperlinks
• Leverages the native grapheme splitting API if available
• Doesn't require ESM, because it's an inane requirement for a library like this

Caveat

This implementation also doesn't attempt to interpret the escape codes to optimize them away. So for instance, if you start with the following but only want to keep the first 16 characters:

${openBold}This is the header with ${openRed}ansi words${closeRed}${closeBold}

The end result will be:

${openBold}This is the head${openRed}${closeRed}${closeBold}

As you can see, the ${openRed}${closeRed} didn't get removed, even if they are now empty. This is because this package doesn't know that openRed (\u001b[31m) is "closed" by closeRed (\u001b[39m). Keeping these information would make the package more complex for a benefit deemed fairly limited, since nothing will be printed anyway.

License (MIT)

Copyright © 2020 Mael Nison

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.